文本转语音(Text To Speech)插件技术文档

文本转语音(Text To Speech)插件技术文档

flutter_tts Flutter Text to Speech package 项目地址: https://gitcode.com/gh_mirrors/fl/flutter_tts

---

欢迎使用flutter_tts插件，一个为Flutter应用程序设计的跨平台文本转语音解决方案，支持Android、iOS、Web、Windows以及macOS。本文档将指导您完成从安装到高级使用的全过程。

安装指南

引入依赖

在您的pubspec.yaml文件中添加以下依赖：

dependencies:
  flutter:
    sdk: flutter
  flutter_tts: ^latest-version

替换latest-version为您所查找的最新版本号，例如3.8.0。

Android配置

• 更新最小SDK版本至21或更高，在android/app/build.gradle中设置：

  minSdkVersion 21
  

• 对于Kotlin项目，确保android/build.gradle中kotlin_version或通过settings.gradle更新为最新版本，如1.9.10。
• 在AndroidManifest.xml中添加对TTS服务的查询：

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

iOS注意事项

对于使用Swift的iOS项目，需注意与Flutter整合的问题(Flutter#16049)。

项目使用说明

基础使用

初始化FlutterTts对象，并调用相关方法执行文本转语音操作。

import 'package:flutter_tts/flutter_tts.dart';

FlutterTts flutterTts = FlutterTts();

void speakHelloWorld() async {
  await flutterTts.speak('你好，世界');
}

设置属性

可以调整语言、语速、音量、音高，并检查特定语言是否可用等：

await flutterTts.setLanguage('zh-CN');
await flutterTts.setSpeechRate(1.0); // 默认值
await flutterTts.setVolume(1.0); // 默认值
await flutterTts.setPitch(1.0); // 默认值

高级功能

• 暂停: Android ≥ 26 支持，需要特殊处理。
• 合成到文件: iOS 13+ 和 Android 支持。
• 监听事件: 包括开始、完成、进度等。

平台事件监听

设置各种状态的处理函数，以响应文本转语音过程中的不同阶段：

flutterTts.setStartHandler(() {
  // 播放开始处理逻辑
});
flutterTts.setCompletionHandler(() {
  // 播放结束处理逻辑
});
// 类似地，还可以设置其他处理函数如progressHandler, errorHandler等。

API使用文档

以下是几个核心API的示例使用：

• ** Speak **: 发音文本。

  await flutterTts.speak("发音内容");
  

• ** Stop **: 停止发音。

  await flutterTts.stop();
  

• ** Language Management **: 获取和设置语言。

  List<dynamic> languages = await flutterTts.getLanguages;
  await flutterTts.setLanguage("zh-CN");
  

• ** Voice Management **（Android/iOS特有）: 设置和获取声音。

  await flutterTts.setVoice({"name": "Standard", "locale": "zh-CN"});
  

• ** Audio Session Configuration **（iOS特有）:

  await flutterTts.setIosAudioCategory(
    IosTextToSpeechAudioCategory.ambient,
    [...],
    IosTextToSpeechAudioMode.voicePrompt,
  );
  

结论

flutter_tts提供了一个强大且灵活的接口，让您能够在Flutter应用中轻松实现多平台文本转语音功能。遵循上述指南，您可以快速集成并定制适合您应用需求的语音输出体验。

---

以上就是对flutter_tts插件的详细技术文档，希望对您的项目开发有所帮助。如果遇到任何问题，请参考官方文档或社区资源寻求解决方案。

flutter_tts Flutter Text to Speech package 项目地址: https://gitcode.com/gh_mirrors/fl/flutter_tts