LibTTS

1. 功能简介

基于 Android TextToSpeech 的语音合成组件封装，提供：

• 多种播放模式（顺序、插队、清空、立即播放）
• 语音参数配置（语速、音调、音量）
• 配置持久化
• TTS 引擎选择
• 语音保存到文件
• 播放状态监听

2. 组件信息

引用仓库

引用仓库可以参考 组件使用 中添加依赖的部分

组件使用

implementation 'com.bihe0832.android:lib-tts:+'

3. 快速开始

3.1. 初始化

// 使用系统默认 TTS 引擎
LibTTS.init(context, Locale.SIMPLIFIED_CHINESE, "", null)

// 指定 TTS 引擎（如 Google TTS）
LibTTS.init(context, Locale.SIMPLIFIED_CHINESE, "com.google.android.tts", null)

// 带初始化监听
LibTTS.init(context, Locale.SIMPLIFIED_CHINESE, "", object : TTSImpl.TTSInitListener {
    override fun onInitSuccess() {
        // 初始化成功
    }
    override fun onInitError() {
        // 初始化失败
    }
})

3.2. 播放语音

// 创建 TTS 数据
val ttsData = TTSData("你好，世界")

// 顺序播放（添加到队列末尾）
LibTTS.speak(ttsData, TTSConfig.SPEEAK_TYPE_SEQUENCE)

// 插队播放（添加到队列头部）
LibTTS.speak(ttsData, TTSConfig.SPEEAK_TYPE_NEXT)

// 立即播放（打断当前播放）
LibTTS.speak(ttsData, TTSConfig.SPEEAK_TYPE_FLUSH)

// 清空队列后播放
LibTTS.speak(ttsData, TTSConfig.SPEEAK_TYPE_CLEAR)

3.3. 带 Key 回调播放

// 播放时传入 Key，回调时会透传
LibTTS.speak("my_key", ttsData, TTSConfig.SPEEAK_TYPE_SEQUENCE)

// 添加播放监听
LibTTS.addTTSSpeakListener(object : TTSImplNotifyWithKey.TTSListener {
    override fun onStart(utteranceId: String, key: String) {
        // 开始播放，key = "my_key"
    }
    override fun onComplete(utteranceId: String, key: String) {
        // 播放完成
    }
    override fun onError(utteranceId: String, key: String) {
        // 播放出错
    }
})

4. 播放类型

5. 参数配置

5.1. 语速设置

// 获取当前语速
val rate = LibTTS.getConfigSpeechRate()

// 设置语速（1.0 为正常速度）
LibTTS.setSpeechRate(1.2f)

// 获取默认语速
val defaultRate = LibTTS.getDefaultSpeechRate()

5.2. 音调设置

// 获取当前音调
val pitch = LibTTS.getConfigPitch()

// 设置音调（1.0 为正常音调）
LibTTS.setPitch(1.1f)

// 获取默认音调
val defaultPitch = LibTTS.getDefaultPitch()

5.3. 音量设置

// 获取当前音量
val volume = LibTTS.getConfigVoiceVolume()

// 设置音量
LibTTS.setVoiceVolume(80)

6. 其他功能

6.1. 状态查询

// 是否正在播放
val isSpeaking = LibTTS.isSpeaking()

// 是否还有待播放的语音
val hasMore = LibTTS.hasMoreSpeak()

6.2. 控制播放

// 停止当前播放
LibTTS.stopSpeak()

// 强制停止并清空队列
LibTTS.forceStop()

// 开始播放队列
LibTTS.startSpeak()

6.3. 保存到文件

val ttsData = TTSData("要保存的文本")
LibTTS.save(ttsData, "/path/to/output.wav")

6.4. 引擎管理

// 获取可用引擎列表
val engines = LibTTS.getEngines()

// 获取默认引擎
val defaultEngine = LibTTS.getDefaultEngine()

6.5. 资源释放

// 销毁 TTS 实例
LibTTS.onDestroy()

7. TTSData 高级用法

val ttsData = TTSData("你好，世界")

// 添加自定义参数
ttsData.addSpeakParams(Bundle().apply {
    putFloat(TextToSpeech.Engine.KEY_PARAM_VOLUME, 0.8f)
})

8. 注意事项

1. 引擎选择：建议使用空字符串让系统选择默认引擎，避免指定不存在的引擎导致初始化失败
2. 内存管理：组件内部使用 ApplicationContext，无需担心 Activity 泄漏
3. 配置持久化：语速、音调、音量等配置会自动持久化
4. 线程安全：播放相关方法已做同步处理