TTSManager (JNaviCore SDK Documentation)

java.lang.Object
- com.mapbar.mapdal.TTSManager

```
public final class TTSManager
extends java.lang.Object
```
TTS管理器类,负责音频播放(主要是TTS语音播报)全局属性的设置

嵌套类概要

嵌套类
限定符和类型	类和说明
`class`	`TTSManager.ErrorType`
`static class`	`TTSManager.FocusLossStrategy` 声音焦点失去时的策略
`static interface`	`TTSManager.TTSPlayerListener` TTS播报事件监听器
`static interface`	`TTSManager.TTSStreamDataChangeListener`
`static class`	`TTSManager.TTSStreamHeaderInfo` TTS PCM流头信息
`static interface`	`TTSManager.TTSTextChangeListener` 导航播报文本变化监听器

字段概要

字段
限定符和类型字段和说明

static java.lang.Object mTTSObject

字段
限定符和类型	字段和说明
`static java.lang.Object`	`mTTSObject`

构造器概要

构造器
构造器和说明

TTSManager()

构造器
构造器和说明
`TTSManager()`

方法概要

所有方法静态方法具体方法已过时的方法
限定符和类型	方法和说明
`static void`	`appendContentToTTSText(java.lang.String text)` 向播报的内容后面追加内容，比如延迟：[p500]
`static void`	`connectCar()` 与车机建立连接时需要做的操作
`static void`	`disconnectCar()` 与车机断开连接时需要做的操作
`static void`	`enableCallbackTTSStream(boolean enable)` 设置是否返回TTS流为true时返回TTS PCM流，引擎不进行语音播报；为false时不返回PCM流，引擎内进行语音播报。
`static void`	`enableRequestAudioFocus(boolean enable)` enable request audio focus before play, default: true If set true, sound can be played only when focus is granted, and will be forceStop when focus is lost.
`static TTSRoleDescription[]`	`enumTTSRoles()` 列举所有支持的角色
`static void`	`forceAbandonAudioFocus()` 强制释放焦点
`static void`	`getPlayerVolume(float[] volumes)` 获取播放器的音量
`static TTSRoleDescription`	`getRole()` 获取当前采用的角色
`static int`	`getStreamVolume()` 获取当前通道音量大小
`static TTSManager.TTSStreamHeaderInfo`	`getTTSStreamHeaderInfo()` 获取TTS PCM流的头信息
`static int`	`getVolume()` 已过时。
`static boolean`	`isCallbackTTSStreamEnabled()` 判断是否返回TTS流
`static boolean`	`isForceStop()` 判断是否需要停止当前播报。
`static boolean`	`isMediaPlaying()` 判断当前是否有正在进行的播报
`static void`	`notifyTTSThread()` 唤醒TTS线程，继续合成pcm流
`static void`	`pausePlay()` 终止当前播报，普通形式或者背景音形式的播报都会被暂停
`static void`	`resetRole()` 将角色重新设置为默认
`static void`	`resumePlay()` 恢复播报，将恢复之前被暂停的普通形式或者背景音形式的播报
`static void`	`setDelayedDurationAfterPlayTTS(long duration)` set delayed duration for after TTS play, unit: ms
`static void`	`setDelayedDurationBeforePlayTTS(long duration)` set delayed duration for before TTS play. unit: ms
`static void`	`setDurationHint(int durationHint)` set durationHint used in `AudioManager.requestAudioFocus(OnAudioFocusChangeListener, int, int)`
`static void`	`setFocusLossStrategy(int Strategy)` 设置失去音频焦点时的策略，默认：`TTSManager.FocusLossStrategy.stopVoice`
`static void`	`setListener(TTSManager.TTSPlayerListener listener)` 设置监听器
`static void`	`setOnAudioFocusChangeListener(android.media.AudioManager.OnAudioFocusChangeListener listener)` 设置音频焦点状态监听器
`static void`	`setPlayerVolume(float leftVolume, float rightVolume)` 设置播放器的音量。
`static void`	`setRole(TTSRoleDescription ttsRole)` 设置采取的角色
`static void`	`setStreamVolume(int volume)` 设置当前通道音量大小。
`static void`	`setTTSPcmDataChangeListener(TTSManager.TTSStreamDataChangeListener listener)` 设置外部TTS流播放的Listener
`static void`	`setTTSTextChangeListener(TTSManager.TTSTextChangeListener listener)` 设置播报文本变化监听器
`static void`	`setVolume(int volume)` 已过时。

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - mTTSObject
```
public static java.lang.Object mTTSObject
```
- 构造器详细资料
  - TTSManager
```
public TTSManager()
```
- 方法详细资料
  - setVolume
```
public static void setVolume(int volume)
```
    已过时。
    
    设置当前通道音量大小
    
    参数:
    
    volume - 需要设置的音量
    
    另请参阅:
    
    setStreamVolume(int)
  - getVolume
```
public static int getVolume()
```
    已过时。
    
    获取当前通道音量大小
    
    返回:
    
    当前音量
    
    另请参阅:
    
    setStreamVolume(int)
  - setFocusLossStrategy
```
public static void setFocusLossStrategy(int Strategy)
```
    设置失去音频焦点时的策略，默认：TTSManager.FocusLossStrategy.stopVoice
    
    参数:
    
    Strategy - 策略TTSManager.FocusLossStrategy
  - setStreamVolume
```
public static void setStreamVolume(int volume)
```
    设置当前通道音量大小。如果只是改变播放器的音量，使用setPlayerVolume(float, float)
    
    参数:
    
    volume - 需要设置的音量
  - getStreamVolume
```
public static int getStreamVolume()
```
    获取当前通道音量大小
    
    返回:
    
    当前音量
  - setPlayerVolume
```
public static void setPlayerVolume(float leftVolume,
                                   float rightVolume)
```
    设置播放器的音量。只针对当前播放器有效，不会改变通道的音量。默认:(1.0f, 1.0f)
    
    参数:
    
    leftVolume - 左声道音量，取值范围[0, 1.0f]
    
    rightVolume - 右声道音量，取值范围[0, 1.0f]
    
    另请参阅:
    
    MediaPlayer.setVolume(float, float)
  - getPlayerVolume
```
public static void getPlayerVolume(float[] volumes)
```
    获取播放器的音量
    
    参数:
    
    volume - 长度为2的数组
    
    另请参阅:
    
    setPlayerVolume(float, float)
  - isMediaPlaying
```
public static boolean isMediaPlaying()
```
    判断当前是否有正在进行的播报
  - pausePlay
```
public static void pausePlay()
```
    终止当前播报，普通形式或者背景音形式的播报都会被暂停
  - resumePlay
```
public static void resumePlay()
```
    恢复播报，将恢复之前被暂停的普通形式或者背景音形式的播报
  - setListener
```
public static void setListener(TTSManager.TTSPlayerListener listener)
```
    设置监听器
    
    参数:
    
    listener - TTSManager.TTSPlayerListener
  - setTTSTextChangeListener
```
public static void setTTSTextChangeListener(TTSManager.TTSTextChangeListener listener)
```
    设置播报文本变化监听器
    
    参数:
    
    listener - TTSManager.TTSTextChangeListener
  - setOnAudioFocusChangeListener
```
public static void setOnAudioFocusChangeListener(android.media.AudioManager.OnAudioFocusChangeListener listener)
```
    设置音频焦点状态监听器
    
    参数:
    
    listener - AudioManager.OnAudioFocusChangeListener
  - enumTTSRoles
```
public static TTSRoleDescription[] enumTTSRoles()
```
    列举所有支持的角色
    
    返回:
    
    包含所有支持角色描述信息的数组 TTSRoleDescription
    
    另请参阅:
    
    TTSRoleDescription
  - getRole
```
public static TTSRoleDescription getRole()
```
    获取当前采用的角色
    
    返回:
    
    current role.TTSRoleDescription
    
    另请参阅:
    
    TTSRoleDescription
  - setRole
```
public static void setRole(TTSRoleDescription ttsRole)
```
    设置采取的角色
    
    参数:
    
    TTSRole - 被选取的角色 TTSRoleDescription
  - resetRole
```
public static void resetRole()
```
    将角色重新设置为默认
  - isForceStop
```
public static boolean isForceStop()
```
    判断是否需要停止当前播报。由于播报在单独的线程中，在一些关键点需要主动检查是否需要停止当前播报。
    
    返回:
    
    true时需要停止当前播报，false时不停止
  - setDelayedDurationBeforePlayTTS
```
public static void setDelayedDurationBeforePlayTTS(long duration)
```
    set delayed duration for before TTS play. unit: ms
    
    参数:
    
    duration - delayed duration
  - setDelayedDurationAfterPlayTTS
```
public static void setDelayedDurationAfterPlayTTS(long duration)
```
    set delayed duration for after TTS play, unit: ms
    
    参数:
    
    duration - delayed duration
  - enableRequestAudioFocus
```
public static void enableRequestAudioFocus(boolean enable)
```
    enable request audio focus before play, default: true
    If set true, sound can be played only when focus is granted, and will be forceStop when focus is lost.
    
    参数:
    
    enable - true for request audio focus, false otherwise
  - setDurationHint
```
public static void setDurationHint(int durationHint)
```
    set durationHint used in AudioManager.requestAudioFocus(OnAudioFocusChangeListener, int, int)
    
    参数:
    
    durationHint - 默认是 AudioManager.AUDIOFOCUS_GAIN_TRANSIENT，设置为此参数时，一般情况下，被抢占AudioFocus的应用程序将中断音频播放，例如QQ音乐，网易云音乐。设置为AudioManager.AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK时，一般情况下，被抢占AudioFocus的应用程序仍会继续播放，但是音量会降低，例如QQ音乐，网易云音乐。
  - forceAbandonAudioFocus
```
public static void forceAbandonAudioFocus()
```
    强制释放焦点
  - appendContentToTTSText
```
public static void appendContentToTTSText(java.lang.String text)
```
    向播报的内容后面追加内容，比如延迟：[p500]
    
    参数:
    
    text - 追加的内容
  - setTTSPcmDataChangeListener
```
public static void setTTSPcmDataChangeListener(TTSManager.TTSStreamDataChangeListener listener)
```
    设置外部TTS流播放的Listener
    
    参数:
    
    listener - TTSManager.TTSStreamDataChangeListener
  - enableCallbackTTSStream
```
public static void enableCallbackTTSStream(boolean enable)
```
    设置是否返回TTS流
    为true时返回TTS PCM流，引擎不进行语音播报；为false时不返回PCM流，引擎内进行语音播报。
    设置从下一句开始生效，不会影响当前播报。
    
    参数:
    
    enable - 开关，默认:false
  - isCallbackTTSStreamEnabled
```
public static boolean isCallbackTTSStreamEnabled()
```
    判断是否返回TTS流
    
    返回:
    
    是否返回TTS流
  - getTTSStreamHeaderInfo
```
public static TTSManager.TTSStreamHeaderInfo getTTSStreamHeaderInfo()
```
    获取TTS PCM流的头信息
    
    返回:
    
    头信息
  - notifyTTSThread
```
public static void notifyTTSThread()
```
    唤醒TTS线程，继续合成pcm流
  - connectCar
```
public static void connectCar()
```
    与车机建立连接时需要做的操作
  - disconnectCar
```
public static void disconnectCar()
```
    与车机断开连接时需要做的操作

类 TTSManager

嵌套类概要

字段概要

构造器概要

方法概要

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

字段详细资料

mTTSObject

构造器详细资料

TTSManager

方法详细资料

setVolume

getVolume

setFocusLossStrategy

setStreamVolume

getStreamVolume

setPlayerVolume

getPlayerVolume

isMediaPlaying

pausePlay

resumePlay

setListener

setTTSTextChangeListener

setOnAudioFocusChangeListener

enumTTSRoles

getRole

setRole

resetRole

isForceStop

setDelayedDurationBeforePlayTTS

setDelayedDurationAfterPlayTTS

enableRequestAudioFocus

setDurationHint

forceAbandonAudioFocus

appendContentToTTSText

setTTSPcmDataChangeListener

enableCallbackTTSStream

isCallbackTTSStreamEnabled

getTTSStreamHeaderInfo

notifyTTSThread

connectCar

disconnectCar