通过

Xamarin.Essentials：文本到语音转换

  • 项目

TextToSpeech 类允许应用程序使用内置的文本到语音转换引擎回讲设备中的文本并查询引擎可以支持的可用语言。

入门

若要开始使用此 API，请阅读 Xamarin.Essentials 的入门指南，确保在项目中正确安装和设置库。

若要访问 TextToSpeech 功能，需要以下特定于平台的设置。

如果项目的目标 Android 版本设置为 Android 11 (R API 30)，则必须使用与新的包可见性要求一起使用的查询来更新 Android 清单。

打开 Properties 文件夹下的 AndroidManifest.xml 文件，并在“manifest”节点内添加以下代码 ：

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

使用 Text-to-Speech

在类中添加对 Xamarin.Essentials 的引用：

using Xamarin.Essentials;

Text-to-Speech 通过调用具有文本和可选参数的 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();
}

Text-to-Speech 会自动将同一线程中的语音请求加入队列。

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);
}

下面是这些参数的支持值：

参数 最低 最大值
音调 0 2.0
音量 0 1.0

语音区域设置

每个平台支持不同的区域设置，以便使用不同语言和重音回讲文本。 平台具有用于指定区域设置的不同代码和方法，这就是 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

在第 9 频道和 YouTube 上查找更多 Xamarin 视频。