@tencentcloud/sdk-mcp 1.2.9 → 1.3.0

package/resource/doc/trtc/iOS/TXAudioEffectManager.md

@@ -0,0 +1,1117 @@
+# 腾讯云实时音视频(TRTC SDK )文档
+
+## 概述
+`TXAudioEffectManager.h` 是腾讯云实时音视频(TRTC SDK ) iOS 平台的背景音乐、短音效和人声特效的管理类文档，用于对背景音乐、短音效和人声特效进行设置的管理类。
+
+
+## TXAudioEffectManager
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >函数列表</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[enableVoiceEarMonitor:](https://write.woa.com/document/87029789200396288)</td>
+
+<td rowspan="1" colSpan="1" >开启耳返。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[setVoiceEarMonitorVolume:](https://write.woa.com/document/87029789200396288)</td>
+
+<td rowspan="1" colSpan="1" >设置耳返音量。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[setVoiceReverbType:](https://write.woa.com/document/87029789200396288)</td>
+
+<td rowspan="1" colSpan="1" >设置人声的混响效果。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[setVoiceChangerType:](https://write.woa.com/document/87029789200396288)</td>
+
+<td rowspan="1" colSpan="1" >设置人声的变声特效。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[setVoiceVolume:](https://write.woa.com/document/87029789200396288)</td>
+
+<td rowspan="1" colSpan="1" >设置语音音量。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[setVoicePitch:](https://write.woa.com/document/87029789200396288)</td>
+
+<td rowspan="1" colSpan="1" >设置语音音调。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[startPlayMusic:onStart:onProgress:onComplete:](https://write.woa.com/document/87029789200396288)</td>
+
+<td rowspan="1" colSpan="1" >开始播放背景音乐。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[stopPlayMusic:](https://write.woa.com/document/87029789200396288)</td>
+
+<td rowspan="1" colSpan="1" >停止播放背景音乐。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[pausePlayMusic:](https://write.woa.com/document/87029789200396288)</td>
+
+<td rowspan="1" colSpan="1" >暂停播放背景音乐。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[resumePlayMusic:](https://write.woa.com/document/87029789200396288)</td>
+
+<td rowspan="1" colSpan="1" >恢复播放背景音乐。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[setAllMusicVolume:](https://write.woa.com/document/87029789200396288)</td>
+
+<td rowspan="1" colSpan="1" >设置所有背景音乐的本地音量和远端音量的大小。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[setMusicPublishVolume:volume:](https://write.woa.com/document/87029789200396288)</td>
+
+<td rowspan="1" colSpan="1" >设置某一首背景音乐的远端音量的大小。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[setMusicPlayoutVolume:volume:](https://write.woa.com/document/87029789200396288)</td>
+
+<td rowspan="1" colSpan="1" >设置某一首背景音乐的本地音量的大小。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[setMusicPitch:pitch:](https://write.woa.com/document/87029789200396288)</td>
+
+<td rowspan="1" colSpan="1" >调整背景音乐的音调高低。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[setMusicSpeedRate:speedRate:](https://write.woa.com/document/87029789200396288)</td>
+
+<td rowspan="1" colSpan="1" >调整背景音乐的变速效果。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[getMusicCurrentPosInMS:](https://write.woa.com/document/87029789200396288)</td>
+
+<td rowspan="1" colSpan="1" >获取背景音乐的播放进度（单位：毫秒）。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[getMusicDurationInMS:](https://write.woa.com/document/87029789200396288)</td>
+
+<td rowspan="1" colSpan="1" >获取背景音乐的总时长（单位：毫秒）。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[seekMusicToPosInMS:pts:](https://write.woa.com/document/87029789200396288)</td>
+
+<td rowspan="1" colSpan="1" >设置背景音乐的播放进度（单位：毫秒）。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[setMusicScratchSpeedRate:speedRate:](https://write.woa.com/document/87029789200396288)</td>
+
+<td rowspan="1" colSpan="1" >调整搓碟的变速效果。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[preloadMusic:onProgress:onError:](https://write.woa.com/document/87029789200396288)</td>
+
+<td rowspan="1" colSpan="1" >预加载背景音乐。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[getMusicTrackCount:](https://write.woa.com/document/87029789200396288)</td>
+
+<td rowspan="1" colSpan="1" >获取背景音乐的音轨数量。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[setMusicTrack:track:](https://write.woa.com/document/87029789200396288)</td>
+
+<td rowspan="1" colSpan="1" >指定背景音乐的播放音轨。</td>
+</tr>
+</table>
+
+
+## 结构体类型
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >函数列表</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[TXAudioMusicParam](https://write.woa.com/document/87029789200396288)</td>
+
+<td rowspan="1" colSpan="1" >背景音乐的播放控制信息</td>
+</tr>
+</table>
+
+
+## 枚举类型
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >枚举类型</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[TXVoiceReverbType](https://write.woa.com/document/87029789200396288)</td>
+
+<td rowspan="1" colSpan="1" >混响特效</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[TXVoiceChangeType](https://write.woa.com/document/87029789200396288)</td>
+
+<td rowspan="1" colSpan="1" >变声特效</td>
+</tr>
+</table>
+
+
+## enableVoiceEarMonitor:
+
+
+
+#### 开启耳返。
+
+主播开启耳返后，可以在耳机里听到麦克风采集到的自己发出的声音，该特效适用于主播唱歌的应用场景中。
+
+
+
+需要您注意的是，由于蓝牙耳机的硬件延迟非常高，所以在主播佩戴蓝牙耳机时无法开启此特效，请尽量在用户界面上提示主播佩戴有线耳机。
+
+同时也需要注意，并非所有的手机开启此特效后都能达到优秀的耳返效果，我们已经对部分耳返效果不佳的手机屏蔽了该特效。
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >参数</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >enable</td>
+
+<td rowspan="1" colSpan="1" >YES：开启；NO：关闭。</td>
+</tr>
+</table>
+
+
+> **注意**
+> 
+
+> 仅在主播佩戴耳机时才能开启此特效，同时请您提示主播佩戴有线耳机。
+> 
+
+
+## setVoiceEarMonitorVolume:
+
+
+
+#### 设置耳返音量。
+
+通过该接口您可以设置耳返特效中声音的音量大小。
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >参数</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >volume</td>
+
+<td rowspan="1" colSpan="1" >音量大小，取值范围为 [0, 150]，默认值：100。</td>
+</tr>
+</table>
+
+
+> **注意**
+> 
+
+> 耳返的音量大小是影响用户耳返体验的重要因素之一，考虑到不同用户对音量的敏感度不同，强烈建议您在 UI 界面上开放耳返音量的调节滑杆，调节范围建议在 0~150 之间，其中 100~150 的增益效果对于部分采集音量较小的 Android 手机很有帮助。
+> 
+
+
+## setVoiceReverbType:
+
+
+
+#### 设置人声的混响效果。
+
+通过该接口您可以设置人声的混响效果，具体特效请参见枚举定义 [TXVoiceReverbType](https://write.woa.com/document/87029789200396288)。
+
+> **注意**
+> 
+
+> 设置的效果在退出房间后会自动失效，如果下次进房还需要对应特效，需要调用此接口再次进行设置。
+> 
+
+
+## setVoiceChangerType:
+
+
+
+#### 设置人声的变声特效。
+
+通过该接口您可以设置人声的变声特效，具体特效请参见枚举定义 [TXVoiceChangeType](https://write.woa.com/document/87029789200396288)。
+
+> **注意**
+> 
+
+> 设置的效果在退出房间后会自动失效，如果下次进房还需要对应特效，需要调用此接口再次进行设置。
+> 
+
+
+## setVoiceVolume:
+
+
+
+#### 设置语音音量。
+
+该接口可以设置语音音量的大小，一般配合音乐音量的设置接口 [setAllMusicVolume](https://write.woa.com/document/87029789200396288) 协同使用，用于调谐语音和音乐在混音前各自的音量占比。
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >参数</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >volume</td>
+
+<td rowspan="1" colSpan="1" >音量大小，取值范围为 [0 - 150]，默认值：100。</td>
+</tr>
+</table>
+
+
+> **注意**
+> 
+
+> 如果将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150，但超过 100 的 volume 会有爆音的风险，请谨慎操作。
+> 
+
+
+## setVoicePitch:
+
+
+
+#### 设置语音音调。
+
+该接口可以设置语音音调，用于实现变调不变速的目的。
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >参数</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >pitch</td>
+
+<td rowspan="1" colSpan="1" >音调，取值范围[-1.0f, 1.0f]，默认值：0.0f。</td>
+</tr>
+</table>
+
+
+## startPlayMusic:onStart:onProgress:onComplete:
+
+
+
+#### 开始播放背景音乐。
+
+每个音乐都需要您指定具体的 ID，您可以通过该 ID 对音乐的开始、停止、音量等进行设置。
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >参数</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >completeBlock</td>
+
+<td rowspan="1" colSpan="1" >播放结束回调。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >musicParam</td>
+
+<td rowspan="1" colSpan="1" >音乐参数。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >progressBlock</td>
+
+<td rowspan="1" colSpan="1" >播放进度回调。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >startBlock</td>
+
+<td rowspan="1" colSpan="1" >播放开始回调。</td>
+</tr>
+</table>
+
+
+> **注意**
+> 
+
+> 1. 如果要多次播放同一首背景音乐，请不要每次播放都分配一个新的 ID，我们推荐使用相同的 ID。
+> 
+
+> 2. 若您希望同时播放多首不同的音乐，请为不同的音乐分配不同的 ID 进行播放。
+> 
+
+> 3. 如果使用同一个 ID 播放不同音乐，SDK 会先停止播放旧的音乐，再播放新的音乐。
+> 
+
+
+## stopPlayMusic:
+
+
+
+#### 停止播放背景音乐。
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >参数</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >id</td>
+
+<td rowspan="1" colSpan="1" >音乐 ID。</td>
+</tr>
+</table>
+
+
+## pausePlayMusic:
+
+
+
+#### 暂停播放背景音乐。
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >参数</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >id</td>
+
+<td rowspan="1" colSpan="1" >音乐 ID。</td>
+</tr>
+</table>
+
+
+## resumePlayMusic:
+
+
+
+#### 恢复播放背景音乐。
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >参数</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >id</td>
+
+<td rowspan="1" colSpan="1" >音乐 ID。</td>
+</tr>
+</table>
+
+
+## setAllMusicVolume:
+
+
+
+#### 设置所有背景音乐的本地音量和远端音量的大小。
+
+该接口可以设置所有背景音乐的本地音量和远端音量。
+-  本地音量：即主播本地可以听到的背景音乐的音量大小。
+
+-  远端音量：即观众端可以听到的背景音乐的音量大小。
+
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >参数</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >volume</td>
+
+<td rowspan="1" colSpan="1" >音量大小，取值范围为 [0, 150]，默认值：60。</td>
+</tr>
+</table>
+
+
+> **注意**
+> 
+
+> 如果将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150，但超过 100 的 volume 会有爆音的风险，请谨慎操作。
+> 
+
+
+## setMusicPublishVolume:volume:
+
+
+
+#### 设置某一首背景音乐的远端音量的大小。
+
+该接口可以细粒度地控制每一首背景音乐的远端音量，也就是观众端可听到的背景音乐的音量大小。
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >参数</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >id</td>
+
+<td rowspan="1" colSpan="1" >音乐 ID。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >volume</td>
+
+<td rowspan="1" colSpan="1" >音量大小，取值范围为 [0, 150]；默认值：60。</td>
+</tr>
+</table>
+
+
+> **注意**
+> 
+
+> 如果将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150，但超过 100 的 volume 会有爆音的风险，请谨慎操作。
+> 
+
+
+## setMusicPlayoutVolume:volume:
+
+
+
+#### 设置某一首背景音乐的本地音量的大小。
+
+该接口可以细粒度地控制每一首背景音乐的本地音量，也就是主播本地可以听到的背景音乐的音量大小。
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >参数</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >id</td>
+
+<td rowspan="1" colSpan="1" >音乐 ID。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >volume</td>
+
+<td rowspan="1" colSpan="1" >音量大小，取值范围为 [0, 150]，默认值：60。</td>
+</tr>
+</table>
+
+
+> **注意**
+> 
+
+> 如果将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150，但超过 100 的 volume 会有爆音的风险，请谨慎操作。
+> 
+
+
+## setMusicPitch:pitch:
+
+
+
+#### 调整背景音乐的音调高低。
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >参数</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >id</td>
+
+<td rowspan="1" colSpan="1" >音乐 ID。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >pitch</td>
+
+<td rowspan="1" colSpan="1" >音调，取值范围为 [-1.0f, 1.0f] 之间的浮点数，默认值：0.0f。</td>
+</tr>
+</table>
+
+
+## setMusicSpeedRate:speedRate:
+
+
+
+#### 调整背景音乐的变速效果。
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >参数</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >id</td>
+
+<td rowspan="1" colSpan="1" >音乐 ID。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >speedRate</td>
+
+<td rowspan="1" colSpan="1" >速度，取值范围为 [0.5f, 2.0f] 之间的浮点数，默认值：1.0f。</td>
+</tr>
+</table>
+
+
+## getMusicCurrentPosInMS:
+
+
+
+#### 获取背景音乐的播放进度（单位：毫秒）。
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >参数</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >id</td>
+
+<td rowspan="1" colSpan="1" >音乐 ID。</td>
+</tr>
+</table>
+
+
+#### 返回值说明：
+
+成功返回当前播放时间，单位：毫秒，失败返回 -1。
+
+## getMusicDurationInMS:
+
+
+
+#### 获取背景音乐的总时长（单位：毫秒）。
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >参数</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >path</td>
+
+<td rowspan="1" colSpan="1" >音乐文件路径。</td>
+</tr>
+</table>
+
+
+#### 返回值说明：
+
+成功返回时长，失败返回 -1。
+
+## seekMusicToPosInMS:pts:
+
+
+
+#### 设置背景音乐的播放进度（单位：毫秒）。
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >参数</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >id</td>
+
+<td rowspan="1" colSpan="1" >音乐 ID。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >pts</td>
+
+<td rowspan="1" colSpan="1" >单位: 毫秒。</td>
+</tr>
+</table>
+
+
+> **注意**
+> 
+
+> 请尽量避免过度频繁地调用该接口，因为该接口可能会再次读写音乐文件，耗时稍高。
+> 
+
+> 因此，当用户拖拽音乐的播放进度条时，请在用户完成拖拽操作后再调用本接口。
+> 
+
+> 因为 UI 上的进度条控件往往会以很高的频率反馈用户的拖拽进度，如不做频率限制，会导致较差的用户体验。
+> 
+
+
+## setMusicScratchSpeedRate:speedRate:
+
+
+
+#### 调整搓碟的变速效果。
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >参数</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >id</td>
+
+<td rowspan="1" colSpan="1" >音乐 ID。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >scratchSpeedRate</td>
+
+<td rowspan="1" colSpan="1" >搓碟速度，取值范围为 [-12.0, 12.0] 之间的浮点数，默认值是 1.0f，速度值正/负表示方向正/反，绝对值大小表示速度快慢。</td>
+</tr>
+</table>
+
+
+> **注意**
+> 
+
+> 前置条件 preloadMusic 成功。
+> 
+
+
+## preloadMusic:onProgress:onError:
+
+
+
+#### 预加载背景音乐。
+
+每个音乐都需要您指定具体的 ID，您可以通过该 ID 对音乐的开始、停止、音量等进行设置。
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >参数</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >preloadParam</td>
+
+<td rowspan="1" colSpan="1" >预加载音乐参数。</td>
+</tr>
+</table>
+
+
+> **注意**
+> 
+
+> 1. 预先加载最多同时支持2个不同 ID 的预加载，且预加载时长不超过10分钟，使用完需调用 [stopPlayMusic](https://write.woa.com/document/87029789200396288)，否则内存不释放。
+> 
+
+> 2. 若该ID对应的音乐正在播放中，预加载会失败，需先调用 [stopPlayMusic](https://write.woa.com/document/87029789200396288)。
+> 
+
+> 3. 当 ` musicParam ` 和传入 [startPlayMusic](https://write.woa.com/document/87029789200396288) 的 ` musicParam ` 完全相同时，预加载有效。
+> 
+
+
+## getMusicTrackCount:
+
+
+
+#### 获取背景音乐的音轨数量。
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >参数</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >id</td>
+
+<td rowspan="1" colSpan="1" >音乐 ID。</td>
+</tr>
+</table>
+
+
+## setMusicTrack:track:
+
+
+
+#### 指定背景音乐的播放音轨。
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >参数</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >id</td>
+
+<td rowspan="1" colSpan="1" >音乐 ID。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >index</td>
+
+<td rowspan="1" colSpan="1" >默认播放第一个音轨。取值范围[0, 音轨总数)。</td>
+</tr>
+</table>
+
+
+> **注意**
+> 
+
+> 音轨总数量可通过 getMusicTrackCount 接口获取。
+> 
+
+
+## TXVoiceReverbType
+
+
+
+#### 混响特效
+
+混响特效可以作用于人声之上，通过声学算法对声音进行叠加处理，模拟出各种不同环境下的临场感受，目前支持如下几种混响效果：
+
+0：关闭；1：KTV；2：小房间；3：大会堂；4：低沉；5：洪亮；6：金属声；7：磁性；8：空灵；9：录音棚；10：悠扬 11：录音棚2。
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >枚举</td>
+
+<td rowspan="1" colSpan="1" >取值</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >TXVoiceReverbType_0</td>
+
+<td rowspan="1" colSpan="1" >0</td>
+
+<td rowspan="1" colSpan="1" >关闭特效</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >TXVoiceReverbType_1</td>
+
+<td rowspan="1" colSpan="1" >1</td>
+
+<td rowspan="1" colSpan="1" >KTV</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >TXVoiceReverbType_2</td>
+
+<td rowspan="1" colSpan="1" >2</td>
+
+<td rowspan="1" colSpan="1" >小房间</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >TXVoiceReverbType_3</td>
+
+<td rowspan="1" colSpan="1" >3</td>
+
+<td rowspan="1" colSpan="1" >大会堂</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >TXVoiceReverbType_4</td>
+
+<td rowspan="1" colSpan="1" >4</td>
+
+<td rowspan="1" colSpan="1" >低沉</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >TXVoiceReverbType_5</td>
+
+<td rowspan="1" colSpan="1" >5</td>
+
+<td rowspan="1" colSpan="1" >洪亮</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >TXVoiceReverbType_6</td>
+
+<td rowspan="1" colSpan="1" >6</td>
+
+<td rowspan="1" colSpan="1" >金属声</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >TXVoiceReverbType_7</td>
+
+<td rowspan="1" colSpan="1" >7</td>
+
+<td rowspan="1" colSpan="1" >磁性</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >TXVoiceReverbType_8</td>
+
+<td rowspan="1" colSpan="1" >8</td>
+
+<td rowspan="1" colSpan="1" >空灵</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >TXVoiceReverbType_9</td>
+
+<td rowspan="1" colSpan="1" >9</td>
+
+<td rowspan="1" colSpan="1" >录音棚</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >TXVoiceReverbType_10</td>
+
+<td rowspan="1" colSpan="1" >10</td>
+
+<td rowspan="1" colSpan="1" >悠扬</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >TXVoiceReverbType_11</td>
+
+<td rowspan="1" colSpan="1" >11</td>
+
+<td rowspan="1" colSpan="1" >录音棚2</td>
+</tr>
+</table>
+
+
+## TXVoiceChangeType
+
+
+
+#### 变声特效
+
+变声特效可以作用于人声之上，通过声学算法对人声进行二次处理，以获得与原始声音所不同的音色，目前支持如下几种变声特效：
+
+0：关闭；1：熊孩子；2：萝莉；3：大叔；4：重金属；5：感冒；6：外语腔；7：困兽；8：肥宅；9：强电流；10：重机械；11：空灵；12：猪八戒；13：绿巨人。
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >枚举</td>
+
+<td rowspan="1" colSpan="1" >取值</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >TXVoiceChangeType_0</td>
+
+<td rowspan="1" colSpan="1" >0</td>
+
+<td rowspan="1" colSpan="1" >关闭</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >TXVoiceChangeType_1</td>
+
+<td rowspan="1" colSpan="1" >1</td>
+
+<td rowspan="1" colSpan="1" >熊孩子</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >TXVoiceChangeType_2</td>
+
+<td rowspan="1" colSpan="1" >2</td>
+
+<td rowspan="1" colSpan="1" >萝莉</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >TXVoiceChangeType_3</td>
+
+<td rowspan="1" colSpan="1" >3</td>
+
+<td rowspan="1" colSpan="1" >大叔</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >TXVoiceChangeType_4</td>
+
+<td rowspan="1" colSpan="1" >4</td>
+
+<td rowspan="1" colSpan="1" >重金属</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >TXVoiceChangeType_5</td>
+
+<td rowspan="1" colSpan="1" >5</td>
+
+<td rowspan="1" colSpan="1" >感冒</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >TXVoiceChangeType_6</td>
+
+<td rowspan="1" colSpan="1" >6</td>
+
+<td rowspan="1" colSpan="1" >外语腔</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >TXVoiceChangeType_7</td>
+
+<td rowspan="1" colSpan="1" >7</td>
+
+<td rowspan="1" colSpan="1" >困兽</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >TXVoiceChangeType_8</td>
+
+<td rowspan="1" colSpan="1" >8</td>
+
+<td rowspan="1" colSpan="1" >肥宅</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >TXVoiceChangeType_9</td>
+
+<td rowspan="1" colSpan="1" >9</td>
+
+<td rowspan="1" colSpan="1" >强电流</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >TXVoiceChangeType_10</td>
+
+<td rowspan="1" colSpan="1" >10</td>
+
+<td rowspan="1" colSpan="1" >重机械</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >TXVoiceChangeType_11</td>
+
+<td rowspan="1" colSpan="1" >11</td>
+
+<td rowspan="1" colSpan="1" >空灵</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >TXVoiceChangeType_12</td>
+
+<td rowspan="1" colSpan="1" >12</td>
+
+<td rowspan="1" colSpan="1" >猪八戒</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >TXVoiceChangeType_13</td>
+
+<td rowspan="1" colSpan="1" >13</td>
+
+<td rowspan="1" colSpan="1" >绿巨人</td>
+</tr>
+</table>
+
+
+## TXAudioMusicParam
+
+
+
+#### 背景音乐的播放控制信息
+
+该信息用于在接口 [startPlayMusic](https://write.woa.com/document/87029789200396288) 中指定背景音乐的相关信息，包括播放 ID、文件路径和循环次数等：
+
+1. 如果要多次播放同一首背景音乐，请不要每次播放都分配一个新的 ID，我们推荐使用相同的 ID。
+
+2. 若您希望同时播放多首不同的音乐，请为不同的音乐分配不同的 ID 进行播放。
+
+3. 如果使用同一个 ID 播放不同音乐，SDK 会先停止播放旧的音乐，再播放新的音乐。
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >枚举类型</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >ID</td>
+
+<td rowspan="1" colSpan="1" >【字段含义】音乐 ID。<br>【特殊说明】SDK 允许播放多路音乐，因此需要使用 ID 进行标记，用于控制音乐的开始、停止、音量等。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >endTimeMS</td>
+
+<td rowspan="1" colSpan="1" >【字段含义】音乐结束播放时间点，单位毫秒，0表示播放至文件结尾。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >isShortFile</td>
+
+<td rowspan="1" colSpan="1" >【字段含义】播放的是否为短音乐文件。<br>【推荐取值】YES：需要重复播放的短音乐文件；NO：正常的音乐文件。默认值：NO。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >loopCount</td>
+
+<td rowspan="1" colSpan="1" >【字段含义】音乐循环播放的次数。<br>【推荐取值】取值范围为 [0, 任意正整数]，默认值：0。0 表示播放音乐一次；1 表示播放音乐两次；以此类推。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >path</td>
+
+<td rowspan="1" colSpan="1" >【字段含义】音效文件的完整路径或 URL 地址。支持的音频格式包括 MP3、AAC、M4A、WAV。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >publish</td>
+
+<td rowspan="1" colSpan="1" >【字段含义】是否将音乐传到远端。<br>【推荐取值】YES：音乐在本地播放的同时，远端用户也能听到该音乐；NO：主播只能在本地听到该音乐，远端观众听不到。默认值：NO。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >startTimeMS</td>
+
+<td rowspan="1" colSpan="1" >【字段含义】音乐开始播放时间点，单位：毫秒。</td>
+</tr>
+</table>