TXZMusicManager

java.lang.Object
- com.txznet.sdk.TXZMusicManager

```
public class TXZMusicManager
extends java.lang.Object
```
类名：音乐管理器用途：语音默认适配电台之家、同听、酷我、QQ音乐等主流车载音乐APP，语音检测到对应APP时，默认控制对应音乐类型。当默认音乐逻辑不满足需求或需要适配音乐控制其它音乐APP时，通过此类设置音乐工具（AbsMusicTool），修改默认音乐逻辑。

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`TXZMusicManager.AudioTool` 枚举类：电台工具类型枚举类描述：默认支持电台类型
`static class`	`TXZMusicManager.MusicModel` 类名：音乐模型类描述：音乐实例抽象化类，包含音乐相关信息
`static interface`	`TXZMusicManager.MusicTool` 已过时。已过时
`static interface`	`TXZMusicManager.MusicToolEx` 接口名：扩展MusicTool方法接口描述：扩展MusicTool方法，提供额外方法
`static interface`	`TXZMusicManager.MusicToolStatusListener` 接口名：音乐工具状态变化监听器接口描述：外部音乐状态变化时，通过此监听器通知语音
`static class`	`TXZMusicManager.MusicToolType` 枚举类名：内置音乐工具类型枚举类描述：提供语音默认支持的音乐工具类型

方法概要

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
限定符和类型	方法和说明
`void`	`addMusicStatusListener(TXZMusicManager.MusicToolStatusListener mtsl)` 方法名：添加音乐监听器方法描述：添加额外音乐监听器
`void`	`continuePlay()` 方法名：继续播放方法描述：控制当前音乐类型，包括同行者支持的音乐APP
`void`	`exit()` 方法名：关闭音乐方法描述：控制当前音乐类型，包括同行者支持的音乐APP
`void`	`exitAllMusicToolImmediately()` 方法名：退出所有音乐工具方法描述：关闭当前安装的全部或已适配的音乐类型APP
`void`	`favourMusic()` 方法名：收藏当前歌曲方法描述：仅支持电台之家和同听，收藏当前歌曲，
`TXZMusicManager.MusicModel`	`getCurrentMusicModel()` 方法名：获取当前正在播放的音乐模型，没有播放返回null 方法描述：获取当前音乐类型，包括同行者支持的音乐APP
`static TXZMusicManager`	`getInstance()` 获取单例
`boolean`	`isBuffering()` 方法名：获取是否缓冲的状态方法描述：仅限电台之家和同听APP
`boolean`	`isPlaying()` 方法名：播放状态获取接口方法描述：获取当前音乐的播放状态
`void`	`next()` 方法名：下一首方法描述：控制当前音乐类型，包括同行者支持的音乐APP
`void`	`pause()` 方法名：暂停播放方法描述：控制当前音乐类型，包括同行者支持的音乐APP
`void`	`play()` 方法名：开始播放方法描述：控制当前音乐类型，包括同行者支持的音乐APP
`void`	`playFavourMusic()` 方法名：播放收藏歌曲方法描述：仅支持电台之家和同听，播放收藏歌曲，
`void`	`playRandom()` 方法名：随便听听/随便来首歌方法描述：控制当前音乐类型，包括同行者支持的音乐APP
`void`	`prev()` 方法名：上一首方法描述：控制当前音乐类型，包括同行者支持的音乐APP
`void`	`removeMusicStatusListener(TXZMusicManager.MusicToolStatusListener listener)` 方法名：移除音乐状态监听器方法描述：通过实例移除已添加的监听器
`void`	`setBackbtnVisible(java.lang.Boolean visible)` 方法名：设置App是否有返回按钮方法描述：仅限同听APP
`void`	`setDefaultAudioTool(TXZMusicManager.AudioTool at)` 已过时。
`void`	`setEnableAudoJumpPlayerPage(java.lang.Boolean enable)` 方法名：设置是否自动打开播放页面方法描述：同听3.0以上版本支持
`void`	`setEnableFloatingPlayer(java.lang.Boolean enable)` 方法名：设置是否开启悬浮播放器方法描述：同听3.0以上版本支持
`void`	`setEnableSplash(java.lang.Boolean enable)` 方法名：设置是否开启闪屏页方法描述：同听3.0以上版本支持
`void`	`setExitWithPlay(boolean withplay)` 方法名：设置点击返回按键是否退出播放方法描述：仅限电台之家
`void`	`setExtraTypeface(boolean needExtra)` 方法名：设置是否适用额外的字体库方法描述：支持韩文和日文，仅限电台之家
`void`	`setFullScreen(java.lang.Boolean play)` 已过时。
`void`	`setHideTips(java.lang.Boolean visible)` 方法名：设置App是否隐藏帮忙按钮方法描述：仅限同听APP
`void`	`setIsCloseVolume(java.lang.Boolean close)` 方法名：设置是否关闭电台之家对声音的控制方法描述：仅限电台之家，电台之家默认集成了音量免唤醒功能，会导致自定义全局唤醒词“增大音量”等失效并且播放界面上下拖动不会有反应
`void`	`setLocalPath(java.lang.String[] paths)` 方法名：设置本地扫描路径方法描述：针对同听、电台之家，设置同听、电台之前描述音乐文件路径，将仅扫描对应路径
`void`	`setLocalSearchSize(java.lang.Integer minSize)` 方法名：设置本地扫描最小扫描文件大小方法描述：仅限电台之家，默认最小文件为500K
`void`	`setMusicTool(com.txznet.sdk.media.AbsTXZMusicTool tool)` 方法名：设置音乐工具方法描述：重写音乐逻辑或适配其它音乐逻辑时，可以使用此方法
`void`	`setMusicTool(TXZMusicManager.MusicTool tool)` 已过时。已过时，推荐使用新类型
`void`	`setMusicTool(TXZMusicManager.MusicToolType type)` 方法名：设置音乐工具类型方法描述：手动指定当前语音需要控制的音乐类型，如多音乐APP时，通过此方法切换
`void`	`setNeedAsr(java.lang.Boolean need)` 方法名：设置App是否启用全局唤醒词方法描述：仅限电台之家
`void`	`setNotOpenAppPName(java.lang.String[] sContent)` 方法名：声控后是否打开播放器界面方法描述：仅限电台之家
`void`	`setReleaseAudioFocus(java.lang.Boolean isRealse)` 方法名 :电台之家丢失音频焦点后是否释放焦点方法描述：仅限电台之家
`void`	`setResumeAutoPlay(boolean set)` 方法名：设置打开同听后是否自动开始播放方法描述：仅限同听APP
`void`	`setSearchConfig(TXZMusicManager.MusicToolType type, boolean showResult, int timeout)` 方法名：设置音乐工具搜索参数方法描述：设置具体搜索音乐类型对应参数值，根据音乐类型设置
`void`	`setShortPlayEnable(boolean enable)` 方法名：设置默认是否开启30s快报推送方法描述：同听3.0以上版本有效
`void`	`setShortPlayNeedTrigger(boolean enable)` 方法名：设置30s快报是否需要手动触发方法描述：针对同听APP，默认开机触发，手动时需要调用对应方法
`void`	`setShowExitDialog(boolean enable)` 方法名：设置点击返回退出同听时是否弹出对话框方法描述：同听3.1以上版本有效
`void`	`setStartAppPlay(java.lang.Boolean play)` 方法名：设置App是否一启动就继续播放上次未关闭的音频方法描述：仅限电台之家APP
`void`	`setTipShowPosition(java.lang.String position)` 方法名：设置App提示框显示的位置方法描述：仅限同听APP
`void`	`setTTMusicControlTaskId(java.lang.String taskId)` 方法名：设置外部程序自定义命令字控制同听的任务ID 方法描述：用于将适配注册的指令同步至同行者金手指功能
`void`	`setWakeupDefaultValue(boolean defaultValue)` 方法名：设置同听是否注册免唤醒词的默认值方法描述：针对同听，用户修改后以用户设置为准
`void`	`setWakeupPlay(java.lang.Boolean isPlay)` 方法名：设置电台之家在休眠唤醒后是否继续播放方法描述：仅限电台之家
`void`	`showKuwoSearchResult(boolean show)` 已过时。转用 `setSearchConfig(com.txznet.sdk.TXZMusicManager.MusicToolType, boolean, int)`, 提供针对特定工具的更详细配置
`void`	`switchModeLoopAll()` 方法名：全部循环方法描述：控制当前音乐类型，包括同行者支持的音乐APP
`void`	`switchModeLoopOne()` 方法名：单曲循环方法描述：控制当前音乐类型，包括同行者支持的音乐APP
`void`	`switchModeRandom()` 方法名：随机播放方法描述：控制当前音乐类型，包括同行者支持的音乐APP
`void`	`switchSong()` 方法名：切换歌曲方法描述：控制当前音乐类型，包括同行者支持的音乐APP
`void`	`syncExMuicList(java.util.Collection<TXZMusicManager.MusicModel> musics)` 方法名：同步额外音乐列表方法描述：将音乐列表同步给语音，与系统数据库共存
`void`	`syncExMuicListToCore(java.util.Collection<TXZMusicManager.MusicModel> musics)` 方法名：同步额外音乐列表方法描述：将音乐列表同步给语音，与系统数据库共存，但会在语音断开连接时清空数据
`void`	`syncMuicList(java.util.Collection<TXZMusicManager.MusicModel> musics)` 方法名：同步音乐列表方法描述：将音乐列表同步给语音，之后将不会再从系统数据库读取音乐，支持电台之家和同听
`void`	`triggerShortPlay()` 方法名：手动触发同听30s快报方法描述：针对同听APP，设置为手动触发时，需要调用此方法以触发
`void`	`unfavourMusic()` 方法名：取消收藏当前歌曲方法描述：仅支持电台之家和同听，取消收藏当前歌曲

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

- 方法详细资料
  - getInstance
```
public static TXZMusicManager getInstance()
```
    获取单例
    
    返回:
    
    类实例
  - setMusicTool
```
public void setMusicTool(TXZMusicManager.MusicToolType type)
```
    方法名：设置音乐工具类型方法描述：手动指定当前语音需要控制的音乐类型，如多音乐APP时，通过此方法切换
    
    参数:
    
    type - 内置音乐工具类型，自动按安装包选择，默认优先级：同行者>酷我>考拉
  - addMusicStatusListener
```
public void addMusicStatusListener(TXZMusicManager.MusicToolStatusListener mtsl)
```
    方法名：添加音乐监听器方法描述：添加额外音乐监听器
    
    参数:
    
    mtsl - 监听器
  - removeMusicStatusListener
```
public void removeMusicStatusListener(TXZMusicManager.MusicToolStatusListener listener)
```
    方法名：移除音乐状态监听器方法描述：通过实例移除已添加的监听器
    
    参数:
    
    listener - 监听器
  - setStartAppPlay
```
public void setStartAppPlay(java.lang.Boolean play)
```
    方法名：设置App是否一启动就继续播放上次未关闭的音频方法描述：仅限电台之家APP
    
    参数:
    
    play - true 是 false 否，默认true
  - setFullScreen
```
@Deprecated
public void setFullScreen(java.lang.Boolean play)
```
    已过时。
    
    方法名：设置App是否全屏方法名：仅限电台之家APP
    
    参数:
    
    play - true 是 false 否默认true
  - setBackbtnVisible
```
public void setBackbtnVisible(java.lang.Boolean visible)
```
    方法名：设置App是否有返回按钮方法描述：仅限同听APP
    
    参数:
    
    visible - true 是 false 否默认true
  - setHideTips
```
public void setHideTips(java.lang.Boolean visible)
```
    方法名：设置App是否隐藏帮忙按钮方法描述：仅限同听APP
    
    参数:
    
    visible - true 是 false 否默认true
  - setTipShowPosition
```
public void setTipShowPosition(java.lang.String position)
```
    方法名：设置App提示框显示的位置方法描述：仅限同听APP
    
    参数:
    
    position - TOP 上，bottom 下
  - setEnableFloatingPlayer
```
public void setEnableFloatingPlayer(java.lang.Boolean enable)
```
    方法名：设置是否开启悬浮播放器方法描述：同听3.0以上版本支持
    
    参数:
    
    enable - true 开启 false 关闭
  - setEnableSplash
```
public void setEnableSplash(java.lang.Boolean enable)
```
    方法名：设置是否开启闪屏页方法描述：同听3.0以上版本支持
    
    参数:
    
    enable - true 开启 false 关闭
  - setEnableAudoJumpPlayerPage
```
public void setEnableAudoJumpPlayerPage(java.lang.Boolean enable)
```
    方法名：设置是否自动打开播放页面方法描述：同听3.0以上版本支持
    
    参数:
    
    enable - true 开启 false 关闭
  - setIsCloseVolume
```
public void setIsCloseVolume(java.lang.Boolean close)
```
    方法名：设置是否关闭电台之家对声音的控制方法描述：仅限电台之家，电台之家默认集成了音量免唤醒功能，会导致自定义全局唤醒词“增大音量”等失效并且播放界面上下拖动不会有反应
    
    参数:
    
    close - true 是 false 否
  - setNotOpenAppPName
```
public void setNotOpenAppPName(java.lang.String[] sContent)
```
    方法名：声控后是否打开播放器界面方法描述：仅限电台之家
    
    参数:
    
    sContent - null 声控后不打开 or value 其他应用的包名(当遇到该包名时不打开,建议增加自己的导航包名)
  - setExitWithPlay
```
public void setExitWithPlay(boolean withplay)
```
    方法名：设置点击返回按键是否退出播放方法描述：仅限电台之家
    
    参数:
    
    withplay - true 为继续播放 false 为退出播放
  - setExtraTypeface
```
public void setExtraTypeface(boolean needExtra)
```
    方法名：设置是否适用额外的字体库方法描述：支持韩文和日文，仅限电台之家
  - setReleaseAudioFocus
```
public void setReleaseAudioFocus(java.lang.Boolean isRealse)
```
    方法名 :电台之家丢失音频焦点后是否释放焦点方法描述：仅限电台之家
    
    参数:
    
    isRealse - true则释放焦点，false则不释放默认不释放
  - setWakeupPlay
```
public void setWakeupPlay(java.lang.Boolean isPlay)
```
    方法名：设置电台之家在休眠唤醒后是否继续播放方法描述：仅限电台之家
    
    参数:
    
    isPlay - true则继续播放 false则不播放
  - setResumeAutoPlay
```
public void setResumeAutoPlay(boolean set)
```
    方法名：设置打开同听后是否自动开始播放方法描述：仅限同听APP
    
    参数:
    
    set - true则自动播放 false则不播放默认不播放
  - setShortPlayEnable
```
public void setShortPlayEnable(boolean enable)
```
    方法名：设置默认是否开启30s快报推送方法描述：同听3.0以上版本有效
    
    参数:
    
    enable - true开启 false关闭
  - setShortPlayNeedTrigger
```
public void setShortPlayNeedTrigger(boolean enable)
```
    方法名：设置30s快报是否需要手动触发方法描述：针对同听APP，默认开机触发，手动时需要调用对应方法
    
    参数:
    
    enable - true 设置快报需要手动触发 false 设置快报开机自动播放
  - triggerShortPlay
```
public void triggerShortPlay()
```
    方法名：手动触发同听30s快报方法描述：针对同听APP，设置为手动触发时，需要调用此方法以触发
  - setShowExitDialog
```
public void setShowExitDialog(boolean enable)
```
    方法名：设置点击返回退出同听时是否弹出对话框方法描述：同听3.1以上版本有效
    
    参数:
    
    enable - true开启 false关闭
  - setLocalSearchSize
```
public void setLocalSearchSize(java.lang.Integer minSize)
```
    方法名：设置本地扫描最小扫描文件大小方法描述：仅限电台之家，默认最小文件为500K
    
    参数:
    
    minSize - 最小参数大小，单位KB
  - setLocalPath
```
public void setLocalPath(java.lang.String[] paths)
```
    方法名：设置本地扫描路径方法描述：针对同听、电台之家，设置同听、电台之前描述音乐文件路径，将仅扫描对应路径
    
    参数:
    
    paths - 设置本地路径
  - setNeedAsr
```
public void setNeedAsr(java.lang.Boolean need)
```
    方法名：设置App是否启用全局唤醒词方法描述：仅限电台之家
    
    参数:
    
    need - true 是 false 否
  - setWakeupDefaultValue
```
public void setWakeupDefaultValue(boolean defaultValue)
```
    方法名：设置同听是否注册免唤醒词的默认值方法描述：针对同听，用户修改后以用户设置为准
    
    参数:
    
    defaultValue - 默认值，默认注册“上一首”、“下一首”、“暂停播放”、“继续播放”、“开始播放”
  - setMusicTool
```
@Deprecated
public void setMusicTool(TXZMusicManager.MusicTool tool)
```
    已过时。已过时，推荐使用新类型
    
    方法名：设置音乐工具方法描述：重写音乐逻辑或适配其它音乐逻辑时，可以使用此方法
    
    参数:
    
    tool - 音乐工具
    
    另请参阅:
    
    AbsTXZMusicTool
  - setMusicTool
```
public void setMusicTool(com.txznet.sdk.media.AbsTXZMusicTool tool)
```
    方法名：设置音乐工具方法描述：重写音乐逻辑或适配其它音乐逻辑时，可以使用此方法
    
    参数:
    
    tool - 音乐工具
  - setDefaultAudioTool
```
@Deprecated
public void setDefaultAudioTool(TXZMusicManager.AudioTool at)
```
    已过时。
    
    方法名：设置当前默认电台类型方法描述：手动设置当前默认电台类型，如多电台APP时，手动切换语音控制的APP
    
    参数:
    
    at - 电台工具
  - setTTMusicControlTaskId
```
public void setTTMusicControlTaskId(java.lang.String taskId)
```
    方法名：设置外部程序自定义命令字控制同听的任务ID 方法描述：用于将适配注册的指令同步至同行者金手指功能
    
    参数:
    
    taskId - 外部程序注册的免唤醒词ID
  - isPlaying
```
public boolean isPlaying()
```
    方法名：播放状态获取接口方法描述：获取当前音乐的播放状态
    
    返回:
    
    是否正在播放
  - isBuffering
```
public boolean isBuffering()
```
    方法名：获取是否缓冲的状态方法描述：仅限电台之家和同听APP
    
    返回:
    
    是否正在播放
  - play
```
public void play()
```
    方法名：开始播放方法描述：控制当前音乐类型，包括同行者支持的音乐APP
  - continuePlay
```
public void continuePlay()
```
    方法名：继续播放方法描述：控制当前音乐类型，包括同行者支持的音乐APP
  - pause
```
public void pause()
```
    方法名：暂停播放方法描述：控制当前音乐类型，包括同行者支持的音乐APP
  - exit
```
public void exit()
```
    方法名：关闭音乐方法描述：控制当前音乐类型，包括同行者支持的音乐APP
  - exitAllMusicToolImmediately
```
public void exitAllMusicToolImmediately()
```
    方法名：退出所有音乐工具方法描述：关闭当前安装的全部或已适配的音乐类型APP
  - next
```
public void next()
```
    方法名：下一首方法描述：控制当前音乐类型，包括同行者支持的音乐APP
  - prev
```
public void prev()
```
    方法名：上一首方法描述：控制当前音乐类型，包括同行者支持的音乐APP
  - switchModeLoopAll
```
public void switchModeLoopAll()
```
    方法名：全部循环方法描述：控制当前音乐类型，包括同行者支持的音乐APP
  - switchModeLoopOne
```
public void switchModeLoopOne()
```
    方法名：单曲循环方法描述：控制当前音乐类型，包括同行者支持的音乐APP
  - switchModeRandom
```
public void switchModeRandom()
```
    方法名：随机播放方法描述：控制当前音乐类型，包括同行者支持的音乐APP
  - switchSong
```
public void switchSong()
```
    方法名：切换歌曲方法描述：控制当前音乐类型，包括同行者支持的音乐APP
  - playRandom
```
public void playRandom()
```
    方法名：随便听听/随便来首歌方法描述：控制当前音乐类型，包括同行者支持的音乐APP
  - getCurrentMusicModel
```
public TXZMusicManager.MusicModel getCurrentMusicModel()
```
    方法名：获取当前正在播放的音乐模型，没有播放返回null 方法描述：获取当前音乐类型，包括同行者支持的音乐APP
  - playFavourMusic
```
public void playFavourMusic()
```
    方法名：播放收藏歌曲方法描述：仅支持电台之家和同听，播放收藏歌曲，
  - favourMusic
```
public void favourMusic()
```
    方法名：收藏当前歌曲方法描述：仅支持电台之家和同听，收藏当前歌曲，
  - unfavourMusic
```
public void unfavourMusic()
```
    方法名：取消收藏当前歌曲方法描述：仅支持电台之家和同听，取消收藏当前歌曲
  - showKuwoSearchResult
```
@Deprecated
public void showKuwoSearchResult(boolean show)
```
    已过时。转用 setSearchConfig(com.txznet.sdk.TXZMusicManager.MusicToolType, boolean, int), 提供针对特定工具的更详细配置
    
    方法名：是否展示酷我搜索结果方法描述：默认不显示酷我搜索结果，直接播放
    
    参数:
    
    show - 是否需要列表显示
  - setSearchConfig
```
public void setSearchConfig(TXZMusicManager.MusicToolType type,
                            boolean showResult,
                            int timeout)
```
    方法名：设置音乐工具搜索参数方法描述：设置具体搜索音乐类型对应参数值，根据音乐类型设置
    
    参数:
    
    type - 工具类型
    
    showResult - 是否在声控界面显示搜索列表
    
    timeout - 搜索超时时间
  - syncMuicList
```
public void syncMuicList(java.util.Collection<TXZMusicManager.MusicModel> musics)
```
    方法名：同步音乐列表方法描述：将音乐列表同步给语音，之后将不会再从系统数据库读取音乐，支持电台之家和同听
    
    参数:
    
    musics - 音乐集合
  - syncExMuicList
```
public void syncExMuicList(java.util.Collection<TXZMusicManager.MusicModel> musics)
```
    方法名：同步额外音乐列表方法描述：将音乐列表同步给语音，与系统数据库共存
    
    参数:
    
    musics - 音乐集合
  - syncExMuicListToCore
```
public void syncExMuicListToCore(java.util.Collection<TXZMusicManager.MusicModel> musics)
```
    方法名：同步额外音乐列表方法描述：将音乐列表同步给语音，与系统数据库共存，但会在语音断开连接时清空数据
    
    参数:
    
    musics - 音乐集合

类 TXZMusicManager

嵌套类概要

方法概要

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

方法详细资料

getInstance

setMusicTool

addMusicStatusListener

removeMusicStatusListener

setStartAppPlay

setFullScreen

setBackbtnVisible

setHideTips

setTipShowPosition

setEnableFloatingPlayer

setEnableSplash

setEnableAudoJumpPlayerPage

setIsCloseVolume

setNotOpenAppPName

setExitWithPlay

setExtraTypeface

setReleaseAudioFocus

setWakeupPlay

setResumeAutoPlay

setShortPlayEnable

setShortPlayNeedTrigger

triggerShortPlay

setShowExitDialog

setLocalSearchSize

setLocalPath

setNeedAsr

setWakeupDefaultValue

setMusicTool

setMusicTool

setDefaultAudioTool

setTTMusicControlTaskId

isPlaying

isBuffering

play

continuePlay

pause

exit

exitAllMusicToolImmediately

next

prev

switchModeLoopAll

switchModeLoopOne

switchModeRandom

switchSong

playRandom

getCurrentMusicModel

playFavourMusic

favourMusic

unfavourMusic

showKuwoSearchResult

setSearchConfig

syncMuicList

syncExMuicList

syncExMuicListToCore