chrome.tts

説明

chrome.tts API を使用して、合成されたテキスト読み上げ（TTS）を再生します。拡張機能で音声エンジンを実装できる関連の ttsEngine API もご覧ください。

Chrome は、Windows（SAPI 5 を使用）、Mac OS X、ChromeOS で、オペレーティング システムが提供する音声合成機能を使用してこの機能を提供します。すべてのプラットフォームで、ユーザーは代替音声エンジンとして登録する拡張機能をインストールできます。

権限

tts

コンセプトと使用方法

音声を生成

拡張機能から speak() を呼び出して発言します。次に例を示します。

chrome.tts.speak('Hello, world.');

読み上げをすぐに停止するには、stop() を呼び出すだけです。

chrome.tts.stop();

音声の速度や音の高低など、さまざまなプロパティを制御するオプションを指定できます。次に例を示します。

chrome.tts.speak('Hello, world.', {'rate': 2.0});

言語を指定して、その言語（および地域の方言（該当する場合））をサポートするシンセサイザーが選択されるようにすることをおすすめします。

chrome.tts.speak('Hello, world.', {'lang': 'en-US', 'rate': 2.0});

デフォルトでは、speak() の呼び出しごとに、進行中の音声が中断され、すぐに発話されます。通話が何かを中断するかどうかを判断するには、isSpeaking() を呼び出します。また、enqueue オプションを使用すると、この発話が、現在の発話が終了したときに発話される発話のキューに追加されます。

chrome.tts.speak('Speak this first.');
chrome.tts.speak(
    'Speak this next, when the first sentence is done.', {'enqueue': true});

すべてのオプションの詳細については、tts.speak() をご覧ください。すべての音声エンジンがすべてのオプションをサポートしているわけではありません。

エラーをキャッチして speak() を正しく呼び出していることを確認するには、引数を取らないコールバック関数を渡します。コールバック内で runtime.lastError を確認して、エラーが発生したかどうかを確認します。

chrome.tts.speak(
  utterance,
  options,
  function() {
    if (chrome.runtime.lastError) {
      console.log('Error: ' + chrome.runtime.lastError.message);
    }
  }
);

コールバックは、エンジンが音声の生成を開始する前にすぐに返されます。コールバックの目的は、TTS API の使用における構文エラーをユーザーに通知することであり、音声の合成と出力のプロセスで発生する可能性のあるすべてのエラーをキャッチすることではありません。これらのエラーもキャッチするには、次のセクションで説明するイベント リスナーを使用する必要があります。

イベントをリッスンする

合成音声のステータスに関するリアルタイム情報を取得するには、次のように、オプションで speak() にイベント リスナーを渡します。

chrome.tts.speak(
  utterance,
  {
    onEvent: function(event) {
      console.log('Event ' + event.type + ' at position ' + event.charIndex);
      if (event.type == 'error') {
        console.log('Error: ' + event.errorMessage);
      }
    }
  },
  callback
);

各イベントには、イベントタイプ、発話に対する現在の音声の文字インデックス、エラー イベントの場合はオプションのエラー メッセージが含まれます。イベントタイプは次のとおりです。

  • 'start': エンジンが発話の読み上げを開始しました。
  • 'word': 単語の境界に達しました。event.charIndex を使用して、現在の音声の位置を特定します。
  • 'sentence': 文の境界に達しました。event.charIndex を使用して、現在の音声の位置を特定します。
  • 'marker': SSML マーカーに到達しました。event.charIndex を使用して、現在の音声の位置を特定します。
  • 'end': エンジンが発話の読み上げを終了しました。
  • 'interrupted': この発話は、speak() または stop() への別の呼び出しによって中断され、完了しませんでした。
  • 'cancelled': この発話はキューに登録されましたが、speak() または stop() への別の呼び出しによってキャンセルされ、まったく発話が開始されませんでした。
  • 'error': エンジン固有のエラーが発生したため、この発話は発音できません。詳しくは、event.errorMessage をご覧ください。

イベントタイプのうち、'end'、'interrupted'、'cancelled'、'error' の 4 つは最終です。これらのイベントのいずれかを受信すると、この発話はそれ以上発話されなくなり、この発話からの新しいイベントは受信されなくなります。

一部の音声はすべてのイベントタイプをサポートしていない場合があり、一部の音声はイベントをまったく送信しない場合があります。特定のイベントが送信されない限り音声を使用しない場合は、オプション オブジェクトの requiredEventTypes メンバーに必要なイベントを渡すか、getVoices() を使用して要件を満たす音声を選択します。以下では、両方について説明します。

SSML マークアップ

この API で使用される発話には、音声合成マークアップ言語（SSML）を使用したマークアップを含めることができます。SSML を使用する場合、speak() の最初の引数は、ドキュメント フラグメントではなく、XML ヘッダーと最上位の <speak> タグを含む完全な SSML ドキュメントである必要があります。

次に例を示します。

chrome.tts.speak(
  '<?xml version="1.0"?>' +
  '<speak>' +
  '  The <emphasis>second</emphasis> ' +
  '  word of this sentence was emphasized.' +
  '</speak>'
);

すべての音声エンジンがすべての SSML タグをサポートしているわけではなく、一部のエンジンは SSML をまったくサポートしていない可能性がありますが、すべてのエンジンはサポートしていない SSML を無視し、基盤となるテキストを読み上げる必要があります。

音声を選択する

デフォルトでは、Chrome は言語に基づいて、発話する各文に最も適した音声を選択します。ほとんどの Windows、Mac OS X、ChromeOS システムでは、オペレーティング システムが提供する音声合成機能により、少なくとも 1 つの言語で任意のテキストを読み上げることができます。ただし、オペレーティング システムや他の Chrome 拡張機能によって実装された音声エンジンから、さまざまな音声を利用できるユーザーもいます。そのような場合は、適切な音声を選択したり、選択肢のリストをユーザーに提示したりするカスタムコードを実装できます。

すべての音声のリストを取得するには、getVoices() を呼び出し、TtsVoice オブジェクトの配列を引数として受け取る関数を渡します。

chrome.tts.getVoices(
  function(voices) {
    for (var i = 0; i < voices.length; i++) {
      console.log('Voice ' + i + ':');
      console.log('  name: ' + voices[i].voiceName);
      console.log('  lang: ' + voices[i].lang);
      console.log('  extension id: ' + voices[i].extensionId);
      console.log('  event types: ' + voices[i].eventTypes);
    }
  }
);

型

EventType

Chrome 54 以降

列挙型

"開始"

"end"

"word"

"sentence"

"marker"

"interrupted"

"cancelled"

"error"

"pause"

"resume"

TtsEvent

発話のステータスを伝える TTS エンジンからのイベント。

プロパティ

  • charIndex

    number 省略可

    発話内の現在の文字のインデックス。単語イベントの場合、イベントは 1 つの単語の終わりと次の単語の始まりの間に発生します。charIndex は、発話される次の単語の先頭にあるテキスト内のポイントを表します。

  • errorMessage

    文字列 省略可

    イベントタイプが error の場合のエラーの説明。

  • 長さ

    number 省略可

    Chrome 74 以降

    発話の次の部分の長さ。たとえば、word イベントでは、これは次に発音される単語の長さです。音声エンジンによって設定されていない場合は、-1 に設定されます。

  • タイプは、発話が開始された直後の start、単語の境界に達したときの word、文の境界に達したときの sentence、SSML マーク要素に達したときの marker、発話の終わりに達したときの end、発話が終了する前に停止または中断されたときの interrupted、合成される前にキューから削除されたときの cancelled、その他のエラーが発生したときの error のいずれかになります。発話を一時停止すると、特定の発話が途中で一時停止された場合は pause イベントが、発話が音声の再生を再開した場合は resume イベントがトリガーされます。発話の合間に音声が一時停止された場合、一時停止イベントと再開イベントがトリガーされないことがあります。

TtsOptions

Chrome 77 以降

TTS エンジンの音声オプション。

プロパティ

  • desiredEventTypes

    string[] 省略可

    リッスンする対象の TTS イベントタイプ。指定されていない場合、すべてのイベントタイプが送信される可能性があります。

  • enqueue

    ブール値（省略可）

    true の場合、TTS がすでに進行中の場合は、この発話がキューに追加されます。false（デフォルト）の場合、現在の音声が中断され、音声キューがフラッシュされてから、この新しい発話が行われます。

  • extensionId

    文字列 省略可

    使用する音声エンジンの拡張機能 ID（わかっている場合）。

  • gender

    VoiceGender 省略可

    Chrome 77 以降で非推奨

    性別は非推奨となり、無視されます。

    合成音声の性別。

  • lang

    文字列 省略可

    合成に使用する言語（言語-地域 の形式）。例: 「en」、「en-US」、「en-GB」、「zh-CN」。

  • 投球

    number 省略可

    発話のピッチ。0 ～ 2 の範囲で、0 が最も低く、2 が最も高い。1.0 は音声のデフォルトのピッチに対応します。

  • 速度

    number 省略可

    この音声のデフォルトの速度に対する発話速度。デフォルトの速度は 1.0 で、通常は 1 分あたり 180 ～ 220 語程度です。2.0 はその 2 倍の速さで、0.5 は半分の速さです。0.1 未満または 10.0 を超える値は厳密に禁止されていますが、多くの音声では最小レートと最大レートがさらに制限されます。たとえば、3.0 より大きい値を指定しても、特定の音声では通常の 3 倍より速く話すことはできません。

  • requiredEventTypes

    string[] 省略可

    音声がサポートする必要がある TTS イベントタイプ。

  • voiceName

    文字列 省略可

    合成に使用する音声の名前。空の場合、使用可能な音声が使用されます。

  • 音量

    number 省略可

    発話音量。0 ～ 1 の範囲（0 が最小、1 が最大）。デフォルトは 1.0。

  • onEvent

    void optional

    この関数は、発話のプロセスで発生したイベントとともに呼び出されます。

    onEvent 関数は次のようになります。 

    (event: TtsEvent) => {...}

    • イベント

      TtsEvent

      この発話のステータスを示すテキスト読み上げエンジンからの更新イベント。

TtsVoice

音声合成に使用できる音声の説明。

プロパティ

  • eventTypes

    EventType[] 省略可

    この音声が送信できるすべてのコールバック イベントタイプ。

  • extensionId

    文字列 省略可

    この音声を提供する拡張機能の ID。

  • gender

    VoiceGender 省略可

    Chrome 70 以降でサポートが終了したポリシー

    性別は非推奨となり、無視されます。

    この音声の性別。

  • lang

    文字列 省略可

    この音声がサポートする言語（言語-地域 の形式）。例: 「en」、「en-US」、「en-GB」、「zh-CN」。

  • リモコン

    ブール値（省略可）

    true の場合、合成エンジンはリモート ネットワーク リソースです。レイテンシが高くなり、帯域幅の費用が発生する可能性があります。

  • voiceName

    文字列 省略可

    音声の名前。

VoiceGender

Chrome 54 以降 Chrome 70 以降でサポートが終了しました

性別は非推奨となり、無視されます。

列挙型

"male"

"female"

メソッド

getVoices()

chrome.tts.getVoices(): Promise<TtsVoice[]>

利用可能なすべての音声の配列を取得します。

戻り値

isSpeaking()

chrome.tts.isSpeaking(): Promise<boolean>

エンジンが現在発話中かどうかを確認します。Mac OS X では、Chrome によって音声が開始されたものでなくても、システム音声エンジンが発話しているときは常に true が返されます。

戻り値

  • Promise<boolean>

    Chrome 101 以降

pause()

chrome.tts.pause(): void

発話の途中で音声合成を一時停止します。再開または停止の呼び出しを行うと、音声の一時停止が解除されます。

resume()

chrome.tts.resume(): void

音声が一時停止していた場合は、中断したところから音声が再開されます。

speak()

chrome.tts.speak(
  utterance: string,
  options?: TtsOptions,
): Promise<void>

テキスト読み上げエンジンを使用してテキストを読み上げます。

パラメータ

  • 発話

    文字列

    読み上げるテキスト。プレーン テキストまたは完全で整形式の SSML ドキュメント。SSML をサポートしていない音声エンジンは、タグを削除してテキストを読み上げます。テキストの最大長は 32,768 文字です。

  • オプション

    TtsOptions 省略可

    音声オプション。

戻り値

  • Promise<void>

    Chrome 101 以降

stop()

chrome.tts.stop(): void

現在の読み上げを停止し、保留中の発話のキューをフラッシュします。また、音声が一時停止されていた場合は、次の発話呼び出しで一時停止が解除されます。

イベント

onVoicesChanged

Chrome 124 以降 
chrome.tts.onVoicesChanged.addListener(
  callback: function,
)

getVoices によって返される tts.TtsVoice のリストが変更されたときに呼び出されます。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    () => void