Xamarin.Essentials:音声合成

TextToSpeech クラスを使用すると、アプリケーションで組み込みの音声合成エンジンを利用して、デバイスからテキストを読み上げたり、エンジンがサポートしている利用可能な言語を照会したりすることができます。

作業開始

この API の使用を始めるには、Xamarin.Essentials の概要ガイドを読み、ライブラリが正しくインストールされてプロジェクトに設定されていることを確認してください。

TextToSpeech 機能を利用するには、次のプラットフォーム固有の設定が必要です。

<queries>
  <intent>
    <action android:name="android.intent.action.TTS_SERVICE" />
  </intent>
</queries>

音声合成の使用

クラスの Xamarin.Essentials への参照を追加します。

using Xamarin.Essentials;

音声合成は、テキストと省略可能なパラメーターと共に SpeakAsync メソッドを呼び出すことで動作し、発話が終了すると戻ります。

public async Task SpeakNowDefaultSettings()
{
    await TextToSpeech.SpeakAsync("Hello World");

    // This method will block until utterance finishes.
}

public void SpeakNowDefaultSettings2()
{
    TextToSpeech.SpeakAsync("Hello World").ContinueWith((t) =>
    {
        // Logic that will run after utterance finishes.

    }, TaskScheduler.FromCurrentSynchronizationContext());
}

このメソッドは、開始した後で発話を停止するために、オプションの CancellationToken を受け取ります。

CancellationTokenSource cts;
public async Task SpeakNowDefaultSettings()
{
    cts = new CancellationTokenSource();
    await TextToSpeech.SpeakAsync("Hello World", cancelToken: cts.Token);

    // This method will block until utterance finishes.
}

// Cancel speech if a cancellation token exists & hasn't been already requested.
public void CancelSpeech()
{
    if (cts?.IsCancellationRequested ?? true)
        return;

    cts.Cancel();
}

音声合成は、同じスレッドからの音声の要求を自動的にキューに登録します。

bool isBusy = false;
public void SpeakMultiple()
{
    isBusy = true;
    Task.Run(async () =>
    {
        await TextToSpeech.SpeakAsync("Hello World 1");
        await TextToSpeech.SpeakAsync("Hello World 2");
        await TextToSpeech.SpeakAsync("Hello World 3");
        isBusy = false;
    });

    // or you can query multiple without a Task:
    Task.WhenAll(
        TextToSpeech.SpeakAsync("Hello World 1"),
        TextToSpeech.SpeakAsync("Hello World 2"),
        TextToSpeech.SpeakAsync("Hello World 3"))
        .ContinueWith((t) => { isBusy = false; }, TaskScheduler.FromCurrentSynchronizationContext());
}

音声の設定

ボリューム、ピッチ、ロケールの設定を可能にする SpeechOptions を使用して、オーディオがどのように話されるのかをより細かく制御します。

public async Task SpeakNow()
{
    var settings = new SpeechOptions()
        {
            Volume = .75f,
            Pitch = 1.0f
        };

    await TextToSpeech.SpeakAsync("Hello World", settings);
}

これらのパラメーターに使用できる値は次のとおりです。

音声のロケール

テキストをさまざまな言語およびアクセントで読み上げるために、各プラットフォームではさまざまなロケールがサポートされています。 プラットフォームにはロケールを指定するためのさまざまなコードや方法があります。そのため Xamarin.Essentials には、クロスプラットフォームの Locale クラスや、GetLocalesAsync を使用してそれらを照会する方法が用意されています。

public async Task SpeakNow()
{
    var locales = await TextToSpeech.GetLocalesAsync();

    // Grab the first locale
    var locale = locales.FirstOrDefault();

    var settings = new SpeechOptions()
        {
            Volume = .75f,
            Pitch = 1.0f,
            Locale = locale
        };

    await TextToSpeech.SpeakAsync("Hello World", settings);
}

制限事項

• 複数のスレッドから呼び出された場合、発話のキューは保証されません。
• バックグラウンドでのオーディオ再生は、公式にはサポートされていません。

API

• TextToSpeech のソース コード
• TextToSpeech API ドキュメント

関連ビデオ

他の Xamarin ビデオは、Channel 9 および YouTube でご覧いただけます。