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

package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCStatistics.md

@@ -1,18 +1,20 @@
-# 腾讯云实时音视频(TRTC SDK )文档
+Copyright (c) 2021 Tencent. All rights reserved.
 
-## 概述
-`TRTCStatistics.h` 是腾讯云实时音视频(TRTC SDK ) iOS 平台的统计指标（只读）文档，TRTC SDK 会以两秒钟一次的频率向您汇报当前实时的音视频指标（帧率、码率、卡顿情况等）。
+Module:   TRTC 音视频统计指标（只读）
+
+Function: TRTC SDK 会以两秒钟一次的频率向您汇报当前实时的音视频指标（帧率、码率、卡顿情况等）
 
 ## 结构体类型
-| 函数列表 | 描述 |
-| --- | --- |
-| TRTCLocalStatistics | 本地的音视频统计指标。 |
-| TRTCRemoteStatistics | 远端的音视频统计指标。 |
-| TRTCStatistics | 网络和性能的汇总统计指标。 |
+
+|函数列表|描述|
+|---------|---------|
+|TRTCLocalStatistics|本地的音视频统计指标。|
+|TRTCRemoteStatistics|远端的音视频统计指标。|
+|TRTCStatistics|网络和性能的汇总统计指标。|
 
 ## TRTCLocalStatistics
 
-#### 本地的音视频统计指标。
+**本地的音视频统计指标。**
 | 枚举类型 | 描述 |
 | --- | --- |
 | audioBitrate | 【字段含义】本地音频的码率，即每秒钟新产生音频数据的多少，单位 Kbps。 |
@@ -26,13 +28,13 @@
 
 ## TRTCRemoteStatistics
 
-#### 远端的音视频统计指标。
+**远端的音视频统计指标。**
 | 枚举类型 | 描述 |
 | --- | --- |
-| audioBitrate | 【字段含义】本地音频的码率，单位 Kbps |
+| audioBitrate | 【字段含义】远端音频的码率，单位 Kbps |
 | audioBlockRate | 【字段含义】音频播放卡顿率，单位 (%)<br>音频播放卡顿率（audioBlockRate） = 音频播放的累计卡顿时长（audioTotalBlockTime） / 音频播放的总时长 |
-| audioPacketLoss | 【字段含义】音频流的总丢包率（％）。<br>audioPacketLoss 代表音频流历经“主播>云端>观众”这样一条完整的传输链路后，最终在观众端统计到的丢包率。<br>audioPacketLoss 越小越好，丢包率为0即表示该路音频流的所有数据均已经完整地到达了观众端。<br>如果出现了 downLoss == 0 但 audioPacketLoss != 0 的情况，说明该路音频流在“云端=>观众”这一段链路上没有出现丢包，但是在` 主播>云端 `这一段链路上出现了不可恢复的丢包。 |
-| audioSampleRate | 【字段含义】本地音频的采样率，单位 Hz。 |
+| audioPacketLoss | 【字段含义】音频流的总丢包率（％）。<br>audioPacketLoss 代表音频流历经“主播>云端>观众”这样一条完整的传输链路后，最终在观众端统计到的丢包率。<br>audioPacketLoss 越小越好，丢包率为0即表示该路音频流的所有数据均已经完整地到达了观众端。<br>如果出现了 downLoss == 0 但 audioPacketLoss != 0 的情况，说明该路音频流在“云端=>观众”这一段链路上没有出现丢包，但是在<code> 主播>云端 </code>这一段链路上出现了不可恢复的丢包。 |
+| audioSampleRate | 【字段含义】远端音频的采样率，单位 Hz。 |
 | audioTotalBlockTime | 【字段含义】音频播放的累计卡顿时长，单位 ms |
 | finalLoss | 【字段含义】该路音视频流的总丢包率（％）。已废弃，不推荐使用；建议使用 audioPacketLoss、videoPacketLoss 替代。 |
 | frameRate | 【字段含义】远端视频的帧率，单位：FPS。 |
@@ -51,12 +53,12 @@
 
 ## TRTCStatistics
 
-#### 网络和性能的汇总统计指标。
+**网络和性能的汇总统计指标。**
 | 枚举类型 | 描述 |
 | --- | --- |
 | appCpu | 【字段含义】当前应用的 CPU 使用率，单位 (%)，Android 8.0 以上不支持。 |
 | downLoss | 【字段含义】从云端到 SDK 的下行丢包率，单位 (%)<br>该数值越小越好，如果 downLoss 为 0%，则意味着下行链路的网络质量很好，从云端接收的数据包基本不发生丢失。<br>如果 downLoss 为 30%，则意味着云端向 SDK 传输的音视频数据包中，会有 30% 丢失在传输链路中。 |
-| gatewayRtt | 【字段含义】从 SDK 到本地路由器的往返时延，单位 ms 该数值代表从 SDK 发送一个网络包到本地路由器网关，再从网关回送一个网络包到 SDK 的总计耗时，也就是一个网络包经历 【SDK>网关>SDK【 的总耗时。<br>该数值越小越好：如果 gatewayRtt < 50ms，意味着较低的音视频通话延迟；如果 gatewayRtt > 200ms，则意味着较高的音视频通话延迟。<br>当网络类型为蜂窝网时，该值无效。 |
+| gatewayRtt | 【字段含义】从 SDK 到本地路由器的往返时延，单位 ms 该数值代表从 SDK 发送一个网络包到本地路由器网关，再从网关回送一个网络包到 SDK 的总计耗时，也就是一个网络包经历 “SDK=>网关=>SDK” 的总耗时。<br>该数值越小越好：如果 gatewayRtt < 50ms，意味着较低的音视频通话延迟；如果 gatewayRtt > 200ms，则意味着较高的音视频通话延迟。<br>当网络类型为蜂窝网时，该值无效。 |
 | localStatistics | 【字段含义】本地的音视频统计信息<br>由于本地可能有三路音视频流（即高清大画面，低清小画面，以及辅流画面），因此本地的音视频统计信息是一个数组。 |
 | receivedBytes | 【字段含义】总接收字节数（包含信令数据和音视频数据），单位：字节数（Bytes）。 |
 | remoteStatistics | 【字段含义】远端的音视频统计信息<br>因为同时可能有多个远端用户，而且每个远端用户同时可能有多路音视频流（即高清大画面，低清小画面，以及辅流画面），因此远端的音视频统计信息是一个数组。 |

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

@@ -1,57 +1,62 @@
-# 腾讯云实时音视频(TRTC SDK )文档
+Copyright (c) 2021 Tencent. All rights reserved.
 
-## 概述
-`TXAudioEffectManager.h` 是腾讯云实时音视频(TRTC SDK ) iOS 平台的背景音乐、短音效和人声特效的管理类文档，用于对背景音乐、短音效和人声特效进行设置的管理类。
+Module:   背景音乐、短音效和人声特效的管理类
+
+Function: 用于对背景音乐、短音效和人声特效进行设置的管理类
 
 ## TXAudioEffectManager
-| 函数列表 | 描述 |
-| --- | --- |
-| enableVoiceEarMonitor: | 开启耳返。 |
-| setVoiceEarMonitorVolume: | 设置耳返音量。 |
-| setVoiceReverbType: | 设置人声的混响效果。 |
-| setVoiceChangerType: | 设置人声的变声特效。 |
-| setVoiceVolume: | 设置语音音量。 |
-| setVoicePitch: | 设置语音音调。 |
-| startPlayMusic:onStart:onProgress:onComplete: | 开始播放背景音乐。 |
-| stopPlayMusic: | 停止播放背景音乐。 |
-| pausePlayMusic: | 暂停播放背景音乐。 |
-| resumePlayMusic: | 恢复播放背景音乐。 |
-| setAllMusicVolume: | 设置所有背景音乐的本地音量和远端音量的大小。 |
-| setMusicPublishVolume:volume: | 设置某一首背景音乐的远端音量的大小。 |
-| setMusicPlayoutVolume:volume: | 设置某一首背景音乐的本地音量的大小。 |
-| setMusicPitch:pitch: | 调整背景音乐的音调高低。 |
-| setMusicSpeedRate:speedRate: | 调整背景音乐的变速效果。 |
-| getMusicCurrentPosInMS: | 获取背景音乐的播放进度（单位：毫秒）。 |
-| getMusicDurationInMS: | 获取背景音乐的总时长（单位：毫秒）。 |
-| seekMusicToPosInMS:pts: | 设置背景音乐的播放进度（单位：毫秒）。 |
-| setMusicScratchSpeedRate:speedRate: | 调整搓碟的变速效果。 |
-| preloadMusic:onProgress:onError: | 预加载背景音乐。 |
-| getMusicTrackCount: | 获取背景音乐的音轨数量。 |
-| setMusicTrack:track: | 指定背景音乐的播放音轨。 |
+
+|函数列表|描述|
+|---------|---------|
+|enableVoiceEarMonitor:|开启耳返。|
+|setVoiceEarMonitorVolume:|设置耳返音量。|
+|setVoiceReverbType:|设置人声的混响效果。|
+|setVoiceChangerType:|设置人声的变声特效。|
+|setVoiceVolume:|设置语音音量。|
+|setVoicePitch:|设置语音音调。|
+|startPlayMusic:onStart:onProgress:onComplete:|开始播放背景音乐。|
+|stopPlayMusic:|停止播放背景音乐。|
+|pausePlayMusic:|暂停播放背景音乐。|
+|resumePlayMusic:|恢复播放背景音乐。|
+|setAllMusicVolume:|设置所有背景音乐的本地音量和远端音量的大小。|
+|setMusicPublishVolume:volume:|设置某一首背景音乐的远端音量的大小。|
+|setMusicPlayoutVolume:volume:|设置某一首背景音乐的本地音量的大小。|
+|setMusicPitch:pitch:|调整背景音乐的音调高低。|
+|setMusicSpeedRate:speedRate:|调整背景音乐的变速效果。|
+|getMusicCurrentPosInMS:|获取背景音乐的播放进度（单位：毫秒）。|
+|getMusicDurationInMS:|获取背景音乐的总时长（单位：毫秒）。|
+|seekMusicToPosInMS:pts:|设置背景音乐的播放进度（单位：毫秒）。|
+|setMusicScratchSpeedRate:speedRate:|调整搓碟的变速效果。|
+|preloadMusic:onProgress:onError:|预加载背景音乐。|
+|getMusicTrackCount:|获取背景音乐的音轨数量。|
+|setMusicTrack:track:|指定背景音乐的播放音轨。|
 
 ## 结构体类型
-| 函数列表 | 描述 |
-| --- | --- |
-| TXAudioMusicParam | 背景音乐的播放控制信息 |
+
+|函数列表|描述|
+|---------|---------|
+|TXAudioMusicParam|背景音乐的播放控制信息|
 
 ## 枚举类型
-| 枚举类型 | 描述 |
-| --- | --- |
-| TXVoiceReverbType | 混响特效 |
-| TXVoiceChangeType | 变声特效 |
+
+|枚举类型|描述|
+|---------|---------|
+|TXVoiceReverbType|混响特效|
+|TXVoiceChangeType|变声特效|
 
 ## enableVoiceEarMonitor:
 
-#### 开启耳返。
+**开启耳返。**
 
 主播开启耳返后，可以在耳机里听到麦克风采集到的自己发出的声音，该特效适用于主播唱歌的应用场景中。
 
 需要您注意的是，由于蓝牙耳机的硬件延迟非常高，所以在主播佩戴蓝牙耳机时无法开启此特效，请尽量在用户界面上提示主播佩戴有线耳机。
 
 同时也需要注意，并非所有的手机开启此特效后都能达到优秀的耳返效果，我们已经对部分耳返效果不佳的手机屏蔽了该特效。
-| 参数 | 描述 |
-| --- | --- |
-| enable | YES：开启；NO：关闭。 |
+
+|参数|描述|
+|---------|---------|
+|enable|YES：开启；NO：关闭。|
 
 > **注意**
 >
@@ -61,12 +66,13 @@
 
 ## setVoiceEarMonitorVolume:
 
-#### 设置耳返音量。
+**设置耳返音量。**
 
 通过该接口您可以设置耳返特效中声音的音量大小。
-| 参数 | 描述 |
-| --- | --- |
-| volume | 音量大小，取值范围为 [0, 150]，默认值：100。 |
+
+|参数|描述|
+|---------|---------|
+|volume|音量大小，取值范围为 [0, 150]，默认值：100。|
 
 > **注意**
 >
@@ -76,7 +82,7 @@
 
 ## setVoiceReverbType:
 
-#### 设置人声的混响效果。
+**设置人声的混响效果。**
 
 通过该接口您可以设置人声的混响效果，具体特效请参见枚举定义 TXVoiceReverbType。
 
@@ -88,7 +94,7 @@
 
 ## setVoiceChangerType:
 
-#### 设置人声的变声特效。
+**设置人声的变声特效。**
 
 通过该接口您可以设置人声的变声特效，具体特效请参见枚举定义 TXVoiceChangeType。
 
@@ -100,12 +106,13 @@
 
 ## setVoiceVolume:
 
-#### 设置语音音量。
+**设置语音音量。**
 
 该接口可以设置语音音量的大小，一般配合音乐音量的设置接口 setAllMusicVolume 协同使用，用于调谐语音和音乐在混音前各自的音量占比。
-| 参数 | 描述 |
-| --- | --- |
-| volume | 音量大小，取值范围为 [0 - 150]，默认值：100。 |
+
+|参数|描述|
+|---------|---------|
+|volume|音量大小，取值范围为 [0 - 150]，默认值：100。|
 
 > **注意**
 >
@@ -115,24 +122,26 @@
 
 ## setVoicePitch:
 
-#### 设置语音音调。
+**设置语音音调。**
 
 该接口可以设置语音音调，用于实现变调不变速的目的。
-| 参数 | 描述 |
-| --- | --- |
-| pitch | 音调，取值范围[-1.0f, 1.0f]，默认值：0.0f。 |
+
+|参数|描述|
+|---------|---------|
+|pitch|音调，取值范围[-1.0f, 1.0f]，默认值：0.0f。|
 
 ## startPlayMusic:onStart:onProgress:onComplete:
 
-#### 开始播放背景音乐。
+**开始播放背景音乐。**
 
 每个音乐都需要您指定具体的 ID，您可以通过该 ID 对音乐的开始、停止、音量等进行设置。
-| 参数 | 描述 |
-| --- | --- |
-| completeBlock | 播放结束回调。 |
-| musicParam | 音乐参数。 |
-| progressBlock | 播放进度回调。 |
-| startBlock | 播放开始回调。 |
+
+|参数|描述|
+|---------|---------|
+|completeBlock|播放结束回调。|
+|musicParam|音乐参数。|
+|progressBlock|播放进度回调。|
+|startBlock|播放开始回调。|
 
 > **注意**
 >
@@ -148,37 +157,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。|
 
 > **注意**
 >
@@ -188,13 +200,14 @@
 
 ## setMusicPublishVolume:volume:
 
-#### 设置某一首背景音乐的远端音量的大小。
+**设置某一首背景音乐的远端音量的大小。**
 
 该接口可以细粒度地控制每一首背景音乐的远端音量，也就是观众端可听到的背景音乐的音量大小。
-| 参数 | 描述 |
-| --- | --- |
-| id | 音乐 ID。 |
-| volume | 音量大小，取值范围为 [0, 150]；默认值：60。 |
+
+|参数|描述|
+|---------|---------|
+|id|音乐 ID。|
+|volume|音量大小，取值范围为 [0, 150]；默认值：60。|
 
 > **注意**
 >
@@ -204,13 +217,14 @@
 
 ## setMusicPlayoutVolume:volume:
 
-#### 设置某一首背景音乐的本地音量的大小。
+**设置某一首背景音乐的本地音量的大小。**
 
 该接口可以细粒度地控制每一首背景音乐的本地音量，也就是主播本地可以听到的背景音乐的音量大小。
-| 参数 | 描述 |
-| --- | --- |
-| id | 音乐 ID。 |
-| volume | 音量大小，取值范围为 [0, 150]，默认值：60。 |
+
+|参数|描述|
+|---------|---------|
+|id|音乐 ID。|
+|volume|音量大小，取值范围为 [0, 150]，默认值：60。|
 
 > **注意**
 >
@@ -220,49 +234,52 @@
 
 ## setMusicPitch:pitch:
 
-#### 调整背景音乐的音调高低。
-| 参数 | 描述 |
-| --- | --- |
-| id | 音乐 ID。 |
-| pitch | 音调，取值范围为 [-1.0f, 1.0f] 之间的浮点数，默认值：0.0f。 |
+**调整背景音乐的音调高低。**
+
+|参数|描述|
+|---------|---------|
+|id|音乐 ID。|
+|pitch|音调，取值范围为 [-1.0f, 1.0f] 之间的浮点数，默认值：0.0f。|
 
 ## setMusicSpeedRate:speedRate:
 
-#### 调整背景音乐的变速效果。
-| 参数 | 描述 |
-| --- | --- |
-| 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:pts:
 
-#### 设置背景音乐的播放进度（单位：毫秒）。
-| 参数 | 描述 |
-| --- | --- |
-| id | 音乐 ID。 |
-| pts | 单位: 毫秒。 |
+**设置背景音乐的播放进度（单位：毫秒）。**
+
+|参数|描述|
+|---------|---------|
+|id|音乐 ID。|
+|pts|单位: 毫秒。|
 
 > **注意**
 >
@@ -278,11 +295,12 @@
 
 ## setMusicScratchSpeedRate:speedRate:
 
-#### 调整搓碟的变速效果。
-| 参数 | 描述 |
-| --- | --- |
-| id | 音乐 ID。 |
-| scratchSpeedRate | 搓碟速度，取值范围为 [-12.0, 12.0] 之间的浮点数，默认值是 1.0f，速度值正/负表示方向正/反，绝对值大小表示速度快慢。 |
+**调整搓碟的变速效果。**
+
+|参数|描述|
+|---------|---------|
+|id|音乐 ID。|
+|scratchSpeedRate|搓碟速度，取值范围为 [-12.0, 12.0] 之间的浮点数，默认值是 1.0f，速度值正/负表示方向正/反，绝对值大小表示速度快慢。|
 
 > **注意**
 >
@@ -292,12 +310,13 @@
 
 ## preloadMusic:onProgress:onError:
 
-#### 预加载背景音乐。
+**预加载背景音乐。**
 
 每个音乐都需要您指定具体的 ID，您可以通过该 ID 对音乐的开始、停止、音量等进行设置。
-| 参数 | 描述 |
-| --- | --- |
-| preloadParam | 预加载音乐参数。 |
+
+|参数|描述|
+|---------|---------|
+|preloadParam|预加载音乐参数。|
 
 > **注意**
 >
@@ -313,18 +332,20 @@
 
 ## getMusicTrackCount:
 
-#### 获取背景音乐的音轨数量。
-| 参数 | 描述 |
-| --- | --- |
-| id | 音乐 ID。 |
+**获取背景音乐的音轨数量。**
+
+|参数|描述|
+|---------|---------|
+|id|音乐 ID。|
 
 ## setMusicTrack:track:
 
-#### 指定背景音乐的播放音轨。
-| 参数 | 描述 |
-| --- | --- |
-| id | 音乐 ID。 |
-| index | 默认播放第一个音轨。取值范围0, 音轨总数)。 |
+**指定背景音乐的播放音轨。**
+
+|参数|描述|
+|---------|---------|
+|id|音乐 ID。|
+|index|默认播放第一个音轨。取值范围0, 音轨总数)。|
 
 > **注意**
 >
@@ -334,53 +355,55 @@
 
 ## TXVoiceReverbType
 
-#### 混响特效
+**混响特效**
 
 混响特效可以作用于人声之上，通过声学算法对声音进行叠加处理，模拟出各种不同环境下的临场感受，目前支持如下几种混响效果：
 
-0：关闭；1：KTV；2：小房间；3：大会堂；4：低沉；5：洪亮；6：金属声；7：磁性；8：空灵；9：录音棚；10：悠扬 11：录音棚2。
-| 枚举 | 取值 | 描述 |
-| --- | --- | --- |
-| TXVoiceReverbType_0 | 0 | 关闭特效 |
-| TXVoiceReverbType_1 | 1 | KTV |
-| TXVoiceReverbType_2 | 2 | 小房间 |
-| TXVoiceReverbType_3 | 3 | 大会堂 |
-| TXVoiceReverbType_4 | 4 | 低沉 |
-| TXVoiceReverbType_5 | 5 | 洪亮 |
-| TXVoiceReverbType_6 | 6 | 金属声 |
-| TXVoiceReverbType_7 | 7 | 磁性 |
-| TXVoiceReverbType_8 | 8 | 空灵 |
-| TXVoiceReverbType_9 | 9 | 录音棚 |
-| TXVoiceReverbType_10 | 10 | 悠扬 |
-| TXVoiceReverbType_11 | 11 | 录音棚2 |
+0：关闭；1：KTV；2：小房间；3：大会堂；4：低沉；5：洪亮；6：金属声；7：磁性；8：空灵；9：录音棚；10：悠扬；11：录音棚2；
+
+|枚举|取值|描述|
+|---------|---------|---------|
+|TXVoiceReverbType_0|0|关闭特效|
+|TXVoiceReverbType_1|1|KTV|
+|TXVoiceReverbType_2|2|小房间|
+|TXVoiceReverbType_3|3|大会堂|
+|TXVoiceReverbType_4|4|低沉|
+|TXVoiceReverbType_5|5|洪亮|
+|TXVoiceReverbType_6|6|金属声|
+|TXVoiceReverbType_7|7|磁性|
+|TXVoiceReverbType_8|8|空灵|
+|TXVoiceReverbType_9|9|录音棚|
+|TXVoiceReverbType_10|10|悠扬|
+|TXVoiceReverbType_11|11|录音棚2|
 
 ## TXVoiceChangeType
 
-#### 变声特效
+**变声特效**
 
 变声特效可以作用于人声之上，通过声学算法对人声进行二次处理，以获得与原始声音所不同的音色，目前支持如下几种变声特效：
 
-0：关闭；1：熊孩子；2：萝莉；3：大叔；4：重金属；5：感冒；6：外语腔；7：困兽；8：肥宅；9：强电流；10：重机械；11：空灵；12：猪八戒；13：绿巨人。
-| 枚举 | 取值 | 描述 |
-| --- | --- | --- |
-| TXVoiceChangeType_0 | 0 | 关闭 |
-| TXVoiceChangeType_1 | 1 | 熊孩子 |
-| TXVoiceChangeType_2 | 2 | 萝莉 |
-| TXVoiceChangeType_3 | 3 | 大叔 |
-| TXVoiceChangeType_4 | 4 | 重金属 |
-| TXVoiceChangeType_5 | 5 | 感冒 |
-| TXVoiceChangeType_6 | 6 | 外语腔 |
-| TXVoiceChangeType_7 | 7 | 困兽 |
-| TXVoiceChangeType_8 | 8 | 肥宅 |
-| TXVoiceChangeType_9 | 9 | 强电流 |
-| TXVoiceChangeType_10 | 10 | 重机械 |
-| TXVoiceChangeType_11 | 11 | 空灵 |
-| TXVoiceChangeType_12 | 12 | 猪八戒 |
-| TXVoiceChangeType_13 | 13 | 绿巨人 |
+0：关闭；1：熊孩子；2：萝莉；3：大叔；4：重金属；5：感冒；6：外语腔；7：困兽；8：肥宅；9：强电流；10：重机械；11：空灵；12：猪八戒；13：绿巨人；
+
+|枚举|取值|描述|
+|---------|---------|---------|
+|TXVoiceChangeType_0|0|关闭|
+|TXVoiceChangeType_1|1|熊孩子|
+|TXVoiceChangeType_2|2|萝莉|
+|TXVoiceChangeType_3|3|大叔|
+|TXVoiceChangeType_4|4|重金属|
+|TXVoiceChangeType_5|5|感冒|
+|TXVoiceChangeType_6|6|外语腔|
+|TXVoiceChangeType_7|7|困兽|
+|TXVoiceChangeType_8|8|肥宅|
+|TXVoiceChangeType_9|9|强电流|
+|TXVoiceChangeType_10|10|重机械|
+|TXVoiceChangeType_11|11|空灵|
+|TXVoiceChangeType_12|12|猪八戒|
+|TXVoiceChangeType_13|13|绿巨人|
 
 ## TXAudioMusicParam
 
-#### 背景音乐的播放控制信息
+**背景音乐的播放控制信息**
 
 该信息用于在接口 [startPlayMusic 中指定背景音乐的相关信息，包括播放 ID、文件路径和循环次数等：
 
@@ -396,5 +419,5 @@
 | isShortFile | 【字段含义】播放的是否为短音乐文件。<br>【推荐取值】YES：需要重复播放的短音乐文件；NO：正常的音乐文件。默认值：NO。 |
 | loopCount | 【字段含义】音乐循环播放的次数。<br>【推荐取值】取值范围为 [0, 任意正整数]，默认值：0。0 表示播放音乐一次；1 表示播放音乐两次；以此类推。 |
 | path | 【字段含义】音效文件的完整路径或 URL 地址。支持的音频格式包括 MP3、AAC、M4A、WAV。 |
-| publish | 【字段含义】是否将音乐传到远端。<br>【推荐取值】YES：音乐在本地播放的同时，远端用户也能听到该音乐；NO：主播只能在本地听到该音乐，远端观众听不到。默认值：NO。 |
+| publish | 【字段含义】是否将音乐传到远端。<br>【推荐取值】YES：音乐在本地播放的同时，远端用户也能听到该音乐；NO：主播只能在本地听到该音乐，远端观众听不到。默认值：YES。 |
 | startTimeMS | 【字段含义】音乐开始播放时间点，单位：毫秒。 |