@tencentcloud/sdk-mcp 1.6.3 → 1.6.5

package/resource/knowledge/trtc/ios/TRTCCloud.md

@@ -4,7 +4,7 @@ Module:   TRTCCloud @ TXLiteAVSDK
 
 Function: 腾讯云 TRTC 主功能接口
 
-Version: 13.3
+Version: 13.4
 
 ## TRTCCloud
 
@@ -133,7 +133,6 @@ Version: 13.3
 
 > **注意**
 >
-
 > 1. 建议使用 destroySharedInstance 释放对象。
 >
 
@@ -155,14 +154,13 @@ Version: 13.3
 
 **设置驱动 TRTCCloudDelegate 事件回调的队列。**
 
-如果您不指定自己的 ` delegateQueue `，SDK 默认会采用 MainQueue 作为驱动 TRTCCloudDelegate 事件回调的队列。
+如果您不指定自己的  `delegateQueue` ，SDK 默认会采用 MainQueue 作为驱动 TRTCCloudDelegate 事件回调的队列。
 
-也就是当您不设置 ` delegateQueue ` 属性时，TRTCCloudDelegate 中的所有回调函数都是由 MainQueue 来驱动的。
+也就是当您不设置  `delegateQueue`  属性时，TRTCCloudDelegate 中的所有回调函数都是由 MainQueue 来驱动的。
 
 > **注意**
 >
-
-> 如果您指定了自己的 ` delegateQueue `，请不要在 TRTCCloudDelegate 回调函数中操作 UI，否则会引发线程安全问题。
+> 如果您指定了自己的  `delegateQueue` ，请不要在 TRTCCloudDelegate 回调函数中操作 UI，否则会引发线程安全问题。
 >
 
 ## enterRoom:appScene:
@@ -182,9 +180,9 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
 包括 TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom 两个可选项，分别是视频直播和语音直播，该模式适合十万人以内的在线直播场景，但需要您在接下来介绍的 TRTCParams 参数中指定 **角色(role)** 这个字段，也就是将房间中的用户区分为 **主播** (TRTCRoleAnchor) 和 **观众** (TRTCRoleAudience) 两种不同的角色。
 
 调用该接口后，您会收到来自 TRTCCloudDelegate 中的 onEnterRoom 回调：
--  如果进房成功，参数 ` result ` 会是一个正数（result > 0），表示从函数调用到进入房间所花费的时间，单位是毫秒（ms）。
+-  如果进房成功，参数  `result`  会是一个正数（result > 0），表示从函数调用到进入房间所花费的时间，单位是毫秒（ms）。
 
--  如果进房失败，参数 ` result ` 会是一个负数（result < 0），表示进房失败的[错误码](https://cloud.tencent.com/document/product/647/32257)。
+-  如果进房失败，参数  `result`  会是一个负数（result < 0），表示进房失败的[错误码](https://cloud.tencent.com/document/product/647/32257)。
 
 |参数|描述|
 |---------|---------|
@@ -193,13 +191,10 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
 
 > **注意**
 >
-
-> 1. 同一个房间内的所有用户需要设定相同的 ` scene `。不同的 ` scene ` 会导致偶现的异常问题。
+> 1. 同一个房间内的所有用户需要设定相同的  `scene` 。不同的  `scene`  会导致偶现的异常问题。
 >
-
-> 2. 当您指定参数 ` scene ` 为 TRTCAppSceneLIVE 或 TRTCAppSceneVoiceChatRoom 时，您必须通过 TRTCParams 中的 ` role `字段为当前用户设定他/她在房间中的角色。
+> 2. 当您指定参数  `scene`  为 TRTCAppSceneLIVE 或 TRTCAppSceneVoiceChatRoom 时，您必须通过 TRTCParams 中的  `role` 字段为当前用户设定他/她在房间中的角色。
 >
-
 > 3. 请您尽量保证 enterRoom 与 exitRoom 前后配对使用，即保证“先退出前一个房间再进入下一个房间”，否则会导致很多异常问题。
 >
 
@@ -221,18 +216,16 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
 
 由于视频直播和语音聊天室需要支持多达10万名观众同时观看，所以设定了 **只有主播才能发布自己的音视频** 的规则。因此，当有些观众希望发布自己的音视频流（以便能跟主播互动）时，就需要先把自己的角色切换成 **主播**。
 
-您可以在进入房间时通过 TRTCParams 中的 ` role ` 字段事先确定用户的角色，也可以在进入房间后通过该接口动态切换角色。
+您可以在进入房间时通过 TRTCParams 中的  `role`  字段事先确定用户的角色，也可以在进入房间后通过该接口动态切换角色。
 | 参数 | 描述 |
 | --- | --- |
-| role | 角色，默认为 <strong>主播</strong>。<br>- TRTCRoleAnchor ：主播，可以发布自己的音视频，同一个房间里最多支持50个主播同时发布音视频。<br>- TRTCRoleAudience ：观众，不能发布自己的音视频流，只能观看房间中其他主播的音视频。如果要发布自己的音视频，需要先通过 switchRole 切换成 <strong>主播</strong>，同一个房间内同时最多可以容纳 10 万名观众。 |
+| role | 角色，默认为 <strong>主播</strong>。<br>-  TRTCRoleAnchor ：主播，可以发布自己的音视频，同一个房间里最多支持50个主播同时发布音视频。<br>-  TRTCRoleAudience ：观众，不能发布自己的音视频流，只能观看房间中其他主播的音视频。如果要发布自己的音视频，需要先通过 switchRole 切换成 <strong>主播</strong>，同一个房间内同时最多可以容纳 10 万名观众。 |
 
 > **注意**
 >
-
 > 1. 该接口仅适用于视频直播（TRTCAppSceneLIVE）和语音聊天室（TRTCAppSceneVoiceChatRoom）这两个场景。
 >
-
-> 2. 如果您在调用 enterRoom 时指定的 ` scene ` 为 TRTCAppSceneVideoCall 或 TRTCAppSceneAudioCall，请不要调用这个接口。
+> 2. 如果您在调用 enterRoom 时指定的  `scene`  为 TRTCAppSceneVideoCall 或 TRTCAppSceneAudioCall，请不要调用这个接口。
 >
 
 ## switchRole:privateMapKey:
@@ -243,19 +236,17 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
 
 由于视频直播和语音聊天室需要支持多达10万名观众同时观看，所以设定了 **只有主播才能发布自己的音视频** 的规则。因此，当有些观众希望发布自己的音视频流（以便能跟主播互动）时，就需要先把自己的角色切换成 **主播**。
 
-您可以在进入房间时通过 TRTCParams 中的 ` role ` 字段事先确定用户的角色，也可以在进入房间后通过该接口动态切换角色。
+您可以在进入房间时通过 TRTCParams 中的  `role`  字段事先确定用户的角色，也可以在进入房间后通过该接口动态切换角色。
 | 参数 | 描述 |
 | --- | --- |
-| privateMapKey | 用于权限控制的权限票据，当您希望某个房间只能让特定的 userId 进入或者上行视频时，需要使用 <code> privateMapKey </code> 进行权限保护。<br>-  仅建议有高级别安全需求的客户使用，更多详情请参见 <a href="https://cloud.tencent.com/document/product/647/32240">开启高级权限控制</a>。 |
-| role | 角色，默认为 <strong>主播</strong>。<br>- TRTCRoleAnchor ：主播，可以发布自己的音视频，同一个房间里最多支持50个主播同时发布音视频。<br>- TRTCRoleAudience ：观众，不能发布自己的音视频流，只能观看房间中其他主播的音视频。如果要发布自己的音视频，需要先通过 switchRole 切换成 <strong>主播</strong>，同一个房间内同时最多可以容纳 10 万名观众。 |
+| privateMapKey | 用于权限控制的权限票据，当您希望某个房间只能让特定的 userId 进入或者上行视频时，需要使用  <code>privateMapKey</code>  进行权限保护。<br>-  仅建议有高级别安全需求的客户使用，更多详情请参见 <a href="https://cloud.tencent.com/document/product/647/32240">开启高级权限控制</a>。 |
+| role | 角色，默认为 <strong>主播</strong>。<br>-  TRTCRoleAnchor ：主播，可以发布自己的音视频，同一个房间里最多支持50个主播同时发布音视频。<br>-  TRTCRoleAudience ：观众，不能发布自己的音视频流，只能观看房间中其他主播的音视频。如果要发布自己的音视频，需要先通过 switchRole 切换成 <strong>主播</strong>，同一个房间内同时最多可以容纳 10 万名观众。 |
 
 > **注意**
 >
-
 > 1. 该接口仅适用于视频直播（TRTCAppSceneLIVE）和语音聊天室（TRTCAppSceneVoiceChatRoom）这两个场景。
 >
-
-> 2. 如果您在 enterRoom 时指定的 ` scene ` 为 TRTCAppSceneVideoCall 或 TRTCAppSceneAudioCall，请不要调用这个接口。
+> 2. 如果您在 enterRoom 时指定的  `scene`  为 TRTCAppSceneVideoCall 或 TRTCAppSceneAudioCall，请不要调用这个接口。
 >
 
 ## switchRoom:
@@ -263,11 +254,11 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
 **切换房间。**
 
 使用该接口可以让用户快速从一个房间切换到另一个房间。
--  如果用户的身份是“观众”，该接口的调用效果等同于 ` exitRoom(当前房间) + enterRoom（新的房间） `。
+-  如果用户的身份是“观众”，该接口的调用效果等同于  `exitRoom(当前房间) + enterRoom（新的房间）` 。
 
 -  如果用户的身份是“主播”，该接口在切换房间的同时还会保持自己的音视频发布状态，因此在房间切换过程中，摄像头的预览和声音的采集都不会中断。
 
-该接口适用于在线教育场景中，监课老师在多个房间中进行快速切换的场景。在该场景下使用 ` switchRoom ` 可以获得比 ` exitRoom + enterRoom ` 更好的流畅性和更少的代码量。
+该接口适用于在线教育场景中，监课老师在多个房间中进行快速切换的场景。在该场景下使用  `switchRoom`  可以获得比  `exitRoom + enterRoom`  更好的流畅性和更少的代码量。
 
 接口调用结果会通过 TRTCCloudDelegate 中的 onSwitchRoom 回调。
 
@@ -277,14 +268,11 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
 
 > **注意**
 >
-
-> 由于对老版本 SDK 兼容的需求，参数 ` config ` 中同时包含 ` roomId ` 与 ` strRoomId ` 两个参数，这两个参数的填写格外讲究，请注意如下事项：
+> 由于对老版本 SDK 兼容的需求，参数  `config`  中同时包含  `roomId`  与  `strRoomId`  两个参数，这两个参数的填写格外讲究，请注意如下事项：
 >
-
-> 1. 若您选用 ` strRoomId `，则 ` roomId ` 需要填写为0。若两者都填，将优先选用 ` roomId `。
+> 1. 若您选用  `strRoomId` ，则  `roomId`  需要填写为0。若两者都填，将优先选用  `roomId` 。
 >
-
-> 2. 所有房间需要同时使用 ` strRoomId ` 或同时使用 ` roomId `，不可混用，否则将会出现很多预期之外的 bug。
+> 2. 所有房间需要同时使用  `strRoomId`  或同时使用  `roomId` ，不可混用，否则将会出现很多预期之外的 bug。
 >
 
 ## connectOtherRoom:
@@ -299,16 +287,16 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
 
 跨房通话的请求结果会通过 TRTCCloudDelegate 中的 onConnectOtherRoom 回调通知给您。
 
-例如：当房间“101”中的主播 A 通过 ` connectOtherRoom() ` 跟房间“102”中的主播 B 建立跨房通话后，
--  房间“101”中的用户都会收到主播 B 的 ` onRemoteUserEnterRoom(B) ` 和 ` onUserVideoAvailable(B,YES) ` 这两个事件回调，即房间“101”中的用户都可以订阅主播 B 的音视频。
+例如：当房间“101”中的主播 A 通过  `connectOtherRoom()`  跟房间“102”中的主播 B 建立跨房通话后，
+-  房间“101”中的用户都会收到主播 B 的  `onRemoteUserEnterRoom(B)`  和  `onUserVideoAvailable(B,YES)`  这两个事件回调，即房间“101”中的用户都可以订阅主播 B 的音视频。
 
--  房间“102”中的用户都会收到主播 A 的 ` onRemoteUserEnterRoom(A) ` 和 ` onUserVideoAvailable(A,YES) ` 这两个事件回调，即房间“102”中的用户都可以订阅主播 A 的音视频。
+-  房间“102”中的用户都会收到主播 A 的  `onRemoteUserEnterRoom(A)`  和  `onUserVideoAvailable(A,YES)`  这两个事件回调，即房间“102”中的用户都可以订阅主播 A 的音视频。
 
 跨房通话的参数考虑到后续扩展字段的兼容性问题，暂时采用了 JSON 格式的参数：
 
 **情况一：数字房间号**
 
-如果房间“101”中的主播 A 要跟房间“102”中的主播 B 连麦，那么主播 A 调用该接口时需要传入：` {"roomId": 102, "userId": "userB"} `
+如果房间“101”中的主播 A 要跟房间“102”中的主播 B 连麦，那么主播 A 调用该接口时需要传入： `{"roomId": 102, "userId": "userB"}`
 
 示例代码如下：
 ``` objectivec
@@ -322,7 +310,7 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
 
 **情况二：字符串房间号**
 
-如果您使用的是字符串房间号，务必请将 json 中的 “roomId” 替换成 “strRoomId”: ` {"strRoomId": "102", "userId": "userB"} `
+如果您使用的是字符串房间号，务必请将 json 中的 “roomId” 替换成 “strRoomId”:  `{"strRoomId": "102", "userId": "userB"}`
 
 示例代码如下：
 ``` objectivec
@@ -336,7 +324,7 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
 
 |参数|描述|
 |---------|---------|
-|param|需要您传入 JSON 格式的字符串参数，` roomId ` 代表数字格式的房间号，` strRoomId ` 代表字符串格式的房间号，` userId ` 代表目标主播的用户 ID。|
+|param|需要您传入 JSON 格式的字符串参数， `roomId`  代表数字格式的房间号， `strRoomId`  代表字符串格式的房间号， `userId`  代表目标主播的用户 ID。|
 
 ## disconnectOtherRoom
 
@@ -359,15 +347,13 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
 
 |参数|描述|
 |---------|---------|
-|autoRecvAudio|YES：自动订阅音频；NO：需手动调用 ` muteRemoteAudio(NO) ` 订阅音频。默认值：YES。|
-|autoRecvVideo|YES：自动订阅视频；NO：需手动调用 ` startRemoteView ` 订阅视频。默认值：YES。|
+|autoRecvAudio|YES：自动订阅音频；NO：需手动调用  `muteRemoteAudio(NO)`  订阅音频。默认值：YES。|
+|autoRecvVideo|YES：自动订阅视频；NO：需手动调用  `startRemoteView`  订阅视频。默认值：YES。|
 
 > **注意**
 >
-
 > 1. 需要在进入房间前调用该接口进行设置才能生效。
 >
-
 > 2. 在自动订阅模式下，如果用户在进入房间后没有调用  startRemoteView 订阅视频流，SDK 会自动停止订阅视频流，以便达到节省流量的目的。
 >
 
@@ -411,20 +397,17 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 
 > **注意**
 >
-
 > 1. 同一个用户，可以使用同一个 userId 进入多个不同 roomId 的房间。
 >
-
 > 2. 两台不同的终端设备不可以同时使用同一个 userId 进入同一个 roomId 的房间。
 >
-
 > 3. 您可以分别为不同实例分别设置 TRTCCloudDelegate 获取各自的事件通知。
 >
-
 > 4. 同一个用户可以在多个 TRTCCloud 实例中推流，也可以调用子实例中与本地音视频相关的接口。但需要注意：
 >
 > -  多实例的音频需要同时为麦克风采集或自定义采集，而且与音频设备相关的接口调用会以最后一次为准；
 > -  与摄像头相关的调用会以最后一次为准：startLocalPreview。
+
 **返回值说明：**
 
 子 TRTCCloud 实例
@@ -454,10 +437,10 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 例如：
 
 房间“101”中有主播 A 与观众 B，房间“102”中有主播 C，主播 C 正常发布音视频流。主播 A 通过 connectOtherRoom 跟主播 C 建立跨房通话。
--  此时，主播 A 与观众 B 都会收到主播 C 的 ` onRemoteUserEnterRoom(C) `, ` onUserVideoAvailable(C,YES) ` 和 ` onUserAudioAvailable(C,YES) ` 这三个事件回调，可以订阅主播 C 的音视频。
+-  此时，主播 A 与观众 B 都会收到主播 C 的  `onRemoteUserEnterRoom(C)` ,  `onUserVideoAvailable(C,YES)`  和  `onUserAudioAvailable(C,YES)`  这三个事件回调，可以订阅主播 C 的音视频。
 
 之后，主播 A 调用该接口禁用主播 C 在本房间发布音频的能力。
--  此后，主播 C 的音频流将无法发布至房间“101”，主播 A 与观众 B 都将收到 ` onUserAudioAvailable(C,NO) ` 事件回调，且无法再通过 ` muteRemoteAudio(C,NO) ` 订阅主播 C 的音频。
+-  此后，主播 C 的音频流将无法发布至房间“101”，主播 A 与观众 B 都将收到  `onUserAudioAvailable(C,NO)`  事件回调，且无法再通过  `muteRemoteAudio(C,NO)`  订阅主播 C 的音频。
 
 -  主播 C 的视频流将不受影响。房间“102”中的其他观众也不受影响，可以正常订阅主播 C 的音频。
 
@@ -487,7 +470,7 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 
 |参数|描述|
 |---------|---------|
-|param|需要您传入 JSON 格式的字符串参数，` roomId ` 代表数字格式的房间号，` strRoomId ` 代表字符串格式的房间号，` userId ` 代表目标主播的用户 ID，` muteAudio `, ` muteVideo `,` muteSubStream ` 均为可选项，分别代表禁止或允许跨房主播发布音频/主路视频/辅路视频的能力。|
+|param|需要您传入 JSON 格式的字符串参数， `roomId`  代表数字格式的房间号， `strRoomId`  代表字符串格式的房间号， `userId`  代表目标主播的用户 ID， `muteAudio` ,  `muteVideo` , `muteSubStream`  均为可选项，分别代表禁止或允许跨房主播发布音频/主路视频/辅路视频的能力。|
 
 ## startPublishMediaStream:encoderParam:mixingConfig:
 
@@ -503,16 +486,12 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 
 > **注意**
 >
-
 > 1. SDK 会通过回调 onStartPublishMediaStream 带给您后台启动的任务标识（即 taskId）。
 >
-
 > 2. 同一个任务（TRTCPublishMode 与 TRTCPublishCdnUrl 均相同）仅支持启动一次。若您后续需要更新或者停止该项任务，需要记录并使用返回的 taskId，通过 updatePublishMediaStream 或者 stopPublishMediaStream 来操作。
 >
-
-> 3. ` target ` 支持同时配置多个 CDN URL（最多同时 10 个）。若您的同一个转推/转码任务需要发布至多路 CDN，则仅需要在 ` target ` 中配置多个 CDN URL 即可。同一个转码任务即使有多个转推地址，对应的转码计费仍只收取一份。
+> 3.  `target`  支持同时配置多个 CDN URL（最多同时 10 个）。若您的同一个转推/转码任务需要发布至多路 CDN，则仅需要在  `target`  中配置多个 CDN URL 即可。同一个转码任务即使有多个转推地址，对应的转码计费仍只收取一份。
 >
-
 > 4. 使用时需要注意不要多个任务同时往相同的 URL 地址推送，以免引起异常推流状态。一种推荐的方案是 URL 中使用 “sdkappid_roomid_userid_main” 作为区分标识，这种命名方式容易辨认且不会在您的多个应用中发生冲突。
 >
 
@@ -531,13 +510,10 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 
 > **注意**
 >
-
 > 1. 您可以通过本接口来更新发布的 CDN URL（支持增删，最多同时 10 个），但您使用时需要注意不要多个任务同时往相同的 URL 地址推送，以免引起异常推流状态。
 >
-
-> 2. 您可以通过 ` taskId ` 来更新调整转推/转码任务。例如在 pk 业务中，您可以先通过 startPublishMediaStream 发起转推，接着在主播发起 pk 时，通过 ` taskId ` 和本接口将转推更新为转码任务。此时，CDN 播放将连续并且不会发生断流（您需要保持媒体流编码输出参数 param 一致）。
+> 2. 您可以通过  `taskId`  来更新调整转推/转码任务。例如在 pk 业务中，您可以先通过 startPublishMediaStream 发起转推，接着在主播发起 pk 时，通过  `taskId`  和本接口将转推更新为转码任务。此时，CDN 播放将连续并且不会发生断流（您需要保持媒体流编码输出参数 param 一致）。
 >
-
 > 3. 同一个任务不支持纯音频、音视频、纯视频之间的切换。
 >
 
@@ -553,11 +529,9 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 
 > **注意**
 >
-
-> 1. 若您的业务后台并没有保存该 ` taskId `，在您的主播异常退房重进后，如果您需要重新获取 ` taskId `，您可以再次调用 startPublishMediaStream 启动任务。此时 TRTC 后台会返回任务启动失败，同时带给您上一次启动的 ` taskId `。
+> 1. 若您的业务后台并没有保存该  `taskId` ，在您的主播异常退房重进后，如果您需要重新获取  `taskId` ，您可以再次调用 startPublishMediaStream 启动任务。此时 TRTC 后台会返回任务启动失败，同时带给您上一次启动的  `taskId` 。
 >
-
-> 2. 若 ` taskId ` 填空字符串，将会停止该用户所有通过 startPublishMediaStream 启动的媒体流，如果您只启动了一个媒体流或者想停止所有通过您启动的媒体流，推荐使用这种方式。
+> 2. 若  `taskId`  填空字符串，将会停止该用户所有通过 startPublishMediaStream 启动的媒体流，如果您只启动了一个媒体流或者想停止所有通过您启动的媒体流，推荐使用这种方式。
 >
 
 ## startLocalPreview:view:
@@ -577,11 +551,10 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 
 > **注意**
 >
-
 > 如果希望开播前预览摄像头画面并通过 BeautyManager 调节美颜参数，您可以：
 >
-> -  方案一：在调用 enterRoom 之前调用 ` startLocalPreview `。
-> -  方案二：在调用 enterRoom 之后调用 ` startLocalPreview + muteLocalVideo(YES) `。
+> -  方案一：在调用 enterRoom 之前调用  `startLocalPreview` 。
+> -  方案二：在调用 enterRoom 之后调用  `startLocalPreview + muteLocalVideo(YES)` 。
 
 ## startLocalPreview:
 
@@ -601,11 +574,10 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 
 > **注意**
 >
-
 > 如果希望开播前预览摄像头画面并通过 BeautyManager 调节美颜参数，您可以：
 >
-> -  方案一：在调用 enterRoom 之前调用 ` startLocalPreview `。
-> -  方案二：在调用 enterRoom 之后调用 ` startLocalPreview + muteLocalVideo(YES) `。
+> -  方案一：在调用 enterRoom 之前调用  `startLocalPreview` 。
+> -  方案二：在调用 enterRoom 之后调用  `startLocalPreview + muteLocalVideo(YES)` 。
 
 ## updateLocalView:
 
@@ -621,11 +593,11 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 
 该接口可以暂停（或恢复）发布本地的视频画面，暂停之后，同一房间中的其他用户将无法继续看到自己画面。
 
-该接口在指定 TRTCVideoStreamTypeBig 时等效于 ` startLocalPreview + stopLocalPreview ` 这两个接口，但具有更好的响应速度。
+该接口在指定 TRTCVideoStreamTypeBig 时等效于  `startLocalPreview + stopLocalPreview`  这两个接口，但具有更好的响应速度。
 
-因为 ` startLocalPreview + stopLocalPreview ` 需要打开和关闭摄像头，而打开和关闭摄像头都是硬件设备相关的操作，非常耗时。
+因为  `startLocalPreview + stopLocalPreview`  需要打开和关闭摄像头，而打开和关闭摄像头都是硬件设备相关的操作，非常耗时。
 
-相比之下，` muteLocalVideo ` 只需要在软件层面对数据流进行暂停或者放行即可，因此效率更高，也更适合需要频繁打开关闭的场景。
+相比之下， `muteLocalVideo`  只需要在软件层面对数据流进行暂停或者放行即可，因此效率更高，也更适合需要频繁打开关闭的场景。
 
 当暂停/恢复发布指定 TRTCVideoStreamTypeBig 后，同一房间中的其他用户将会收到 onUserVideoAvailable 回调通知。
 
@@ -640,7 +612,7 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 
 **设置本地画面被暂停期间的替代图片。**
 
-当您调用 ` muteLocalVideo(YES) ` 暂停本地画面时，您可以通过调用本接口设置一张替代图片，设置后，房间中的其他用户会看到这张替代图片，而不是黑屏画面。
+当您调用  `muteLocalVideo(YES)`  暂停本地画面时，您可以通过调用本接口设置一张替代图片，设置后，房间中的其他用户会看到这张替代图片，而不是黑屏画面。
 
 |参数|描述|
 |---------|---------|
@@ -651,8 +623,8 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 
 **订阅远端用户的视频流，并绑定视频渲染控件。**
 
-调用该接口可以让 SDK 拉取指定 userId 的视频流，并渲染到参数 ` view ` 指定的渲染控件上。您可以通过 setRemoteRenderParams 设置画面的显示模式。
--  如果您已经知道房间中有视频流的用户的 userId，可以直接调用 ` startRemoteView ` 订阅该用户的画面。
+调用该接口可以让 SDK 拉取指定 userId 的视频流，并渲染到参数  `view`  指定的渲染控件上。您可以通过 setRemoteRenderParams 设置画面的显示模式。
+-  如果您已经知道房间中有视频流的用户的 userId，可以直接调用  `startRemoteView`  订阅该用户的画面。
 
 -  如果您不知道房间中有哪些用户在发布视频，您可以在 enterRoom 之后等待来自 onUserVideoAvailable 的通知。
 
@@ -665,16 +637,12 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 
 > **注意**
 >
-
 > 注意几点规则需要您关注：
 >
-
 > 1. SDK 支持同时观看某 userId 的大画面和辅路画面，或者同时观看某 userId 的小画面和辅路画面，但不支持同时观看大画面和小画面。
 >
-
 > 2. 只有当指定的 userId 通过 enableEncSmallVideoStream 开启双路编码后，才能观看该用户的小画面。
 >
-
 > 3. 当指定的 userId 的小画面不存在时，SDK 默认切换到该用户的大画面。
 >
 
@@ -708,7 +676,6 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 
 > **注意**
 >
-
 > 如果当前有正在显示的辅路画面（屏幕分享）也会一并被停止。
 >
 
@@ -725,7 +692,6 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 
 > **注意**
 >
-
 > 该接口支持您在进入房间（enterRoom）前调用，暂停状态在退出房间（exitRoom）之后会被重置。调用该接口暂停接收指定用户的视频流后，只调用 startRemoteView 接口无法播放指定用户的视频，需要调用 muteRemoteVideoStream(NO) 或 muteAllRemoteVideoStreams(NO) 才能恢复。
 >
 
@@ -741,10 +707,8 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 
 > **注意**
 >
-
 > 该接口支持您在进入房间（enterRoom）前调用，暂停状态在退出房间（exitRoom）之后会被重置。
 >
-
 > 调用该接口暂停接收所有用户的视频流后，只调用 startRemoteView 接口无法播放指定用户的视频，需要调用 muteRemoteVideoStream(NO) 或 muteAllRemoteVideoStreams(NO) 才能恢复。
 >
 
@@ -760,7 +724,6 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 
 > **注意**
 >
-
 > 从v11.5版本开始，编码输出分辨率会按照宽8高2字节对齐，并且是向下调整，eg:输入分辨率540x960，实际编码输出分辨率536x960。
 >
 
@@ -811,9 +774,9 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 
 > **注意**
 >
-
 > 双路编码开启后，会消耗更多的 CPU 和 网络带宽，所以 Mac、Windows 或者高性能 Pad 可以考虑开启，不建议手机端开启。
 >
+
 **返回值说明：**
 
 0：成功；-1：当前大画面已被设置为较低画质，开启双路编码已无必要。
@@ -833,7 +796,6 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 
 > **注意**
 >
-
 > 此功能需要目标用户已经通过 enableEncSmallVideoStream 提前开启了双路编码模式，否则此调用无实际效果。
 >
 
@@ -851,7 +813,6 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 
 > **注意**
 >
-
 > Windows 平台目前仅支持截取 TRTCSnapshotSourceTypeStream 来源的视频画面。
 >
 
@@ -892,11 +853,10 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
 开启本地音频的采集和发布后，房间中的其他用户会收到 onUserAudioAvailable(userId, YES) 的通知。
 | 参数 | 描述 |
 | --- | --- |
-| quality | 声音音质<br>- TRTCAudioQualitySpeech，流畅：单声道；音频裸码率：18kbps；适合语音通话为主的场景，例如在线会议，语音通话。<br>- TRTCAudioQualityDefault，默认：单声道；音频裸码率：50kbps；SDK 默认的音频质量，如无特殊需求推荐选择之。<br>- TRTCAudioQualityMusic，高音质：双声道 + 全频带；音频裸码率：128kbps；适合需要高保真传输音乐的场景，例如在线K歌、音乐直播等。 |
+| quality | 声音音质<br>-  TRTCAudioQualitySpeech，流畅：单声道；音频裸码率：18kbps；适合语音通话为主的场景，例如在线会议，语音通话。<br>-  TRTCAudioQualityDefault，默认：单声道；音频裸码率：50kbps；SDK 默认的音频质量，如无特殊需求推荐选择之。<br>-  TRTCAudioQualityMusic，高音质：双声道 + 全频带；音频裸码率：128kbps；适合需要高保真传输音乐的场景，例如在线K歌、音乐直播等。 |
 
 > **注意**
 >
-
 > 该函数会检查麦克风的使用权限，如果当前 App 没有麦克风权限，SDK 会自动向用户申请麦克风使用权限。
 >
 
@@ -914,11 +874,11 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
 
 当您恢复发布本地音频流之后，房间中的其他用户会收到 onUserAudioAvailable(userId, YES) 的通知。
 
-与 stopLocalAudio 的不同之处在于，` muteLocalAudio(YES) ` 并不会释放麦克风权限，而是继续发送码率极低的静音包。
+与 stopLocalAudio 的不同之处在于， `muteLocalAudio(YES)`  并不会释放麦克风权限，而是继续发送码率极低的静音包。
 
 这对于需要云端录制的场景非常适用，因为 MP4 等格式的视频文件，对于音频数据的连续性要求很高，使用 stopLocalAudio 会导致录制出的 MP4 文件不易播放。
 
-因此在对录制文件的质量要求较高的场景中，建议选择 ` muteLocalAudio ` 而不建议使用 stopLocalAudio。
+因此在对录制文件的质量要求较高的场景中，建议选择  `muteLocalAudio`  而不建议使用 stopLocalAudio。
 
 |参数|描述|
 |---------|---------|
@@ -937,7 +897,6 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
 
 > **注意**
 >
-
 > 在进入房间（enterRoom）之前或之后调用本接口均生效，静音状态在退出房间（exitRoom）之后会被重置为 NO。
 >
 
@@ -953,7 +912,6 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
 
 > **注意**
 >
-
 > 在进入房间（enterRoom）之前或之后调用本接口均生效，静音状态在退出房间（exitRoom）之后会被重置为 NO。
 >
 
@@ -977,7 +935,7 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
 
 **设定某一个远端用户的声音播放音量。**
 
-您可以通过 ` setRemoteAudioVolume(userId, 0) ` 将某一个远端用户的声音静音。
+您可以通过  `setRemoteAudioVolume(userId, 0)`  将某一个远端用户的声音静音。
 
 |参数|描述|
 |---------|---------|
@@ -986,8 +944,7 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
 
 > **注意**
 >
-
-> 如果将 ` volume ` 设置成 100 之后感觉音量还是太小，可以将 ` volume ` 最大设置成 150，但超过 100 的 ` volume ` 会有爆音的风险，请谨慎操作。
+> 如果将  `volume`  设置成 100 之后感觉音量还是太小，可以将  `volume`  最大设置成 150，但超过 100 的  `volume`  会有爆音的风险，请谨慎操作。
 >
 
 ## setAudioCaptureVolume:
@@ -1000,13 +957,12 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
 
 > **注意**
 >
-
-> 如果将 ` volume ` 设置成 100 之后感觉音量还是太小，可以将 ` volume ` 最大设置成 150，但超过 100 的 ` volume ` 会有爆音的风险，请谨慎操作。
+> 如果将  `volume`  设置成 100 之后感觉音量还是太小，可以将  `volume`  最大设置成 150，但超过 100 的  `volume`  会有爆音的风险，请谨慎操作。
 >
 
 ## getAudioCaptureVolume
 
-**获取本地音频的采集音量。****返回值说明：**
+**获取本地音频的采集音量。返回值说明：**
 
 采集音量。
 
@@ -1022,7 +978,6 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
 
 > **注意**
 >
-
 > 如果将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150，但超过 100 的 volume 会有爆音的风险，请谨慎操作。
 >
 
@@ -1043,7 +998,6 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
 
 > **注意**
 >
-
 > 如需启用音量大小提示，请在调用 startLocalAudio 之前调用该接口.
 >
 
@@ -1063,9 +1017,9 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
 
 > **注意**
 >
-
 > 自 v11.5 版本，音频录制的状态结果由返回值统一调整为异步回调进行通知。参见 TRTCCloudDelegate 相关回调。
 >
+
 **返回值说明：**
 
 0：成功；-1：录音已开始；-2：文件或目录创建失败；-3：后缀指定的音频格式不支持。
@@ -1127,10 +1081,8 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
 
 > **注意**
 >
-
 > 1. 各参数应分别传入长度为 3 的数组。
 >
-
 > 2. 请适当限制调用频率，推荐两次坐标设置至少间隔 100ms。
 >
 
@@ -1147,10 +1099,8 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
 
 > **注意**
 >
-
 > 1. 各参数应分别传入长度为 3 的数组。
 >
-
 > 2. 请适当限制调用频率，推荐同一远端用户两次坐标设置至少间隔 100ms。
 >
 
@@ -1210,7 +1160,7 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
 
 如果当前视频的编码分辨率是 540 × 960，且 rect 参数设置为（0.1，0.1，0.2，0.0），
 
-那么水印的左上坐标点就是（540 × 0.1，960 × 0.1）即（54，96），水印的宽度是 ` 540 × 0.2 = 108px `，水印的高度会根据水印图片的宽高比由 SDK 自动算出。
+那么水印的左上坐标点就是（540 × 0.1，960 × 0.1）即（54，96），水印的宽度是  `540 × 0.2 = 108px` ，水印的高度会根据水印图片的宽高比由 SDK 自动算出。
 
 |参数|描述|
 |---------|---------|
@@ -1220,8 +1170,7 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
 
 > **注意**
 >
-
-> 如果您要给主画面（一般为摄像头）和辅路画面（一般用作屏幕分享）同时设置水印，需要调用该接口两次，并设定不同的 ` streamType `。
+> 如果您要给主画面（一般为摄像头）和辅路画面（一般用作屏幕分享）同时设置水印，需要调用该接口两次，并设定不同的  `streamType` 。
 >
 
 ## getAudioEffectManager
@@ -1254,10 +1203,8 @@ TXAudioEffectManager 是音效管理接口，您可以通过该接口实现如
 
 > **注意**
 >
-
 > 1. 此功能需要为用户的 Mac 系统安装虚拟音频设备插件，安装完成后，SDK 会从已经安装的虚拟音频设备中采集声音。
 >
-
 > 2. SDK 会自动从网络上下载合适的插件进行安装，但是下载速度可能比较慢，如果您希望加速这个过程，可以将虚拟音频插件文件打包到您 App Bundle 的 Resources 目录下。
 >
 
@@ -1335,23 +1282,19 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 该接口可以抓取整个屏幕的内容，或抓取您指定的某个应用的窗口内容，并将其分享给同房间中的其他用户。
 | 参数 | 描述 |
 | --- | --- |
-| encParam | 屏幕分享的画面编码参数，SDK 会优先使用您通过此接口设置的编码参数：<br>-  如果您设置 <code> encParam </code> 为空值，且您已通过 setSubStreamEncoderParam 设置过辅路视频编码参数，SDK 将使用您设置过的辅路编码参数进行屏幕分享。<br>-  如果您设置 <code> encParam </code> 为空值，且您未通过 setSubStreamEncoderParam 设置过辅路视频编码参数，SDK 将自动选择一个最佳的编码参数进行屏幕分享。 |
+| encParam | 屏幕分享的画面编码参数，SDK 会优先使用您通过此接口设置的编码参数：<br>-  如果您设置  <code>encParam</code>  为空值，且您已通过 setSubStreamEncoderParam 设置过辅路视频编码参数，SDK 将使用您设置过的辅路编码参数进行屏幕分享。<br>-  如果您设置  <code>encParam</code>  为空值，且您未通过 setSubStreamEncoderParam 设置过辅路视频编码参数，SDK 将自动选择一个最佳的编码参数进行屏幕分享。 |
 | streamType | 屏幕分享使用的线路，可以设置为主路（TRTCVideoStreamTypeBig）或者辅路（TRTCVideoStreamTypeSub），推荐使用辅路。 |
 | view | 渲染控件所在的父控件，可以设置为空值，表示不显示屏幕分享的预览效果。 |
 
 > **注意**
 >
-
 > 1. 同一个用户同时最多只能发布一路主路（TRTCVideoStreamTypeBig）画面和一路辅路（TRTCVideoStreamTypeSub）画面。
 >
-
 > 2. 默认情况下，屏幕分享使用辅路画面。如果使用主路做屏幕分享，您需要提前停止摄像头采集（stopLocalPreview）以避免相互冲突。
 >
-
 > 3. 同一个房间中同时只能有一个用户使用辅路做屏幕分享，也就是说，同一个房间中同时只允许一个用户开启辅路。
 >
-
-> 4. 当房间中已经有其他用户在使用辅路分享屏幕时，此时调用该接口会收到来自 TRTCCloudDelegate 的 ` onError(ERR_SERVER_CENTER_ANOTHER_USER_PUSH_SUB_VIDEO) ` 回调。
+> 4. 当房间中已经有其他用户在使用辅路分享屏幕时，此时调用该接口会收到来自 TRTCCloudDelegate 的  `onError(ERR_SERVER_CENTER_ANOTHER_USER_PUSH_SUB_VIDEO)`  回调。
 >
 
 ## stopScreenCapture
@@ -1364,7 +1307,6 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 
 > **注意**
 >
-
 > 从v11.5版本开始，暂停屏幕采集会使用最后一帧按照 1 fps 帧率输出。
 >
 
@@ -1387,9 +1329,9 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 
 > **注意**
 >
-
 > 返回的列表中包含屏幕和应用窗口，屏幕是列表中的第一个元素。如果用户有多个显示器，那么每个显示器都是一个分享目标。
 >
+
 **返回值说明：**
 
 窗口列表包括屏幕。
@@ -1416,9 +1358,9 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 该接口可以设定远端用户所看到的屏幕分享（即辅路）的画面质量，同时也能决定云端录制出的视频文件中屏幕分享的画面质量。
 
 请注意如下两个接口的差异：
-- setVideoEncoderParam 用于设置主路画面（TRTCVideoStreamTypeBig，一般用于摄像头）的视频编码参数。
+-  setVideoEncoderParam 用于设置主路画面（TRTCVideoStreamTypeBig，一般用于摄像头）的视频编码参数。
 
-- setSubStreamEncoderParam 用于设置辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）的视频编码参数。
+-  setSubStreamEncoderParam 用于设置辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）的视频编码参数。
 
 |参数|描述|
 |---------|---------|
@@ -1448,14 +1390,11 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 
 > **注意**
 >
-
 > 1. 该接口只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeScreen 时生效，即只有在分享整个屏幕内容时，排除指定窗口的功能才生效。
 >
-
 > 2. 使用该接口添加到排除列表中的窗口会在退出房间后被 SDK 自动清除。
 >
-
-> 3. Mac 平台下请传入窗口 ID（即 CGWindowID），您可以通过 TRTCScreenCaptureSourceInfo 中的 ` sourceId ` 成员获得。
+> 3. Mac 平台下请传入窗口 ID（即 CGWindowID），您可以通过 TRTCScreenCaptureSourceInfo 中的  `sourceId`  成员获得。
 >
 
 ## removeExcludedShareWindow:
@@ -1484,7 +1423,6 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 
 > **注意**
 >
-
 > 通过该方法添加到包含列表中的窗口，会在退出房间后被 SDK 自动清除。
 >
 
@@ -1551,13 +1489,10 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 
 > **注意**
 >
-
 > 1. 推荐您在采集到的一帧视频帧后，即调用 generateCustomPTS 接口获取该帧的 timestamp 数值，这样可以获得最佳的音画同步效果。
 >
-
 > 2. SDK 最终编码出的视频帧率并不是由您调用本接口的频率决定的，而是由您在 setVideoEncoderParam 中所设置的 FPS 决定的。
 >
-
 > 3. 请尽量保持本接口的调用间隔是均匀的，否则会导致编码器输出帧率不稳或者音画不同步等问题。
 >
 
@@ -1575,7 +1510,6 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 
 > **注意**
 >
-
 > 由于回声抵消（AEC）需要严格的控制声音采集和播放的时间，所以开启自定义音频采集后，AEC 能力可能会失效。
 >
 
@@ -1586,7 +1520,7 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 参数 TRTCAudioFrame 推荐下列填写方式（其他字段不需要填写）：
 -  audioFormat：音频数据格式，仅支持 TRTCAudioFrameFormatPCM。
 
--  data：音频帧 buffer。音频帧数据只支持 PCM 格式，支持 5-100 ms 帧长，推荐使用 20ms 帧长，长度计算方法：48000采样率，单声道的帧长度：` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
+-  data：音频帧 buffer。音频帧数据只支持 PCM 格式，支持 5-100 ms 帧长，推荐使用 20ms 帧长，长度计算方法：48000采样率，单声道的帧长度： `48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节` 。
 
 -  sampleRate：采样率，支持：16000、24000、32000、44100、48000。
 
@@ -1602,7 +1536,6 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 
 > **注意**
 >
-
 > 请您精准地按每帧时长的间隔调用本接口，数据投送间隔不均匀时极易触发声音卡顿。
 >
 
@@ -1619,8 +1552,7 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 
 > **注意**
 >
-
-> 如果您指定参数 ` enablePublish ` 和 ` enablePlayout ` 均为 NO，代表完全关闭您的自定义音轨。
+> 如果您指定参数  `enablePublish`  和  `enablePlayout`  均为 NO，代表完全关闭您的自定义音轨。
 >
 
 ## mixExternalAudioFrame:
@@ -1638,9 +1570,9 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 当您调用该接口后，如果发现返回值大于 100ms，则可以等待一帧音频帧的播放时间之后再次调用；如果返回值小于 100ms，则代表缓冲区比较小，您可以再次混入一些音轨数据以确保音轨缓冲区的大小维持在“安全水位”以上。
 
 参数 TRTCAudioFrame 推荐下列填写方式（其他字段不需要填写）：
--  data：音频帧 buffer。音频帧数据只支持 PCM 格式，支持 5ms - 100ms 帧长，推荐使用 20ms 帧长，长度计算方法：48000采样率, 单声道的帧长度：` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
+-  data：音频帧 buffer。音频帧数据只支持 PCM 格式，支持 5ms - 100ms 帧长，推荐使用 20ms 帧长，长度计算方法：48000采样率, 单声道的帧长度： `48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节` 。
 
--  sampleRate：采样率，支持：16000、32000、44100、48000。
+-  sampleRate：采样率，支持：16000、24000、32000、44100、48000。
 
 -  channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
 
@@ -1652,12 +1584,12 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 
 > **注意**
 >
-
 > 请您精准地按每帧时长的间隔调用本接口，数据投送间隔不均匀时极易触发声音卡顿。
 >
+
 **返回值说明：**
 
->= 0 缓冲的长度，单位：ms。< 0 错误（-1 未启用 ` mixExternalAudioFrame `）
+>= 0 缓冲的长度，单位：ms。< 0 错误（-1 未启用  `mixExternalAudioFrame` ）
 
 ## setMixExternalAudioVolume:playoutVolume:
 
@@ -1739,9 +1671,9 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 
 > **注意**
 >
-
-> 调用此函数之前，需要先调用 ` startRemoteView(nil) ` 来获取远端用户的视频流（view 设置为 nil 即可），否则不会有数据回调出来。
+> 调用此函数之前，需要先调用  `startRemoteView(nil)`  来获取远端用户的视频流（view 设置为 nil 即可），否则不会有数据回调出来。
 >
+
 **返回值说明：**
 
 0：成功；<0：错误（详见 [错误码](https://cloud.tencent.com/document/product/647/32257)）。
@@ -1751,17 +1683,16 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 **设置音频数据自定义回调。**
 
 设置该回调之后，SDK 内部会把音频数据（PCM 格式）回调出来，包括：
-- onCapturedAudioFrame：本地麦克风采集到的音频数据回调
+-  onCapturedAudioFrame：本地麦克风采集到的音频数据回调
 
-- onLocalProcessedAudioFrame：本地采集并经过音频模块前处理后的音频数据回调
+-  onLocalProcessedAudioFrame：本地采集并经过音频模块前处理后的音频数据回调
 
-- onRemoteUserAudioFrame：混音前的每一路远程用户的音频数据
+-  onRemoteUserAudioFrame：混音前的每一路远程用户的音频数据
 
-- onMixedPlayAudioFrame：将各路音频混合之后并最终要由系统播放出的音频数据回调
+-  onMixedPlayAudioFrame：将各路音频混合之后并最终要由系统播放出的音频数据回调
 
 > **注意**
 >
-
 > 设置回调为空即代表停止自定义音频回调，反之，设置回调不为空则代表启动自定义音频回调。
 >
 
@@ -1776,9 +1707,9 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 
 -  samplesPerCall：采样点数，定义回调数据帧长。帧长必须为 10ms 的整数倍。
 
-如果希望用毫秒数计算回调帧长，则将毫秒数转换成采样点数的公式为：` 采样点数 = 毫秒数 * 采样率 / 1000 `。
+如果希望用毫秒数计算回调帧长，则将毫秒数转换成采样点数的公式为： `采样点数 = 毫秒数 * 采样率 / 1000` 。
 
-举例：48000Hz 采样率希望回调 20ms 帧长的数据，则采样点数应该填：` 960 = 20 * 48000 / 1000 `。
+举例：48000Hz 采样率希望回调 20ms 帧长的数据，则采样点数应该填： `960 = 20 * 48000 / 1000` 。
 
 |参数|描述|
 |---------|---------|
@@ -1786,9 +1717,9 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 
 > **注意**
 >
-
-> 最终回调的帧长度是以字节为单位，采样点数转换成字节数的计算公式为：` 字节数 = 采样点数 * channel * 2（位宽） `。举例：48000Hz 采样率，双声道，20ms 帧长，采样点数为 960，字节数为 ` 3840 = 960 * 2 * 2 `。
+> 最终回调的帧长度是以字节为单位，采样点数转换成字节数的计算公式为： `字节数 = 采样点数 * channel * 2（位宽）` 。举例：48000Hz 采样率，双声道，20ms 帧长，采样点数为 960，字节数为  `3840 = 960 * 2 * 2` 。
 >
+
 **返回值说明：**
 
 0：成功；<0：错误。
@@ -1804,9 +1735,9 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 
 -  samplesPerCall：采样点数，定义回调数据帧长。帧长必须为 10ms 的整数倍。
 
-如果希望用毫秒数计算回调帧长，则将毫秒数转换成采样点数的公式为：` 采样点数 = 毫秒数 * 采样率 / 1000 `。
+如果希望用毫秒数计算回调帧长，则将毫秒数转换成采样点数的公式为： `采样点数 = 毫秒数 * 采样率 / 1000` 。
 
-举例：48000Hz 采样率希望回调20ms帧长的数据，则采样点数应该填: ` 960 = 20 * 48000 / 1000 `。
+举例：48000Hz 采样率希望回调20ms帧长的数据，则采样点数应该填:  `960 = 20 * 48000 / 1000` 。
 
 |参数|描述|
 |---------|---------|
@@ -1814,9 +1745,9 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 
 > **注意**
 >
-
-> 最终回调的帧长度是以字节为单位，采样点数转换成字节数的计算公式为：` 字节数 = 采样点数 * channel * 2（位宽） `。 举例：48000Hz 采样率，双声道，20ms 帧长，采样点数为 960，字节数为 ` 3840 = 960 * 2 * 2 `。
+> 最终回调的帧长度是以字节为单位，采样点数转换成字节数的计算公式为： `字节数 = 采样点数 * channel * 2（位宽）` 。 举例：48000Hz 采样率，双声道，20ms 帧长，采样点数为 960，字节数为  `3840 = 960 * 2 * 2` 。
 >
+
 **返回值说明：**
 
 0：成功；<0：错误。
@@ -1832,9 +1763,9 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 
 -  samplesPerCall：采样点数，定义回调数据帧长。帧长必须为 10ms 的整数倍。
 
-如果希望用毫秒数计算回调帧长，则将毫秒数转换成采样点数的公式为：` 采样点数 = 毫秒数 * 采样率 / 1000 `。
+如果希望用毫秒数计算回调帧长，则将毫秒数转换成采样点数的公式为： `采样点数 = 毫秒数 * 采样率 / 1000` 。
 
-举例：48000Hz 采样率希望回调 20ms 帧长的数据，则采样点数应该填: ` 960 = 20 * 48000 / 1000 `。
+举例：48000Hz 采样率希望回调 20ms 帧长的数据，则采样点数应该填:  `960 = 20 * 48000 / 1000` 。
 
 |参数|描述|
 |---------|---------|
@@ -1842,9 +1773,9 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 
 > **注意**
 >
-
-> 最终回调的帧长度是以字节为单位，采样点数转换成字节数的计算公式为：` 字节数 = 采样点数 * channel * 2（位宽） `。 举例：48000Hz 采样率，双声道，20ms 帧长，采样点数为 960，字节数为 ` 3840 = 960 * 2 * 2 `。
+> 最终回调的帧长度是以字节为单位，采样点数转换成字节数的计算公式为： `字节数 = 采样点数 * channel * 2（位宽）` 。 举例：48000Hz 采样率，双声道，20ms 帧长，采样点数为 960，字节数为  `3840 = 960 * 2 * 2` 。
 >
+
 **返回值说明：**
 
 0：成功；<0：错误。
@@ -1863,7 +1794,6 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 
 > **注意**
 >
-
 > 需要您在进入房间前设置才能生效，暂不支持进入房间后再设置。
 >
 
@@ -1880,7 +1810,7 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 
 -  data：用于获取音频数据的 buffer。需要您根据一帧音频帧的帧长度分配好 data 的内存大小。获取的 PCM 数据支持 10ms 或 20ms 两种帧长，推荐使用 20ms 的帧长。
 
-计算公式为：` 采样率 x 播放时长 x 声道数量 x 2（每个样点的字节数） `， 例如： 48000Hz 采样率、单声道、且播放时长为 20ms 的一帧音频帧的 buffer 大小为 ` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
+计算公式为： `采样率 x 播放时长 x 声道数量 x 2（每个样点的字节数）` ， 例如： 48000Hz 采样率、单声道、且播放时长为 20ms 的一帧音频帧的 buffer 大小为  `48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节` 。
 
 |参数|描述|
 |---------|---------|
@@ -1888,13 +1818,10 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 
 > **注意**
 >
-
 > 1. 参数 audioFrame 中的 sampleRate、channel 需提前设置好，同时分配好所需读取帧长的 data 空间。
 >
-
 > 2. SDK 内部会根据 sampleRate 和 channel 自动填充 data 数据。
 >
-
 > 3. 建议由系统的音频播放线程直接驱动该函数的调用，在播放完一帧音频之后，即调用该接口获取下一帧可播放的音频数据。
 >
 
@@ -1915,24 +1842,19 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 
 > **注意**
 >
-
 > 1. 发送消息到房间内所有用户（暂时不支持 Web/小程序端），每秒最多能发送30条消息（与 sendSEIMsg 共享限制）。
 >
-
 > 2. 每个包最大为 1KB，超过则很有可能会被中间路由器或者服务器丢弃。
 >
-
 > 3. 每个客户端每秒最多能发送总计 16KB 数据（与 sendSEIMsg 共享限制）。
 >
-
-> 4. 请将 ` reliable ` 和 ` ordered ` 同时设置为 YES 或同时设置为 NO，暂不支持交叉设置。
+> 4. 请将  `reliable`  和  `ordered`  同时设置为 YES 或同时设置为 NO，暂不支持交叉设置。
 >
-
 > 5. 强烈建议您将不同类型的消息设定为不同的 cmdID，这样可以在要求有序的情况下减小消息时延。
 >
-
 > 6. 目前仅支持主播身份。
 >
+
 **返回值说明：**
 
 YES：消息已经发出；NO：消息发送失败。
@@ -1960,24 +1882,19 @@ YES：消息已经发出；NO：消息发送失败。
 
 > **注意**
 >
-
 > 本接口有以下限制：
 >
-
 > 1. 数据在接口调用完后不会被即时发送出去，而是从下一帧视频帧开始与视频帧一起发送。
 >
-
 > 2. 发送消息到房间内所有用户，每秒最多能发送 40 条消息（与 sendCustomCmdMsg 共享限制）。
 >
-
 > 3. 每个包最大为 1KB，若发送大量数据，会导致视频码率增大，可能导致视频画质下降甚至卡顿（与 sendCustomCmdMsg 共享限制）。
 >
-
 > 4. 每个客户端每秒最多能发送总计 16KB 数据（与 sendCustomCmdMsg 共享限制）。
 >
-
 > 5. 若指定多次发送（repeatCount > 1），则数据会被带在后续的连续 repeatCount 个视频帧中发送出去，同样会导致视频码率增大。接收消息 onRecvSEIMsg 回调也可能会收到多次相同的消息，需要去重。
 >
+
 **返回值说明：**
 
 YES：消息已通过限制，等待后续视频帧发送；NO：消息被限制发送
@@ -1992,15 +1909,13 @@ YES：消息已通过限制，等待后续视频帧发送；NO：消息被限制
 
 > **注意**
 >
-
 > 1. 测速过程将产生少量的基础服务费用，详见 [计费概述 > 基础服务](https://cloud.tencent.com/document/product/647/17157#.E5.9F.BA.E7.A1.80.E6.9C.8D.E5.8A.A1) 文档说明。
 >
-
 > 2. 请在进入房间前进行网速测试，在房间中网速测试会影响正常的音视频传输效果，而且由于干扰过多，网速测试结果也不准确。
 >
-
 > 3. 同一时间只允许一项网速测试任务运行。
 >
+
 **返回值说明：**
 
 接口调用结果，< 0：失败
@@ -2058,7 +1973,6 @@ YES：消息已通过限制，等待后续视频帧发送；NO：消息被限制
 
 > **注意**
 >
-
 > 请务必在所有其他接口之前调用，并且保证您指定的目录是存在的，并且您的应用程序拥有对该目录的读写权限。
 >
 
@@ -2084,7 +1998,7 @@ YES：消息已通过限制，等待后续视频帧发送；NO：消息被限制
 
 |参数|描述|
 |---------|---------|
-|margin|仪表盘内边距，注意这里是基于 parentView 的百分比，` margin ` 的取值范围是 [0, 1]。|
+|margin|仪表盘内边距，注意这里是基于 parentView 的百分比， `margin`  的取值范围是 [0, 1]。|
 |userId|用户 ID。|
 
 ## callExperimentalAPI:
@@ -2095,7 +2009,7 @@ YES：消息已通过限制，等待后续视频帧发送；NO：消息被限制
 
 **开启或关闭媒体流私有加密。**
 
-在安全要求较高的场景下，TRTC 建议您在加入房间前，调用 ` enablePayloadPrivateEncryption ` 方法开启媒体流私有加密。
+在安全要求较高的场景下，TRTC 建议您在加入房间前，调用  `enablePayloadPrivateEncryption`  方法开启媒体流私有加密。
 
 用户退出房间后，SDK 会自动关闭私有加密。如需重新开启私有加密，您需要在用户再次加入房间前调用该方法。
 
@@ -2106,7 +2020,7 @@ YES：消息已通过限制，等待后续视频帧发送；NO：消息被限制
 
 > **注意**
 >
-
 > TRTC 已经内置对媒体流进行加密后再传输，启用媒体流私有加密后将使用您传入的密钥与初始向量进行再次加密。
 >
+
 **返回值说明：**