@tencentcloud/sdk-mcp 1.4.7 → 1.6.0-beta.1

package/resource/{doc → knowledge}/trtc/android/TXAudioEffectManager.md

@@ -1,98 +1,107 @@
-# 腾讯云实时音视频(TRTC SDK )文档
+Copyright (c) 2021 Tencent. All rights reserved.
 
-## 概述
-`TXAudioEffectManager.java` 是腾讯云实时音视频(TRTC SDK ) Android 平台的背景音乐、短音效和人声特效的管理类文档，用于对背景音乐、短音效和人声特效进行设置的管理类。
+Module:   背景音乐、短音效和人声特效的管理类
+
+Function: 用于对背景音乐、短音效和人声特效进行设置的管理类
 
 ## TXMusicPreloadObserver
-| 函数列表 | 描述 |
-| --- | --- |
-| onLoadProgress | 背景音乐预加载进度 |
-| onLoadError | 背景音乐预加载出错 |
+
+|函数列表|描述|
+|---------|---------|
+|onLoadProgress|背景音乐预加载进度|
+|onLoadError|背景音乐预加载出错|
 
 ## TXMusicPlayObserver
-| 函数列表 | 描述 |
-| --- | --- |
-| onStart | 背景音乐开始播放 |
-| onPlayProgress | 背景音乐的播放进度 |
-| onComplete | 背景音乐已经播放完毕 |
+
+|函数列表|描述|
+|---------|---------|
+|onStart|背景音乐开始播放|
+|onPlayProgress|背景音乐的播放进度|
+|onComplete|背景音乐已经播放完毕|
 
 ## TXAudioEffectManager
-| 函数列表 | 描述 |
-| --- | --- |
-| enableVoiceEarMonitor | 开启耳返 |
-| setVoiceEarMonitorVolume | 设置耳返音量。 |
-| setVoiceReverbType | 设置人声的混响效果。 |
-| setVoiceChangerType | 设置人声的变声特效。 |
-| setVoiceCaptureVolume | 设置语音音量。 |
-| setVoicePitch | 设置语音音调。 |
-| setMusicObserver | 设置背景音乐的事件回调接口。 |
-| startPlayMusic | 开始播放背景音乐。 |
-| stopPlayMusic | 停止播放背景音乐。 |
-| pausePlayMusic | 暂停播放背景音乐。 |
-| resumePlayMusic | 恢复播放背景音乐。 |
-| setAllMusicVolume | 设置所有背景音乐的本地音量和远端音量的大小。 |
-| setMusicPublishVolume | 设置某一首背景音乐的远端音量的大小。 |
-| setMusicPlayoutVolume | 设置某一首背景音乐的本地音量的大小。 |
-| setMusicPitch | 调整背景音乐的音调高低。 |
-| setMusicSpeedRate | 调整背景音乐的变速效果。 |
-| getMusicCurrentPosInMS | 获取背景音乐的播放进度（单位：毫秒）。 |
-| getMusicDurationInMS | 获取背景音乐的总时长（单位：毫秒）。 |
-| seekMusicToPosInMS | 设置背景音乐的播放进度（单位：毫秒）。 |
-| setMusicScratchSpeedRate | 调整搓碟的变速效果。 |
-| setPreloadObserver | 设置预加载事件回调。 |
-| preloadMusic | 预加载背景音乐。 |
-| getMusicTrackCount | 获取背景音乐的音轨数量。 |
-| setMusicTrack | 指定背景音乐的播放音轨。 |
+
+|函数列表|描述|
+|---------|---------|
+|enableVoiceEarMonitor|开启耳返|
+|setVoiceEarMonitorVolume|设置耳返音量。|
+|setVoiceReverbType|设置人声的混响效果。|
+|setVoiceChangerType|设置人声的变声特效。|
+|setVoiceCaptureVolume|设置语音音量。|
+|setVoicePitch|设置语音音调。|
+|setMusicObserver|设置背景音乐的事件回调接口。|
+|startPlayMusic|开始播放背景音乐。|
+|stopPlayMusic|停止播放背景音乐。|
+|pausePlayMusic|暂停播放背景音乐。|
+|resumePlayMusic|恢复播放背景音乐。|
+|setAllMusicVolume|设置所有背景音乐的本地音量和远端音量的大小。|
+|setMusicPublishVolume|设置某一首背景音乐的远端音量的大小。|
+|setMusicPlayoutVolume|设置某一首背景音乐的本地音量的大小。|
+|setMusicPitch|调整背景音乐的音调高低。|
+|setMusicSpeedRate|调整背景音乐的变速效果。|
+|getMusicCurrentPosInMS|获取背景音乐的播放进度（单位：毫秒）。|
+|getMusicDurationInMS|获取背景音乐的总时长（单位：毫秒）。|
+|seekMusicToPosInMS|设置背景音乐的播放进度（单位：毫秒）。|
+|setMusicScratchSpeedRate|调整搓碟的变速效果。|
+|setPreloadObserver|设置预加载事件回调。|
+|preloadMusic|预加载背景音乐。|
+|getMusicTrackCount|获取背景音乐的音轨数量。|
+|setMusicTrack|指定背景音乐的播放音轨。|
 
 ## 结构体类型
-| 函数列表 | 描述 |
-| --- | --- |
-| AudioMusicParam | 背景音乐的播放控制信息 |
+
+|函数列表|描述|
+|---------|---------|
+|AudioMusicParam|背景音乐的播放控制信息|
 
 ## 枚举类型
-| 枚举类型 | 描述 |
-| --- | --- |
-| TXVoiceReverbType | 混响特效 |
-| TXVoiceChangerType | 变声特效 |
+
+|枚举类型|描述|
+|---------|---------|
+|TXVoiceReverbType|混响特效|
+|TXVoiceChangerType|变声特效|
 
 ## onLoadProgress
 
-#### 背景音乐预加载进度
+**背景音乐预加载进度**
 
 ## onLoadError
 
-#### 背景音乐预加载出错
-| 参数 | 描述 |
-| --- | --- |
-| errorCode | -4001:打开文件失败，如音频数据无效，FFMPEG 协议未找到等；-4002:解码失败，如音频文件损坏，网络音频文件服务器无法访问等；-4003:预加载数量超上限，请先调用 stopPlayMusic 释放无用的预加载；-4005:非法路径导致打开文件失败，请检查您传入的路径参数是否指向一个合法的音乐文件；-4006:非法URL导致打开文件失败，请用浏览器检查您传入的 URL 地址是否可以下载到期望的音乐文件；-4007:无音频流导致打开文件失败，请确认您传入的文件是否是合法的音频文件，以及文件是否被损坏；-4008:格式不支持导致打开文件失败，请确认您传入的文件格式是否是支持的文件格式，移动端支持【mp3，aac，m4a，wav，ogg，mp4，mkv】，桌面端支持 【mp3，aac，m4a，wav，mp4，mkv】。 |
+**背景音乐预加载出错**
+
+|参数|描述|
+|---------|---------|
+|errorCode|-4001:打开文件失败，如音频数据无效，FFMPEG 协议未找到等；-4002:解码失败，如音频文件损坏，网络音频文件服务器无法访问等；-4003:预加载数量超上限，请先调用 stopPlayMusic 释放无用的预加载；-4005:非法路径导致打开文件失败，请检查您传入的路径参数是否指向一个合法的音乐文件；-4006:非法URL导致打开文件失败，请用浏览器检查您传入的 URL 地址是否可以下载到期望的音乐文件；-4007:无音频流导致打开文件失败，请确认您传入的文件是否是合法的音频文件，以及文件是否被损坏；-4008:格式不支持导致打开文件失败，请确认您传入的文件格式是否是支持的文件格式，移动端支持【mp3，aac，m4a，wav，ogg，mp4，mkv】，桌面端支持 【mp3，aac，m4a，wav，mp4，mkv】。|
 
 ## onStart
 
-#### 背景音乐开始播放
+**背景音乐开始播放**
 
 在背景音乐开始播放成功或者失败时调用。
-| 参数 | 描述 |
-| --- | --- |
-| errCode | 错误码。0: 开始播放成功；-4001:打开文件失败，如音频数据无效，FFMPEG 协议未找到等；-4005:非法路径导致打开文件失败，请检查您传入的路径参数是否指向一个合法的音乐文件；-4006:非法URL导致打开文件失败，请用浏览器检查您传入的 URL 地址是否可以下载到期望的音乐文件，如果操作系统为 iOS 或 MacOS 请确保使用 https 链接；-4007:无音频流导致打开文件失败，请确认您传入的文件是否是合法的音频文件，以及文件是否被损坏；-4008:格式不支持导致打开文件失败，请确认您传入的文件格式是否是支持的文件格式，移动端支持【mp3，aac，m4a，wav，ogg，mp4，mkv】，桌面端支持 【mp3，aac，m4a，wav，mp4，mkv】；-4009:同时播放 bgm 数量超过限定值，如当前同时播放 bgm 数量超过 10 后提示该错误，请检查并发播放 bgm 数量。 |
-| id | 音乐 ID。 |
+
+|参数|描述|
+|---------|---------|
+|errCode|错误码。0: 开始播放成功；-4001:打开文件失败，如音频数据无效，FFMPEG 协议未找到等；-4005:非法路径导致打开文件失败，请检查您传入的路径参数是否指向一个合法的音乐文件；-4006:非法URL导致打开文件失败，请用浏览器检查您传入的 URL 地址是否可以下载到期望的音乐文件，如果操作系统为 iOS 或 MacOS 请确保使用 https 链接；-4007:无音频流导致打开文件失败，请确认您传入的文件是否是合法的音频文件，以及文件是否被损坏；-4008:格式不支持导致打开文件失败，请确认您传入的文件格式是否是支持的文件格式，移动端支持【mp3，aac，m4a，wav，ogg，mp4，mkv】，桌面端支持 【mp3，aac，m4a，wav，mp4，mkv】；-4009:同时播放 bgm 数量超过限定值，如当前同时播放 bgm 数量超过 10 后提示该错误，请检查并发播放 bgm 数量。|
+|id|音乐 ID。|
 
 ## onPlayProgress
 
-#### 背景音乐的播放进度
+**背景音乐的播放进度**
 
 ## onComplete
 
-#### 背景音乐已经播放完毕
+**背景音乐已经播放完毕**
 
 在背景音乐播放完毕或播放错误时调用。
-| 参数 | 描述 |
-| --- | --- |
-| errCode | 错误码。0: 播放结束；-4002: 解码失败，如音频文件损坏，网络音频文件服务器无法访问等。 |
-| id | 音乐 ID。 |
+
+|参数|描述|
+|---------|---------|
+|errCode|错误码。0: 播放结束；-4002: 解码失败，如音频文件损坏，网络音频文件服务器无法访问等。|
+|id|音乐 ID。|
 
 ## enableVoiceEarMonitor
 
-#### 开启耳返
+**开启耳返**
 
 主播开启耳返后，可以在耳机里听到麦克风采集到的自己发出的声音，该特效适用于主播唱歌的应用场景中。
 
@@ -104,7 +113,7 @@
 
 **OPPO**
 
-在 12.6 及其以上的版本，使用 OPPO 硬件耳返的客户需要在 [OPPO 开放平台](https://open.oppomobile.com/new/developmentDoc/info?id=10889) 中申请开通耳返的授权码，将自己应用的授权码配置到 ` AndroidManifest.xml ` 中。
+在 12.6 及其以上的版本，使用 OPPO 硬件耳返的客户需要在 [OPPO 开放平台](https://open.oppomobile.com/new/developmentDoc/info) 中申请开通耳返的授权码，将自己应用的授权码配置到 ` AndroidManifest.xml ` 中。
 ``` java
 <meta-data
     android:name="com.coloros.ocs.media.AUTH_CODE"
@@ -129,9 +138,10 @@
 **VIVO**
 
 部分 VIVO 手机在使用 USB 数字耳机的时候，会出现硬件耳返无声的问题，这里可以将耳机更换为 3.5mm 的圆孔耳机来进行体验，目前 VIVO 厂商没有对 USB 的耳机全部适配，建议首选 VIVO 品牌的耳机进行 K 歌体验。
-| 参数 | 描述 |
-| --- | --- |
-| enable | true：开启；false：关闭。 |
+
+|参数|描述|
+|---------|---------|
+|enable|true：开启；false：关闭。|
 
 > **注意**
 >
@@ -141,12 +151,13 @@
 
 ## setVoiceEarMonitorVolume
 
-#### 设置耳返音量。
+**设置耳返音量。**
 
 通过该接口您可以设置耳返特效中声音的音量大小。
-| 参数 | 描述 |
-| --- | --- |
-| volume | 音量大小，取值范围为 [0, 150]，默认值：100。 |
+
+|参数|描述|
+|---------|---------|
+|volume|音量大小，取值范围为 [0, 150]，默认值：100。|
 
 > **注意**
 >
@@ -156,7 +167,7 @@
 
 ## setVoiceReverbType
 
-#### 设置人声的混响效果。
+**设置人声的混响效果。**
 
 通过该接口您可以设置人声的混响效果，具体特效请参见枚举定义 TXVoiceReverbType。
 
@@ -168,7 +179,7 @@
 
 ## setVoiceChangerType
 
-#### 设置人声的变声特效。
+**设置人声的变声特效。**
 
 通过该接口您可以设置人声的变声特效，具体特效请参见枚举定义 TXVoiceChangeType。
 
@@ -180,12 +191,13 @@
 
 ## setVoiceCaptureVolume
 
-#### 设置语音音量。
+**设置语音音量。**
 
 该接口可以设置语音音量的大小，一般配合音乐音量的设置接口 setAllMusicVolume 协同使用，用于调谐语音和音乐在混音前各自的音量占比。
-| 参数 | 描述 |
-| --- | --- |
-| volume | 音量大小，取值范围为 [0 - 150]，默认值：100。 |
+
+|参数|描述|
+|---------|---------|
+|volume|音量大小，取值范围为 [0 - 150]，默认值：100。|
 
 > **注意**
 >
@@ -195,22 +207,24 @@
 
 ## setVoicePitch
 
-#### 设置语音音调。
+**设置语音音调。**
 
 该接口可以设置语音音调，用于实现变调不变速的目的。
-| 参数 | 描述 |
-| --- | --- |
-| pitch | 音调，取值范围[-1.0f, 1.0f]，默认值：0.0f。 |
+
+|参数|描述|
+|---------|---------|
+|pitch|音调，取值范围[-1.0f, 1.0f]，默认值：0.0f。|
 
 ## setMusicObserver
 
-#### 设置背景音乐的事件回调接口。
+**设置背景音乐的事件回调接口。**
 
 请在播放背景音乐之前使用该接口设置播放事件回调，以便感知背景音乐的播放进度。
-| 参数 | 描述 |
-| --- | --- |
-| musicId | 音乐 ID。 |
-| observer | 具体参考 TXMusicPlayObserver 中定义接口。 |
+
+|参数|描述|
+|---------|---------|
+|musicId|音乐 ID。|
+|observer|具体参考 TXMusicPlayObserver 中定义接口。|
 
 > **注意**
 >
@@ -220,12 +234,13 @@
 
 ## startPlayMusic
 
-#### 开始播放背景音乐。
+**开始播放背景音乐。**
 
 每个音乐都需要您指定具体的 ID，您可以通过该 ID 对音乐的开始、停止、音量等进行设置。
-| 参数 | 描述 |
-| --- | --- |
-| musicParam | 音乐参数。 |
+
+|参数|描述|
+|---------|---------|
+|musicParam|音乐参数。|
 
 > **注意**
 >
@@ -241,37 +256,40 @@
 
 ## stopPlayMusic
 
-#### 停止播放背景音乐。
-| 参数 | 描述 |
-| --- | --- |
-| id | 音乐 ID。 |
+**停止播放背景音乐。**
+
+|参数|描述|
+|---------|---------|
+|id|音乐 ID。|
 
 ## pausePlayMusic
 
-#### 暂停播放背景音乐。
-| 参数 | 描述 |
-| --- | --- |
-| id | 音乐 ID。 |
+**暂停播放背景音乐。**
+
+|参数|描述|
+|---------|---------|
+|id|音乐 ID。|
 
 ## resumePlayMusic
 
-#### 恢复播放背景音乐。
-| 参数 | 描述 |
-| --- | --- |
-| id | 音乐 ID。 |
+**恢复播放背景音乐。**
+
+|参数|描述|
+|---------|---------|
+|id|音乐 ID。|
 
 ## setAllMusicVolume
 
-#### 设置所有背景音乐的本地音量和远端音量的大小。
+**设置所有背景音乐的本地音量和远端音量的大小。**
 
 该接口可以设置所有背景音乐的本地音量和远端音量。
 -  本地音量：即主播本地可以听到的背景音乐的音量大小。
 
 -  远端音量：即观众端可以听到的背景音乐的音量大小。
 
-| 参数 | 描述 |
-| --- | --- |
-| volume | 音量大小，取值范围为 [0, 150]，默认值：60。 |
+|参数|描述|
+|---------|---------|
+|volume|音量大小，取值范围为 [0, 150]，默认值：60。|
 
 > **注意**
 >
@@ -281,13 +299,14 @@
 
 ## setMusicPublishVolume
 
-#### 设置某一首背景音乐的远端音量的大小。
+**设置某一首背景音乐的远端音量的大小。**
 
 该接口可以细粒度地控制每一首背景音乐的远端音量，也就是观众端可听到的背景音乐的音量大小。
-| 参数 | 描述 |
-| --- | --- |
-| id | 音乐 ID。 |
-| volume | 音量大小，取值范围为 [0, 150]；默认值：60。 |
+
+|参数|描述|
+|---------|---------|
+|id|音乐 ID。|
+|volume|音量大小，取值范围为 [0, 150]；默认值：60。|
 
 > **注意**
 >
@@ -297,13 +316,14 @@
 
 ## setMusicPlayoutVolume
 
-#### 设置某一首背景音乐的本地音量的大小。
+**设置某一首背景音乐的本地音量的大小。**
 
 该接口可以细粒度地控制每一首背景音乐的本地音量，也就是主播本地可以听到的背景音乐的音量大小。
-| 参数 | 描述 |
-| --- | --- |
-| id | 音乐 ID。 |
-| volume | 音量大小，取值范围为 [0, 150]，默认值：60。 |
+
+|参数|描述|
+|---------|---------|
+|id|音乐 ID。|
+|volume|音量大小，取值范围为 [0, 150]，默认值：60。|
 
 > **注意**
 >
@@ -313,49 +333,52 @@
 
 ## setMusicPitch
 
-#### 调整背景音乐的音调高低。
-| 参数 | 描述 |
-| --- | --- |
-| id | 音乐 ID。 |
-| pitch | 音调，取值范围为 [-1.0f, 1.0f] 之间的浮点数，默认值：0.0f。 |
+**调整背景音乐的音调高低。**
+
+|参数|描述|
+|---------|---------|
+|id|音乐 ID。|
+|pitch|音调，取值范围为 [-1.0f, 1.0f] 之间的浮点数，默认值：0.0f。|
 
 ## setMusicSpeedRate
 
-#### 调整背景音乐的变速效果。
-| 参数 | 描述 |
-| --- | --- |
-| id | 音乐 ID。 |
-| speedRate | 速度，取值范围为 [0.5f, 2.0f] 之间的浮点数，默认值：1.0f。 |
+**调整背景音乐的变速效果。**
+
+|参数|描述|
+|---------|---------|
+|id|音乐 ID。|
+|speedRate|速度，取值范围为 [0.5f, 2.0f] 之间的浮点数，默认值：1.0f。|
 
 ## getMusicCurrentPosInMS
 
-#### 获取背景音乐的播放进度（单位：毫秒）。
-| 参数 | 描述 |
-| --- | --- |
-| id | 音乐 ID。 |
+**获取背景音乐的播放进度（单位：毫秒）。**
 
-#### 返回值说明：
+|参数|描述|
+|---------|---------|
+|id|音乐 ID。|
+**返回值说明：**
 
 成功返回当前播放时间，单位：毫秒，失败返回 -1。
 
 ## getMusicDurationInMS
 
-#### 获取背景音乐的总时长（单位：毫秒）。
-| 参数 | 描述 |
-| --- | --- |
-| path | 音乐文件路径。 |
+**获取背景音乐的总时长（单位：毫秒）。**
 
-#### 返回值说明：
+|参数|描述|
+|---------|---------|
+|path|音乐文件路径。|
+**返回值说明：**
 
 成功返回时长，失败返回 -1。
 
 ## seekMusicToPosInMS
 
-#### 设置背景音乐的播放进度（单位：毫秒）。
-| 参数 | 描述 |
-| --- | --- |
-| id | 音乐 ID。 |
-| pts | 单位: 毫秒。 |
+**设置背景音乐的播放进度（单位：毫秒）。**
+
+|参数|描述|
+|---------|---------|
+|id|音乐 ID。|
+|pts|单位: 毫秒。|
 
 > **注意**
 >
@@ -371,11 +394,12 @@
 
 ## setMusicScratchSpeedRate
 
-#### 调整搓碟的变速效果。
-| 参数 | 描述 |
-| --- | --- |
-| id | 音乐 ID。 |
-| scratchSpeedRate | 搓碟速度，取值范围为 [-12.0, 12.0] 之间的浮点数，默认值是 1.0f，速度值正/负表示方向正/反，绝对值大小表示速度快慢。 |
+**调整搓碟的变速效果。**
+
+|参数|描述|
+|---------|---------|
+|id|音乐 ID。|
+|scratchSpeedRate|搓碟速度，取值范围为 [-12.0, 12.0] 之间的浮点数，默认值是 1.0f，速度值正/负表示方向正/反，绝对值大小表示速度快慢。|
 
 > **注意**
 >
@@ -385,21 +409,23 @@
 
 ## setPreloadObserver
 
-#### 设置预加载事件回调。
+**设置预加载事件回调。**
 
 请在预加载背景音乐之前使用该接口设置回调，以便感知背景音乐的预加载进度。
-| 参数 | 描述 |
-| --- | --- |
-| observer | 具体参考 TXMusicPreloadObserver 中定义接口。 |
+
+|参数|描述|
+|---------|---------|
+|observer|具体参考 TXMusicPreloadObserver 中定义接口。|
 
 ## preloadMusic
 
-#### 预加载背景音乐。
+**预加载背景音乐。**
 
 每个音乐都需要您指定具体的 ID，您可以通过该 ID 对音乐的开始、停止、音量等进行设置。
-| 参数 | 描述 |
-| --- | --- |
-| preloadParam | 预加载音乐参数。 |
+
+|参数|描述|
+|---------|---------|
+|preloadParam|预加载音乐参数。|
 
 > **注意**
 >
@@ -415,18 +441,20 @@
 
 ## getMusicTrackCount
 
-#### 获取背景音乐的音轨数量。
-| 参数 | 描述 |
-| --- | --- |
-| id | 音乐 ID。 |
+**获取背景音乐的音轨数量。**
+
+|参数|描述|
+|---------|---------|
+|id|音乐 ID。|
 
 ## setMusicTrack
 
-#### 指定背景音乐的播放音轨。
-| 参数 | 描述 |
-| --- | --- |
-| id | 音乐 ID。 |
-| index | 默认播放第一个音轨。取值范围0, 音轨总数)。 |
+**指定背景音乐的播放音轨。**
+
+|参数|描述|
+|---------|---------|
+|id|音乐 ID。|
+|index|默认播放第一个音轨。取值范围0, 音轨总数)。|
 
 > **注意**
 >
@@ -436,53 +464,55 @@
 
 ## TXVoiceReverbType
 
-#### 混响特效
+**混响特效**
 
 混响特效可以作用于人声之上，通过声学算法对声音进行叠加处理，模拟出各种不同环境下的临场感受，目前支持如下几种混响效果：
 
-0：关闭；1：KTV；2：小房间；3：大会堂；4：低沉；5：洪亮；6：金属声；7：磁性；8：空灵；9：录音棚；10：悠扬 11：录音棚2。
-| 枚举 | 取值 | 描述 |
-| --- | --- | --- |
-| TXLiveVoiceReverbType_0 | 0 | 关闭特效 |
-| TXLiveVoiceReverbType_1 | 1 | KTV |
-| TXLiveVoiceReverbType_2 | 2 | 小房间 |
-| TXLiveVoiceReverbType_3 | 3 | 大会堂 |
-| TXLiveVoiceReverbType_4 | 4 | 低沉 |
-| TXLiveVoiceReverbType_5 | 5 | 洪亮 |
-| TXLiveVoiceReverbType_6 | 6 | 金属声 |
-| TXLiveVoiceReverbType_7 | 7 | 磁性 |
-| TXLiveVoiceReverbType_8 | 8 | 空灵 |
-| TXLiveVoiceReverbType_9 | 9 | 录音棚 |
-| TXLiveVoiceReverbType_10 | 10 | 悠扬 |
-| TXLiveVoiceReverbType_11 | 11 | 录音棚2 |
+0：关闭；1：KTV；2：小房间；3：大会堂；4：低沉；5：洪亮；6：金属声；7：磁性；8：空灵；9：录音棚；10：悠扬；11：录音棚2；
+
+|枚举|取值|描述|
+|---------|---------|---------|
+|TXLiveVoiceReverbType_0|0|关闭特效|
+|TXLiveVoiceReverbType_1|1|KTV|
+|TXLiveVoiceReverbType_2|2|小房间|
+|TXLiveVoiceReverbType_3|3|大会堂|
+|TXLiveVoiceReverbType_4|4|低沉|
+|TXLiveVoiceReverbType_5|5|洪亮|
+|TXLiveVoiceReverbType_6|6|金属声|
+|TXLiveVoiceReverbType_7|7|磁性|
+|TXLiveVoiceReverbType_8|8|空灵|
+|TXLiveVoiceReverbType_9|9|录音棚|
+|TXLiveVoiceReverbType_10|10|悠扬|
+|TXLiveVoiceReverbType_11|11|录音棚2|
 
 ## TXVoiceChangeType
 
-#### 变声特效
+**变声特效**
 
 变声特效可以作用于人声之上，通过声学算法对人声进行二次处理，以获得与原始声音所不同的音色，目前支持如下几种变声特效：
 
-0：关闭；1：熊孩子；2：萝莉；3：大叔；4：重金属；5：感冒；6：外语腔；7：困兽；8：肥宅；9：强电流；10：重机械；11：空灵；12：猪八戒；13：绿巨人。
-| 枚举 | 取值 | 描述 |
-| --- | --- | --- |
-| TXLiveVoiceChangerType_0 | 0 | 关闭 |
-| TXLiveVoiceChangerType_1 | 1 | 熊孩子 |
-| TXLiveVoiceChangerType_2 | 2 | 萝莉 |
-| TXLiveVoiceChangerType_3 | 3 | 大叔 |
-| TXLiveVoiceChangerType_4 | 4 | 重金属 |
-| TXLiveVoiceChangerType_5 | 5 | 感冒 |
-| TXLiveVoiceChangerType_6 | 6 | 外语腔 |
-| TXLiveVoiceChangerType_7 | 7 | 困兽 |
-| TXLiveVoiceChangerType_8 | 8 | 肥宅 |
-| TXLiveVoiceChangerType_9 | 9 | 强电流 |
-| TXLiveVoiceChangerType_10 | 10 | 重机械 |
-| TXLiveVoiceChangerType_11 | 11 | 空灵 |
-| TXLiveVoiceChangerType_12 | 12 | 猪八戒 |
-| TXLiveVoiceChangerType_13 | 13 | 绿巨人 |
+0：关闭；1：熊孩子；2：萝莉；3：大叔；4：重金属；5：感冒；6：外语腔；7：困兽；8：肥宅；9：强电流；10：重机械；11：空灵；12：猪八戒；13：绿巨人；
+
+|枚举|取值|描述|
+|---------|---------|---------|
+|TXLiveVoiceChangerType_0|0|关闭|
+|TXLiveVoiceChangerType_1|1|熊孩子|
+|TXLiveVoiceChangerType_2|2|萝莉|
+|TXLiveVoiceChangerType_3|3|大叔|
+|TXLiveVoiceChangerType_4|4|重金属|
+|TXLiveVoiceChangerType_5|5|感冒|
+|TXLiveVoiceChangerType_6|6|外语腔|
+|TXLiveVoiceChangerType_7|7|困兽|
+|TXLiveVoiceChangerType_8|8|肥宅|
+|TXLiveVoiceChangerType_9|9|强电流|
+|TXLiveVoiceChangerType_10|10|重机械|
+|TXLiveVoiceChangerType_11|11|空灵|
+|TXLiveVoiceChangerType_12|12|猪八戒|
+|TXLiveVoiceChangerType_13|13|绿巨人|
 
 ## TXAudioMusicParam
 
-#### 背景音乐的播放控制信息
+**背景音乐的播放控制信息**
 
 该信息用于在接口 [startPlayMusic 中指定背景音乐的相关信息，包括播放 ID、文件路径和循环次数等：