com.txznet.sdk

类 TXZTtsManager

java.lang.Object

com.txznet.sdk.TXZTtsManager

public class TXZTtsManager
extends java.lang.Object

类名：语音TTS播报管理器 类描述：语音TTS播报相关设置管理类，主要包含语音默认TTS播报相关属性，如：通道，延时，播报速度，TTS主题包，beep音定制待， 同时自定义外部TTS工具，替换语音默认播报工具。

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	TXZTtsManager.ITtsCallback 类名：TTS逻辑回调类 类描述：回调包含TTS播报状态：开始、结束、完成、取消、出错，详见TtsUtil.ITtsCallback
static interface	TXZTtsManager.onChangeThemeListener 接口名：TTS主题更新监听器 接口描述：TTS主题更新时回调相关方法
static class	TXZTtsManager.PreemptType 枚举类名：TTS播报类型 枚举类描述：TTS播报时使用，针对不同类型处理方式不同
static interface	TXZTtsManager.TtsCallback 接口名：TTS回调 接口描述：TTS播报任务监听
static class	TXZTtsManager.TtsOption 类名：TTS播报配置选项 类描述：Tts选项，如音量、语速、语调、语言等，推荐使用TTS任务取代
static class	TXZTtsManager.TtsTheme 类名：TTS主题类 类描述：语音TTS主题抽象化类
static interface	TXZTtsManager.TtsTool 接口名：Tts工具实现类 接口描述：需要使用外部TTS工具时，可以实现此接口
static class	TXZTtsManager.VoiceTask 类名：播报任务类 类描述：播报任务类型的封装类，用于播报特殊的任务 适用于特殊场景，如同一个TTS任务中执行多个播报，即播TTS,然后暂停100ms，再播BEEP音，再播报一段音频。

字段概要

字段

限定符和类型	字段和说明
static int	INVALID_TTS_TASK_ID 常量名：无效的tts任务id 变量描述：无效的tts任务使用此ID

方法概要

限定符和类型	方法和说明
void	cancelSpeak(int taskId) 方法名：取消播报 方法描述：根据TTS任务ID，强制取消TTS任务
void	enableDownVolumeWhenNav(boolean enable) 方法名：设置导航播报语音时TTS是否降低音量 方法描述：设置导航播报语音时TTS是否降低音量，默认语音与导航共存，根据需求修改，一般推荐修改导航降低音量
void	forceShowTTSChoiceView(boolean enable) 方法名：是否开启TTS主题切换列表显示 方法描述：切换TTS主题时，是否需要展示切换列表，默认展示，不展示时，直接根据TTS 序列号切换
static TXZTtsManager	getInstance() 获取单例
TXZTtsManager.TtsTheme[]	getTtsThemes() 方法名：获取当前TTS主题列表 方法描述：主动获取当前系统支持的同行者语音主题
void	setBeepResources(java.lang.String beepPath) 方法名：设置beep资源路径 方法描述：替换语音默认Beep音，即语音开始录音的“嘟”的一声 文件格式要求PCM：采样率16000，单声道，16位，建议不要超过200ms
void	setBufferTime(int nTime) 方法名：设置TTS播报的缓冲时间 方法描述：设置TTS播报的缓冲时间, 取值范围 0 ~ 15000, 默认值为300, 单位毫秒 由于TTS是合成音，实际应用中系统会因为防POP音等问题造成TTS掉字，通过此方法规避问题
void	setChangeThemeListener(TXZTtsManager.onChangeThemeListener listener) 方法名：设置TTS主题更新监听器 方法描述：设置TTS主题更新监听器，其它因素切换主题时回调此监听器
void	setDefaultAudioStream(int stream) 方法名：设置TTS播报流 方法描述：设置默认的TTS播报音频流，使用AudioManager的STREAM常量，默认使用AudioManager.STREAM_ALARM
void	setReplaceSpeakWord(java.lang.String[] original, java.lang.String[] replace) 方法名：替换TTS播报文字 方法描述：替换TTS播报文字，实际场景中，部分离线多音字声调可能出现错误。
void	setTtsDelay(long delay) 方法名：设置语音播报TTS延时 方法描述：设置语音播报TTS延时，但只有在需要抢焦点时才会延时，已有焦点时不会延时
void	setTtsModel(java.lang.String ttsModelPath) 方法名：设置TTS模型 方法描述：设置TTS模型路径，不同的模型音色不一样。
void	setTtsThmeme(TXZTtsManager.TtsTheme ttsTheme) 方法名：设置TTS主题 方法描述：手动切换TTS主题，需要提前获取TTS主题实例
void	setTtsTool(TXZTtsManager.TtsTool tool) 方法名：设置TTS播报工具 方法描述：当语音TTS播报工具不满足需求时，可以设置外部TTS工具
void	setVoiceSpeed(int speed) 方法名：设置合成的TTS播放语速 方法描述：设置合成的TTS播放语速，取值范围1-100,数值越大，语速越快,同行者默认值是70
int	speakRes(java.lang.String resId, java.lang.String text) 方法名：TTS播报 方法描述：通过语音内部资源ID播报，若无对应资源ID，则播报文本
int	speakRes(java.lang.String resId, java.lang.String[] resArgs, java.lang.String text) 方法名：TTS播报 方法描述：通过语音内部资源ID播报，若无对应资源ID，则播报文本
int	speakRes(java.lang.String resId, java.lang.String[] resArgs, java.lang.String text, TXZTtsManager.PreemptType type, TXZTtsManager.ITtsCallback onRun) 方法名：TTS播报 方法描述：通过语音内部资源ID播报，若无对应资源ID，则播报文本
int	speakText(int streamType, java.lang.String text, long delay, TXZTtsManager.PreemptType type, TXZTtsManager.ITtsCallback callback) 方法名：TTS播报 方法描述：TTS播报方法，可以详细设置TTS任务细节。
int	speakText(int streamType, java.lang.String text, TXZTtsManager.PreemptType type, TXZTtsManager.ITtsCallback callback) 方法名：TTS播报 方法描述：TTS播报方法，可以详细设置TTS任务细节。
int	speakText(java.lang.String text) 方法名：TTS播报 方法描述：TTS播报方法，可以详细设置TTS任务细节。
int	speakText(java.lang.String text, long delay, TXZTtsManager.PreemptType type, TXZTtsManager.ITtsCallback callback) 方法名：TTS播报 方法描述：TTS播报方法，可以详细设置TTS任务细节。
int	speakText(java.lang.String text, TXZTtsManager.ITtsCallback callback) 方法名：TTS播报 方法描述：TTS播报方法，可以详细设置TTS任务细节。
int	speakText(java.lang.String text, TXZTtsManager.PreemptType type, TXZTtsManager.ITtsCallback callback) 方法名：TTS播报 方法描述：TTS播报方法，可以详细设置TTS任务细节。
int	speakVoiceTask(int iStream, TXZTtsManager.PreemptType type, TXZTtsManager.VoiceTask[] voiceTasks, TXZTtsManager.ITtsCallback oRun) 方法名：执行播报任务 方法描述：用来执行一连串的TTS任务
int	speakVoiceTask(int iStream, TXZTtsManager.VoiceTask[] voiceTasks, TXZTtsManager.ITtsCallback oRun) 方法名：执行播报任务 方法描述：用来执行一连串的TTS任务
int	speakVoiceTask(TXZTtsManager.PreemptType bPreempt, TXZTtsManager.VoiceTask[] voiceTasks, TXZTtsManager.ITtsCallback oRun) 方法名：执行播报任务 方法描述：用来执行一连串的TTS任务
int	speakVoiceTask(TXZTtsManager.VoiceTask[] voiceTasks, TXZTtsManager.ITtsCallback oRun) 方法名：执行播报任务 方法描述：用来执行一连串的TTS任务

从类继承的方法 java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

INVALID_TTS_TASK_ID

public static final int INVALID_TTS_TASK_ID

常量名：无效的tts任务id 变量描述：无效的tts任务使用此ID

另请参阅:

常量字段值

方法详细资料

getInstance

public static TXZTtsManager getInstance()

获取单例

返回:

类实例

speakText

public int speakText(int streamType,
                     java.lang.String text,
                     TXZTtsManager.PreemptType type,
                     TXZTtsManager.ITtsCallback callback)

方法名：TTS播报 方法描述：TTS播报方法，可以详细设置TTS任务细节。 与TXZResourceManager.speakTextOnRecordWin(String, boolean, Runnable)有区别 此方法仅为播报，文本不会显示在语音界面

参数:

streamType - 流类型，填写AudioManager.STREAM常量，默认使用AudioManager.STREAM_ALARM

text - 播报的文本

type - 打断类型

callback - 播报回调

返回:

返回Tts的任务ID

speakText

public int speakText(int streamType,
                     java.lang.String text,
                     long delay,
                     TXZTtsManager.PreemptType type,
                     TXZTtsManager.ITtsCallback callback)

方法名：TTS播报 方法描述：TTS播报方法，可以详细设置TTS任务细节。 与TXZResourceManager.speakTextOnRecordWin(String, boolean, Runnable)有区别 此方法仅为播报，文本不会显示在语音界面

参数:

streamType - 流类型，填写AudioManager.STREAM常量，默认使用AudioManager.STREAM_ALARM

text - 播报的文本

delay - 播报延时，在已经获取到焦点时不会延时

type - 打断类型

callback - 播报回调

返回:

返回Tts的任务ID

speakText

public int speakText(java.lang.String text,
                     TXZTtsManager.PreemptType type,
                     TXZTtsManager.ITtsCallback callback)

方法名：TTS播报 方法描述：TTS播报方法，可以详细设置TTS任务细节。 与TXZResourceManager.speakTextOnRecordWin(String, boolean, Runnable)有区别 此方法仅为播报，文本不会显示在语音界面

参数:

text - 播报的文本

type - 打断类型

callback - 播报回调

返回:

返回Tts的任务ID

speakText

public int speakText(java.lang.String text,
                     long delay,
                     TXZTtsManager.PreemptType type,
                     TXZTtsManager.ITtsCallback callback)

方法名：TTS播报 方法描述：TTS播报方法，可以详细设置TTS任务细节。 与TXZResourceManager.speakTextOnRecordWin(String, boolean, Runnable)有区别 此方法仅为播报，文本不会显示在语音界面

参数:

text - 播报的文本

delay - 播报延时，在已经获取到焦点时不会延时

type - 打断类型

callback - 播报回调

返回:

返回Tts的任务ID

speakText

public int speakText(java.lang.String text,
                     TXZTtsManager.ITtsCallback callback)

方法名：TTS播报 方法描述：TTS播报方法，可以详细设置TTS任务细节。 与TXZResourceManager.speakTextOnRecordWin(String, boolean, Runnable)有区别 此方法仅为播报，文本不会显示在语音界面

参数:

text - 播报的文本

callback - 播报回调

返回:

返回Tts的任务ID

speakText

public int speakText(java.lang.String text)

方法名：TTS播报 方法描述：TTS播报方法，可以详细设置TTS任务细节。 与TXZResourceManager.speakTextOnRecordWin(String, boolean, Runnable)有区别 此方法仅为播报，文本不会显示在语音界面

参数:

text - 播报文本

返回:

返回Tts的任务ID

speakRes

public int speakRes(java.lang.String resId,
                    java.lang.String text)

方法名：TTS播报 方法描述：通过语音内部资源ID播报，若无对应资源ID，则播报文本

参数:

resId - 资源ID

text - 播报文本

返回:

播报任务ID

speakRes

public int speakRes(java.lang.String resId,
                    java.lang.String[] resArgs,
                    java.lang.String text)

方法名：TTS播报 方法描述：通过语音内部资源ID播报，若无对应资源ID，则播报文本

参数:

resId - 资源ID

resArgs - 播报的字符串用用来替换占位符的文本

text - 播报文本

返回:

播报任务ID

speakRes

public int speakRes(java.lang.String resId,
                    java.lang.String[] resArgs,
                    java.lang.String text,
                    TXZTtsManager.PreemptType type,
                    TXZTtsManager.ITtsCallback onRun)

方法名：TTS播报 方法描述：通过语音内部资源ID播报，若无对应资源ID，则播报文本

参数:

resId - 资源ID

resArgs - 播报的字符串用用来替换占位符的文本

text - 播报文本

type - 播报类型

onRun - 播报任务的回调

返回:

播报任务ID

speakVoiceTask

public int speakVoiceTask(TXZTtsManager.VoiceTask[] voiceTasks,
                          TXZTtsManager.ITtsCallback oRun)

方法名：执行播报任务 方法描述：用来执行一连串的TTS任务

参数:

voiceTasks - 播报的具体任务

oRun - 播报任务的回调

返回:

返回任务ID

speakVoiceTask

public int speakVoiceTask(int iStream,
                          TXZTtsManager.VoiceTask[] voiceTasks,
                          TXZTtsManager.ITtsCallback oRun)

方法名：执行播报任务 方法描述：用来执行一连串的TTS任务

参数:

iStream - 播报流

voiceTasks - 播报的具体任务

oRun - 播报任务的回调

返回:

返回任务ID

speakVoiceTask

public int speakVoiceTask(TXZTtsManager.PreemptType bPreempt,
                          TXZTtsManager.VoiceTask[] voiceTasks,
                          TXZTtsManager.ITtsCallback oRun)

方法名：执行播报任务 方法描述：用来执行一连串的TTS任务

参数:

bPreempt - 播报类型

voiceTasks - 播报的具体任务

oRun - 播报任务的回调

返回:

返回任务ID

speakVoiceTask

public int speakVoiceTask(int iStream,
                          TXZTtsManager.PreemptType type,
                          TXZTtsManager.VoiceTask[] voiceTasks,
                          TXZTtsManager.ITtsCallback oRun)

方法名：执行播报任务 方法描述：用来执行一连串的TTS任务

参数:

iStream - 播报流

type - 播报类型

voiceTasks - 播报的具体任务

oRun - 播报任务的回调

返回:

返回任务ID

cancelSpeak

public void cancelSpeak(int taskId)

方法名：取消播报 方法描述：根据TTS任务ID，强制取消TTS任务

参数:

taskId - 需要取消的TTS任务ID

setDefaultAudioStream

public void setDefaultAudioStream(int stream)

方法名：设置TTS播报流 方法描述：设置默认的TTS播报音频流，使用AudioManager的STREAM常量，默认使用AudioManager.STREAM_ALARM

参数:

stream - 播报流

setVoiceSpeed

public void setVoiceSpeed(int speed)

方法名：设置合成的TTS播放语速 方法描述：设置合成的TTS播放语速，取值范围1-100,数值越大，语速越快,同行者默认值是70

参数:

speed - 合成的TTS播放语速

setTtsModel

public void setTtsModel(java.lang.String ttsModelPath)

方法名：设置TTS模型 方法描述：设置TTS模型路径，不同的模型音色不一样。TTS模型需要联系同行者对应支持人员获取 ttsModelPath设为 null将使用默认TTS模型

参数:

ttsModelPath - TTS模型绝对路径

setTtsDelay

public void setTtsDelay(long delay)

方法名：设置语音播报TTS延时 方法描述：设置语音播报TTS延时，但只有在需要抢焦点时才会延时，已有焦点时不会延时

参数:

delay - 延时时间，单位ms

setBufferTime

public void setBufferTime(int nTime)

方法名：设置TTS播报的缓冲时间 方法描述：设置TTS播报的缓冲时间, 取值范围 0 ~ 15000, 默认值为300, 单位毫秒 由于TTS是合成音，实际应用中系统会因为防POP音等问题造成TTS掉字，通过此方法规避问题

参数:

nTime - 缓冲时间，单位ms

setBeepResources

public void setBeepResources(java.lang.String beepPath)

方法名：设置beep资源路径 方法描述：替换语音默认Beep音，即语音开始录音的“嘟”的一声 文件格式要求PCM：采样率16000，单声道，16位，建议不要超过200ms

参数:

beepPath - beep音文件路径

setReplaceSpeakWord

public void setReplaceSpeakWord(java.lang.String[] original,
                                java.lang.String[] replace)

方法名：替换TTS播报文字 方法描述：替换TTS播报文字，实际场景中，部分离线多音字声调可能出现错误。通过此方法替换播报 如：“单雄信”离线下无法区分是人名，应替换“扇雄信”。同时配合方法TXZAsrManager.setRealFictitiousCmds(String, String...)以更改语音界面显示文本

参数:

original - 原始文本数组，根据index对应，

replace - 替换播报的文本数组，根据index对应

enableDownVolumeWhenNav

public void enableDownVolumeWhenNav(boolean enable)

方法名：设置导航播报语音时TTS是否降低音量 方法描述：设置导航播报语音时TTS是否降低音量，默认语音与导航共存，根据需求修改，一般推荐修改导航降低音量

参数:

enable - 是否降低音量

forceShowTTSChoiceView

public void forceShowTTSChoiceView(boolean enable)

方法名：是否开启TTS主题切换列表显示 方法描述：切换TTS主题时，是否需要展示切换列表，默认展示，不展示时，直接根据TTS 序列号切换

参数:

enable - 是否启用列表显示功能

setTtsTool

public void setTtsTool(TXZTtsManager.TtsTool tool)

方法名：设置TTS播报工具 方法描述：当语音TTS播报工具不满足需求时，可以设置外部TTS工具

参数:

tool - TTS播报工具

setTtsThmeme

public void setTtsThmeme(TXZTtsManager.TtsTheme ttsTheme)

方法名：设置TTS主题 方法描述：手动切换TTS主题，需要提前获取TTS主题实例

参数:

ttsTheme - TTS主题

setChangeThemeListener

public void setChangeThemeListener(TXZTtsManager.onChangeThemeListener listener)

方法名：设置TTS主题更新监听器 方法描述：设置TTS主题更新监听器，其它因素切换主题时回调此监听器

参数:

listener - TTS主题更新监听器

getTtsThemes

public TXZTtsManager.TtsTheme[] getTtsThemes()

方法名：获取当前TTS主题列表 方法描述：主动获取当前系统支持的同行者语音主题

返回:

TTS主题列表