Speechify
MastraにおけるSpeechifyの音声実装は、SpeechifyのAPIを利用してテキスト読み上げ機能を提供します。
使用例
import { SpeechifyVoice } from "@mastra/voice-speechify";
// Initialize with default configuration (uses SPEECHIFY_API_KEY environment variable)
const voice = new SpeechifyVoice();
// Initialize with custom configuration
const voice = new SpeechifyVoice({
speechModel: {
name: "simba-english",
apiKey: "your-api-key",
},
speaker: "george", // Default voice
});
// Convert text to speech
const audioStream = await voice.speak("Hello, world!", {
speaker: "henry", // Override default voice
});
コンストラクタのパラメータ
speechModel?:
SpeechifyConfig
= { name: 'simba-english' }
テキスト読み上げ機能のための設定
speaker?:
SpeechifyVoiceId
= 'george'
音声合成で使用するデフォルトのボイスID
SpeechifyConfig
name?:
VoiceModelName
= 'simba-english'
使用するSpeechifyモデル
apiKey?:
string
SpeechifyのAPIキー。指定がない場合はSPEECHIFY_API_KEY環境変数が使用されます
メソッド
speak()
設定された音声モデルとボイスを使用して、テキストを音声に変換します。
input:
string | NodeJS.ReadableStream
音声に変換するテキスト。ストリームが指定された場合は、最初にテキストへ変換されます。
options.speaker?:
string
= Constructor's speaker value
このリクエストのデフォルトスピーカーを上書きします
options.model?:
VoiceModelName
= Constructor's model value
このリクエストのデフォルトモデルを上書きします
戻り値: Promise<NodeJS.ReadableStream>
getSpeakers()
利用可能なボイスオプションの配列を返します。各ノードには以下が含まれます:
voiceId:
string
ボイスの一意な識別子
name:
string
ボイスの表示名
language:
string
ボイスの言語コード
gender:
string
ボイスの性別
listen()
このメソッドはSpeechifyではサポートされておらず、エラーが発生します。Speechifyは音声認識(音声からテキストへの変換)機能を提供していません。
注意事項
- Speechifyは認証のためにAPIキーが必要です
- デフォルトのモデルは「simba-english」です
- 音声からテキストへの機能はサポートされていません
- 追加の音声ストリームオプションは、speak()メソッドのoptionsパラメータを通じて渡すことができます