Speechify

MastraにおけるSpeechifyの音声実装は、SpeechifyのAPIを使用してテキスト読み上げ機能を提供します。

使用例


import { SpeechifyVoice } from "@mastra/voice-speechify";
 
// デフォルトの設定で初期化（SPEECHIFY_API_KEY 環境変数を使用）
const voice = new SpeechifyVoice();
 
// カスタム設定で初期化
const voice = new SpeechifyVoice({
  speechModel: {
    name: "simba-english",
    apiKey: "your-api-key",
  },
  speaker: "george", // デフォルトの声
});
 
// テキストを音声に変換
const audioStream = await voice.speak("Hello, world!", {
  speaker: "henry", // デフォルトの声を上書き
});

コンストラクターパラメーター

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のスピーカー値

このリクエストのデフォルトのスピーカーを上書きします

options.model?:

VoiceModelName

= Constructorのモデル値

このリクエストのデフォルトのモデルを上書きします

戻り値: Promise<NodeJS.ReadableStream>

getSpeakers()

利用可能な音声オプションの配列を返します。各ノードには以下が含まれます:

voiceId:

string

音声の一意の識別子

name:

string

音声の表示名

language:

string

音声の言語コード

gender:

string

音声の性別

listen()

このメソッドはSpeechifyではサポートされておらず、エラーをスローします。Speechifyは音声認識機能を提供していません。

メモ

Speechifyは認証にAPIキーを必要とします
デフォルトモデルは「simba-english」です
音声からテキストへの機能はサポートされていません
追加のオーディオストリームオプションは、speak()メソッドのoptionsパラメータを通じて渡すことができます