@tencentcloud/sdk-mcp 1.7.7 → 1.7.9-beta.1

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

@@ -4,7 +4,7 @@ Module:   TRTCCloud @ TXLiteAVSDK
 
 Function: 腾讯云 TRTC 主功能接口
 
-Version: 13.4
+Version: 13.5
 
 ## TRTCCloud
 
@@ -180,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)。
 
 |参数|描述|
 |---------|---------|
@@ -219,7 +219,7 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
 您可以在进入房间时通过 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 万名观众。 |
 
 > **注意**
 >
@@ -239,8 +239,8 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
 您可以在进入房间时通过 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 万名观众。 |
 
 > **注意**
 >
@@ -254,9 +254,9 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
 **切换房间。**
 
 使用该接口可以让用户快速从一个房间切换到另一个房间。
--  如果用户的身份是“观众”，该接口的调用效果等同于  `exitRoom(当前房间) + enterRoom（新的房间）` 。
+- 如果用户的身份是“观众”，该接口的调用效果等同于  `exitRoom(当前房间) + enterRoom（新的房间）` 。
 
--  如果用户的身份是“主播”，该接口在切换房间的同时还会保持自己的音视频发布状态，因此在房间切换过程中，摄像头的预览和声音的采集都不会中断。
+- 如果用户的身份是“主播”，该接口在切换房间的同时还会保持自己的音视频发布状态，因此在房间切换过程中，摄像头的预览和声音的采集都不会中断。
 
 该接口适用于在线教育场景中，监课老师在多个房间中进行快速切换的场景。在该场景下使用  `switchRoom`  可以获得比  `exitRoom + enterRoom`  更好的流畅性和更少的代码量。
 
@@ -288,9 +288,9 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
 跨房通话的请求结果会通过 TRTCCloudDelegate 中的 onConnectOtherRoom 回调通知给您。
 
 例如：当房间“101”中的主播 A 通过  `connectOtherRoom()`  跟房间“102”中的主播 B 建立跨房通话后，
--  房间“101”中的用户都会收到主播 B 的  `onRemoteUserEnterRoom(B)`  和  `onUserVideoAvailable(B,YES)`  这两个事件回调，即房间“101”中的用户都可以订阅主播 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 格式的参数：
 
@@ -337,9 +337,9 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
 **设置订阅模式（需要在进入房前设置才能生效）。**
 
 您可以通过该接口在“自动订阅”和“手动订阅”两种模式下进行切换：
--  自动订阅：默认模式，用户在进入房间后会立刻接收到该房间中的音视频流，音频会自动播放，视频会自动开始解码（依然需要您通过 startRemoteView 接口绑定渲染控件）。
+- 自动订阅：默认模式，用户在进入房间后会立刻接收到该房间中的音视频流，音频会自动播放，视频会自动开始解码（依然需要您通过 startRemoteView 接口绑定渲染控件）。
 
--  手动订阅：在用户进入房间后，需要手动调用 startRemoteView 接口才能启动视频流的订阅和解码，需要手动调用 muteRemoteAudio (NO) 接口才能启动声音的播放。
+- 手动订阅：在用户进入房间后，需要手动调用 startRemoteView 接口才能启动视频流的订阅和解码，需要手动调用 muteRemoteAudio (NO) 接口才能启动声音的播放。
 
 在绝大多数场景下，用户进入房间后都会订阅房间中所有主播的音视频流，因此 TRTC 默认采用了自动订阅模式，以求得最佳的“秒开体验”。
 
@@ -405,8 +405,8 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 >
 > 4. 同一个用户可以在多个 TRTCCloud 实例中推流，也可以调用子实例中与本地音视频相关的接口。但需要注意：
 >
-> -  多实例的音频需要同时为麦克风采集或自定义采集，而且与音频设备相关的接口调用会以最后一次为准；
-> -  与摄像头相关的调用会以最后一次为准：startLocalPreview。
+> - 多实例的音频需要同时为麦克风采集或自定义采集，而且与音频设备相关的接口调用会以最后一次为准；
+> - 与摄像头相关的调用会以最后一次为准：startLocalPreview。
 
 **返回值说明：**
 
@@ -437,12 +437,12 @@ 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 的音频。
+- 主播 C 的视频流将不受影响。房间“102”中的其他观众也不受影响，可以正常订阅主播 C 的音频。
 
 该接口的参数考虑到后续扩展字段的兼容性问题，暂时采用了 JSON 格式的参数，示例如下：
 
@@ -553,8 +553,8 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 >
 > 如果希望开播前预览摄像头画面并通过 BeautyManager 调节美颜参数，您可以：
 >
-> -  方案一：在调用 enterRoom 之前调用  `startLocalPreview` 。
-> -  方案二：在调用 enterRoom 之后调用  `startLocalPreview + muteLocalVideo(YES)` 。
+> - 方案一：在调用 enterRoom 之前调用  `startLocalPreview` 。
+> - 方案二：在调用 enterRoom 之后调用  `startLocalPreview + muteLocalVideo(YES)` 。
 
 ## startLocalPreview:
 
@@ -576,8 +576,8 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 >
 > 如果希望开播前预览摄像头画面并通过 BeautyManager 调节美颜参数，您可以：
 >
-> -  方案一：在调用 enterRoom 之前调用  `startLocalPreview` 。
-> -  方案二：在调用 enterRoom 之后调用  `startLocalPreview + muteLocalVideo(YES)` 。
+> - 方案一：在调用 enterRoom 之前调用  `startLocalPreview` 。
+> - 方案二：在调用 enterRoom 之后调用  `startLocalPreview + muteLocalVideo(YES)` 。
 
 ## updateLocalView:
 
@@ -624,14 +624,14 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 **订阅远端用户的视频流，并绑定视频渲染控件。**
 
 调用该接口可以让 SDK 拉取指定 userId 的视频流，并渲染到参数  `view`  指定的渲染控件上。您可以通过 setRemoteRenderParams 设置画面的显示模式。
--  如果您已经知道房间中有视频流的用户的 userId，可以直接调用  `startRemoteView`  订阅该用户的画面。
+- 如果您已经知道房间中有视频流的用户的 userId，可以直接调用  `startRemoteView`  订阅该用户的画面。
 
--  如果您不知道房间中有哪些用户在发布视频，您可以在 enterRoom 之后等待来自 onUserVideoAvailable 的通知。
+- 如果您不知道房间中有哪些用户在发布视频，您可以在 enterRoom 之后等待来自 onUserVideoAvailable 的通知。
 
 调用本接口只是启动视频流的拉取，此时画面还需要加载和缓冲，当缓冲完毕后您会收到来自 onFirstVideoFrame 的通知。
 | 参数 | 描述 |
 | --- | --- |
-| streamType | 指定要观看 userId 的视频流类型。<br>-  高清大画面：TRTCVideoStreamTypeBig。<br>-  低清小画面：TRTCVideoStreamTypeSmall（需要远端用户通过 enableEncSmallVideoStream 开启双路编码后才有效果）。<br>-  辅流画面（常用于屏幕分享）：TRTCVideoStreamTypeSub。 |
+| streamType | 指定要观看 userId 的视频流类型。<br>- 高清大画面：TRTCVideoStreamTypeBig。<br>- 低清小画面：TRTCVideoStreamTypeSmall（需要远端用户通过 enableEncSmallVideoStream 开启双路编码后才有效果）。<br>- 辅流画面（常用于屏幕分享）：TRTCVideoStreamTypeSub。 |
 | userId | 指定远端用户的 ID。 |
 | view | 用于承载视频画面的渲染控件。 |
 
@@ -665,7 +665,7 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 调用此接口会让 SDK 停止接收该用户的视频流，并释放该路视频流的解码和渲染资源。
 | 参数 | 描述 |
 | --- | --- |
-| streamType | 指定要观看 userId 的视频流类型。<br>-  高清大画面：TRTCVideoStreamTypeBig。<br>-  低清小画面：TRTCVideoStreamTypeSmall。<br>-  辅流画面（常用于屏幕分享）：TRTCVideoStreamTypeSub。 |
+| streamType | 指定要观看 userId 的视频流类型。<br>- 高清大画面：TRTCVideoStreamTypeBig。<br>- 低清小画面：TRTCVideoStreamTypeSmall。<br>- 辅流画面（常用于屏幕分享）：TRTCVideoStreamTypeSub。 |
 | userId | 指定远端用户的 ID。 |
 
 ## stopAllRemoteView
@@ -687,7 +687,7 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 | 参数 | 描述 |
 | --- | --- |
 | mute | 是否暂停接收。 |
-| streamType | 要暂停/恢复的视频流类型。<br>-  高清大画面：TRTCVideoStreamTypeBig。<br>-  低清小画面：TRTCVideoStreamTypeSmall。<br>-  辅流画面（常用于屏幕分享）：TRTCVideoStreamTypeSub。 |
+| streamType | 要暂停/恢复的视频流类型。<br>- 高清大画面：TRTCVideoStreamTypeBig。<br>- 低清小画面：TRTCVideoStreamTypeSmall。<br>- 辅流画面（常用于屏幕分享）：TRTCVideoStreamTypeSub。 |
 | userId | 指定远端用户的 ID。 |
 
 > **注意**
@@ -853,7 +853,7 @@ 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歌、音乐直播等。 |
 
 > **注意**
 >
@@ -1128,17 +1128,17 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
 **获取美颜管理类（TXBeautyManager）。**
 
 通过美颜管理，您可以使用以下功能：
--  设置“磨皮”、“美白”、“红润”等美颜特效。
+- 设置“磨皮”、“美白”、“红润”等美颜特效。
 
--  以下功能仅iOS/Android支持：
+- 以下功能仅iOS/Android支持：
 
--  设置“大眼”、“瘦脸”、“V脸”、“下巴”、“短脸”、“小鼻”、“亮眼”、“白牙”、“祛眼袋”、“祛皱纹”、“祛法令纹”等修脸特效。
+- 设置“大眼”、“瘦脸”、“V脸”、“下巴”、“短脸”、“小鼻”、“亮眼”、“白牙”、“祛眼袋”、“祛皱纹”、“祛法令纹”等修脸特效。
 
--  设置“发际线”、“眼间距”、“眼角”、“嘴形”、“鼻翼”、“鼻子位置”、“嘴唇厚度”、“脸型”等修脸特效。
+- 设置“发际线”、“眼间距”、“眼角”、“嘴形”、“鼻翼”、“鼻子位置”、“嘴唇厚度”、“脸型”等修脸特效。
 
--  设置“眼影”、“腮红”等美妆特效。
+- 设置“眼影”、“腮红”等美妆特效。
 
--  设置动态贴纸和人脸挂件等动画特效。
+- 设置动态贴纸和人脸挂件等动画特效。
 **返回值说明：**
 
 美颜管理类 TXBeautyManager。
@@ -1148,13 +1148,13 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
 **添加水印。**
 
 水印的位置是通过 rect 参数来指定的，rect 是一个四元组参数，其格式为 (x，y，width，height)
--  x：水印的坐标，取值范围为 [0, 1] 的浮点数。
+- x：水印的坐标，取值范围为 [0, 1] 的浮点数。
 
--  y：水印的坐标，取值范围为 [0, 1] 的浮点数。
+- y：水印的坐标，取值范围为 [0, 1] 的浮点数。
 
--  width：水印的宽度，取值范围为 [0, 1] 的浮点数。
+- width：水印的宽度，取值范围为 [0, 1] 的浮点数。
 
--  height：是不用设置的，SDK 内部会根据水印图片的宽高比自动计算一个合适的高度。
+- height：是不用设置的，SDK 内部会根据水印图片的宽高比自动计算一个合适的高度。
 
 参数设置举例：
 
@@ -1178,15 +1178,15 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
 **获取音效管理类（TXAudioEffectManager）。**
 
 TXAudioEffectManager 是音效管理接口，您可以通过该接口实现如下功能：
--  背景音乐：支持在线音乐和本地音乐，支持变速、变调等特效、支持原生和伴奏并播放和循环播放。
+- 背景音乐：支持在线音乐和本地音乐，支持变速、变调等特效、支持原生和伴奏并播放和循环播放。
 
--  耳机耳返：麦克风捕捉的声音实时通过耳机播放，常用于音乐直播。
+- 耳机耳返：麦克风捕捉的声音实时通过耳机播放，常用于音乐直播。
 
--  混响效果：KTV、小房间、大会堂、低沉、洪亮等。
+- 混响效果：KTV、小房间、大会堂、低沉、洪亮等。
 
--  变声特效：萝莉、大叔、重金属等。
+- 变声特效：萝莉、大叔、重金属等。
 
--  短音效：鼓掌声、欢笑声等简短的音效文件（对于小于10秒的文件，请将 isShortFile 参数设置为 YES）。
+- 短音效：鼓掌声、欢笑声等简短的音效文件（对于小于10秒的文件，请将 isShortFile 参数设置为 YES）。
 **返回值说明：**
 
 音效管理类 TXAudioEffectManager。
@@ -1237,13 +1237,13 @@ AI 转录管理类 AITranscriberManager。
 如果您希望抓取整个 iOS 系统的屏幕内容（而不受当前应用的限制），推荐使用 startScreenCaptureByReplaykit。
 
 iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
--  分辨率(videoResolution): 1280 x 720。
+- 分辨率(videoResolution): 1280 x 720。
 
--  帧率(videoFps): 10 FPS。
+- 帧率(videoFps): 10 FPS。
 
--  码率(videoBitrate): 1600 kbps。
+- 码率(videoBitrate): 1600 kbps。
 
--  分辨率自适应(enableAdjustRes): NO。
+- 分辨率自适应(enableAdjustRes): NO。
 
 | 参数 | 描述 |
 | --- | --- |
@@ -1261,13 +1261,13 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 参考文档：[实时屏幕分享(iOS)](https://cloud.tencent.com/document/product/647/45750)
 
 iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
--  分辨率(videoResolution)：1280 x 720。
+- 分辨率(videoResolution)：1280 x 720。
 
--  帧率(videoFps)：10 FPS。
+- 帧率(videoFps)：10 FPS。
 
--  码率(videoBitrate)：1600 kbps。
+- 码率(videoBitrate)：1600 kbps。
 
--  分辨率自适应(enableAdjustRes)：NO。
+- 分辨率自适应(enableAdjustRes)：NO。
 
 |参数|描述|
 |---------|---------|
@@ -1282,7 +1282,7 @@ 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 | 渲染控件所在的父控件，可以设置为空值，表示不显示屏幕分享的预览效果。 |
 
@@ -1358,9 +1358,9 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 该接口可以设定远端用户所看到的屏幕分享（即辅路）的画面质量，同时也能决定云端录制出的视频文件中屏幕分享的画面质量。
 
 请注意如下两个接口的差异：
--  setVideoEncoderParam 用于设置主路画面（TRTCVideoStreamTypeBig，一般用于摄像头）的视频编码参数。
+- setVideoEncoderParam 用于设置主路画面（TRTCVideoStreamTypeBig，一般用于摄像头）的视频编码参数。
 
--  setSubStreamEncoderParam 用于设置辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）的视频编码参数。
+- setSubStreamEncoderParam 用于设置辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）的视频编码参数。
 
 |参数|描述|
 |---------|---------|
@@ -1466,19 +1466,19 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 使用此接口可以向 SDK 投送自己采集的视频帧，SDK 会将视频帧进行编码并通过自身的网络模块传输出去。
 
 参数 TRTCVideoFrame 推荐下列填写方式（其他字段不需要填写）：
--  pixelFormat：推荐选择 TRTCVideoPixelFormat_NV12。
+- pixelFormat：推荐选择 TRTCVideoPixelFormat_NV12。
 
--  bufferType：推荐选择 TRTCVideoBufferType_PixelBuffer。
+- bufferType：推荐选择 TRTCVideoBufferType_PixelBuffer。
 
--  pixelBuffer：iOS/Mac OS 平台上常用的视频数据格式。
+- pixelBuffer：iOS/Mac OS 平台上常用的视频数据格式。
 
--  data：视频裸数据格式，bufferType 为 NSData 时使用。
+- data：视频裸数据格式，bufferType 为 NSData 时使用。
 
--  timestamp：时间戳，单位为毫秒（ms），请使用视频帧在采集时被记录下来的时间戳（可以在采集到一帧视频帧之后，通过调用 generateCustomPTS 获取时间戳）。
+- timestamp：时间戳，单位为毫秒（ms），请使用视频帧在采集时被记录下来的时间戳（可以在采集到一帧视频帧之后，通过调用 generateCustomPTS 获取时间戳）。
 
--  width：视频图像长度，bufferType 为 NSData 时填写。
+- width：视频图像长度，bufferType 为 NSData 时填写。
 
--  height：视频图像宽度，bufferType 为 NSData 时填写。
+- height：视频图像宽度，bufferType 为 NSData 时填写。
 
 参考文档：[自定义采集和渲染](https://cloud.tencent.com/document/product/647/34066)。
 
@@ -1518,15 +1518,15 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 **向 SDK 投送自己采集的音频数据。**
 
 参数 TRTCAudioFrame 推荐下列填写方式（其他字段不需要填写）：
--  audioFormat：音频数据格式，仅支持 TRTCAudioFrameFormatPCM。
+- 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。
+- sampleRate：采样率，支持：16000、24000、32000、44100、48000。
 
--  channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
+- channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
 
--  timestamp：时间戳，单位为毫秒（ms），请使用音频帧在采集时被记录下来的时间戳（可以在采集到一帧音频帧之后，通过调用 generateCustomPTS 获取时间戳）。
+- timestamp：时间戳，单位为毫秒（ms），请使用音频帧在采集时被记录下来的时间戳（可以在采集到一帧音频帧之后，通过调用 generateCustomPTS 获取时间戳）。
 
 参考文档：[自定义采集和渲染](https://cloud.tencent.com/document/product/647/74692)。
 
@@ -1570,13 +1570,13 @@ 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、24000、32000、44100、48000。
+- sampleRate：采样率，支持：16000、24000、32000、44100、48000。
 
--  channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
+- channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
 
--  timestamp：时间戳，单位为毫秒（ms），请使用音频帧在采集时被记录下来的时间戳（可以在获得一帧音频帧之后，通过调用 generateCustomPTS 获得时间戳）。
+- timestamp：时间戳，单位为毫秒（ms），请使用音频帧在采集时被记录下来的时间戳（可以在获得一帧音频帧之后，通过调用 generateCustomPTS 获得时间戳）。
 
 |参数|描述|
 |---------|---------|
@@ -1636,9 +1636,9 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 **设置本地视频自定义渲染回调。**
 
 设置该回调之后，SDK 内部会跳过原来的渲染流程，并把采集到的数据回调出来，您需要自己完成画面渲染。
--  pixelFormat 指定回调的数据格式，例如 NV12、i420 以及 32BGRA。
+- pixelFormat 指定回调的数据格式，例如 NV12、i420 以及 32BGRA。
 
--  bufferType 指定 buffer 的类型，直接使用 PixelBuffer 效率最高；使用 NSData 相当于让 SDK 在内部做了一次内存转换，因此会有额外的性能损耗。
+- bufferType 指定 buffer 的类型，直接使用 PixelBuffer 效率最高；使用 NSData 相当于让 SDK 在内部做了一次内存转换，因此会有额外的性能损耗。
 
 参考文档：[自定义采集和渲染](https://cloud.tencent.com/document/product/647/34066)。
 
@@ -1656,9 +1656,9 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 **设置远端视频自定义渲染回调。**
 
 设置该回调之后，SDK 内部会跳过原来的渲染流程，并把采集到的数据回调出来，您需要自己完成画面渲染。
--  pixelFormat 指定回调的数据格式，例如 NV12、i420 以及 32BGRA。
+- pixelFormat 指定回调的数据格式，例如 NV12、i420 以及 32BGRA。
 
--  bufferType 指定 buffer 的类型，直接使用 PixelBuffer 效率最高；使用 NSData 相当于让 SDK 在内部做了一次内存转换，因此会有额外的性能损耗。
+- bufferType 指定 buffer 的类型，直接使用 PixelBuffer 效率最高；使用 NSData 相当于让 SDK 在内部做了一次内存转换，因此会有额外的性能损耗。
 
 参考文档：[自定义采集和渲染](https://cloud.tencent.com/document/product/647/34066)。
 
@@ -1683,13 +1683,13 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 **设置音频数据自定义回调。**
 
 设置该回调之后，SDK 内部会把音频数据（PCM 格式）回调出来，包括：
--  onCapturedAudioFrame：本地麦克风采集到的音频数据回调
+- onCapturedAudioFrame：本地麦克风采集到的音频数据回调
 
--  onLocalProcessedAudioFrame：本地采集并经过音频模块前处理后的音频数据回调
+- onLocalProcessedAudioFrame：本地采集并经过音频模块前处理后的音频数据回调
 
--  onRemoteUserAudioFrame：混音前的每一路远程用户的音频数据
+- onRemoteUserAudioFrame：混音前的每一路远程用户的音频数据
 
--  onMixedPlayAudioFrame：将各路音频混合之后并最终要由系统播放出的音频数据回调
+- onMixedPlayAudioFrame：将各路音频混合之后并最终要由系统播放出的音频数据回调
 
 > **注意**
 >
@@ -1701,11 +1701,11 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 **设置本地麦克风采集出的音频帧回调格式。**
 
 本接口用于设置 onCapturedAudioFrame 回调出来的 AudioFrame 的格式：
--  sampleRate：采样率，支持：16000、32000、44100、48000。
+- sampleRate：采样率，支持：16000、32000、44100、48000。
 
--  channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
+- channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
 
--  samplesPerCall：采样点数，定义回调数据帧长。帧长必须为 10ms 的整数倍。
+- samplesPerCall：采样点数，定义回调数据帧长。帧长必须为 10ms 的整数倍。
 
 如果希望用毫秒数计算回调帧长，则将毫秒数转换成采样点数的公式为： `采样点数 = 毫秒数 * 采样率 / 1000` 。
 
@@ -1729,11 +1729,11 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 **设置经过前处理后的本地音频帧回调格式。**
 
 本接口用于设置 onLocalProcessedAudioFrame 回调出来的 AudioFrame 的格式：
--  sampleRate：采样率，支持：16000、32000、44100、48000。
+- sampleRate：采样率，支持：16000、32000、44100、48000。
 
--  channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
+- channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
 
--  samplesPerCall：采样点数，定义回调数据帧长。帧长必须为 10ms 的整数倍。
+- samplesPerCall：采样点数，定义回调数据帧长。帧长必须为 10ms 的整数倍。
 
 如果希望用毫秒数计算回调帧长，则将毫秒数转换成采样点数的公式为： `采样点数 = 毫秒数 * 采样率 / 1000` 。
 
@@ -1757,11 +1757,11 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 **设置最终要由系统播放出的音频帧回调格式。**
 
 本接口用于设置 onMixedPlayAudioFrame 回调出来的 AudioFrame 的格式：
--  sampleRate：采样率，支持：16000、32000、44100、48000。
+- sampleRate：采样率，支持：16000、32000、44100、48000。
 
--  channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
+- channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
 
--  samplesPerCall：采样点数，定义回调数据帧长。帧长必须为 10ms 的整数倍。
+- samplesPerCall：采样点数，定义回调数据帧长。帧长必须为 10ms 的整数倍。
 
 如果希望用毫秒数计算回调帧长，则将毫秒数转换成采样点数的公式为： `采样点数 = 毫秒数 * 采样率 / 1000` 。
 
@@ -1804,11 +1804,11 @@ iPhone 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
 调用该接口之前，您需要先通过 enableCustomAudioRendering 开启音频自定义播放。
 
 参数 TRTCAudioFrame 推荐下列填写方式（其他字段不需要填写）：
--  sampleRate：采样率，必填，支持 16000、24000、32000、44100、48000。
+- sampleRate：采样率，必填，支持 16000、24000、32000、44100、48000。
 
--  channel：声道数，必填，单声道请填1，双声道请填2，双声道时数据是交叉的。
+- channel：声道数，必填，单声道请填1，双声道请填2，双声道时数据是交叉的。
 
--  data：用于获取音频数据的 buffer。需要您根据一帧音频帧的帧长度分配好 data 的内存大小。获取的 PCM 数据支持 10ms 或 20ms 两种帧长，推荐使用 20ms 的帧长。
+- data：用于获取音频数据的 buffer。需要您根据一帧音频帧的帧长度分配好 data 的内存大小。获取的 PCM 数据支持 10ms 或 20ms 两种帧长，推荐使用 20ms 的帧长。
 
 计算公式为： `采样率 x 播放时长 x 声道数量 x 2（每个样点的字节数）` ， 例如： 48000Hz 采样率、单声道、且播放时长为 20ms 的一帧音频帧的 buffer 大小为  `48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节` 。
 
@@ -1909,7 +1909,7 @@ YES：消息已通过限制，等待后续视频帧发送；NO：消息被限制
 
 > **注意**
 >
-> 1. 测速过程将产生少量的基础服务费用，详见 [计费概述 > 基础服务](https://cloud.tencent.com/document/product/647/17157#.E5.9F.BA.E7.A1.80.E6.9C.8D.E5.8A.A1) 文档说明。
+> 1. 测速过程将产生少量的基础服务费用，详见 [计费概述 > 基础服务](https://cloud.tencent.com/document/product/647/17157) 文档说明。
 >
 > 2. 请在进入房间前进行网速测试，在房间中网速测试会影响正常的音视频传输效果，而且由于干扰过多，网速测试结果也不准确。
 >
@@ -1961,11 +1961,11 @@ YES：消息已通过限制，等待后续视频帧发送；NO：消息被限制
 **设置本地日志的保存路径。**
 
 通过该接口您可以更改 SDK 本地日志的默认存储路径，SDK 默认的本地日志的存储位置：
--  Windows 平台：在 C:/Users/[系统用户名]/AppData/Roaming/liteav/log，即 %appdata%/liteav/log 下。
+- Windows 平台：在 C:/Users/[系统用户名]/AppData/Roaming/liteav/log，即 %appdata%/liteav/log 下。
 
--  iOS 或 Mac 平台：在 sandbox Documents/log 下。
+- iOS 或 Mac 平台：在 sandbox Documents/log 下。
 
--  Android 平台：在 /app私有目录/files/log/liteav/ 下。
+- Android 平台：在 /app私有目录/files/log/liteav/ 下。
 
 |参数|描述|
 |---------|---------|