@tencentcloud/sdk-mcp 1.7.7 → 1.7.8

package/resource/knowledge/trtc/c++/ITRTCCloud.md

@@ -4,7 +4,7 @@ Module:   TRTCCloud @ TXLiteAVSDK
 
 Function: 腾讯云 TRTC 主功能接口
 
-Version: 13.4
+Version: 13.5
 
 ## ITRTCCloud
 
@@ -169,9 +169,9 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
 包括 TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom 两个可选项，分别是视频直播和语音直播，该模式适合十万人以内的在线直播场景，但需要您在接下来介绍的 TRTCParams 参数中指定 **角色(role)** 这个字段，也就是将房间中的用户区分为 **主播** (TRTCRoleAnchor) 和 **观众** (TRTCRoleAudience) 两种不同的角色。
 
 调用该接口后，您会收到来自 ITRTCCloudCallback 中的 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)。
 
 |参数|描述|
 |---------|---------|
@@ -208,7 +208,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 万名观众。 |
 
 > **注意**
 >
@@ -228,8 +228,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 万名观众。 |
 
 > **注意**
 >
@@ -243,9 +243,9 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
 **切换房间。**
 
 使用该接口可以让用户快速从一个房间切换到另一个房间。
--  如果用户的身份是“观众”，该接口的调用效果等同于  `exitRoom(当前房间) + enterRoom（新的房间）` 。
+- 如果用户的身份是“观众”，该接口的调用效果等同于  `exitRoom(当前房间) + enterRoom（新的房间）` 。
 
--  如果用户的身份是“主播”，该接口在切换房间的同时还会保持自己的音视频发布状态，因此在房间切换过程中，摄像头的预览和声音的采集都不会中断。
+- 如果用户的身份是“主播”，该接口在切换房间的同时还会保持自己的音视频发布状态，因此在房间切换过程中，摄像头的预览和声音的采集都不会中断。
 
 该接口适用于在线教育场景中，监课老师在多个房间中进行快速切换的场景。在该场景下使用  `switchRoom`  可以获得比  `exitRoom + enterRoom`  更好的流畅性和更少的代码量。
 
@@ -277,9 +277,9 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
 跨房通话的请求结果会通过 ITRTCCloudCallback 中的 onConnectOtherRoom 回调通知给您。
 
 例如：当房间“101”中的主播 A 通过  `connectOtherRoom()`  跟房间“102”中的主播 B 建立跨房通话后，
--  房间“101”中的用户都会收到主播 B 的  `onRemoteUserEnterRoom(B)`  和  `onUserVideoAvailable(B,true)`  这两个事件回调，即房间“101”中的用户都可以订阅主播 B 的音视频。
+- 房间“101”中的用户都会收到主播 B 的  `onRemoteUserEnterRoom(B)`  和  `onUserVideoAvailable(B,true)`  这两个事件回调，即房间“101”中的用户都可以订阅主播 B 的音视频。
 
--  房间“102”中的用户都会收到主播 A 的  `onRemoteUserEnterRoom(A)`  和  `onUserVideoAvailable(A,true)`  这两个事件回调，即房间“102”中的用户都可以订阅主播 A 的音视频。
+- 房间“102”中的用户都会收到主播 A 的  `onRemoteUserEnterRoom(A)`  和  `onUserVideoAvailable(A,true)`  这两个事件回调，即房间“102”中的用户都可以订阅主播 A 的音视频。
 
 跨房通话的参数考虑到后续扩展字段的兼容性问题，暂时采用了 JSON 格式的参数：
 
@@ -326,9 +326,9 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
 **设置订阅模式（需要在进入房前设置才能生效）。**
 
 您可以通过该接口在“自动订阅”和“手动订阅”两种模式下进行切换：
--  自动订阅：默认模式，用户在进入房间后会立刻接收到该房间中的音视频流，音频会自动播放，视频会自动开始解码（依然需要您通过 startRemoteView 接口绑定渲染控件）。
+- 自动订阅：默认模式，用户在进入房间后会立刻接收到该房间中的音视频流，音频会自动播放，视频会自动开始解码（依然需要您通过 startRemoteView 接口绑定渲染控件）。
 
--  手动订阅：在用户进入房间后，需要手动调用 startRemoteView 接口才能启动视频流的订阅和解码，需要手动调用 muteRemoteAudio (false) 接口才能启动声音的播放。
+- 手动订阅：在用户进入房间后，需要手动调用 startRemoteView 接口才能启动视频流的订阅和解码，需要手动调用 muteRemoteAudio (false) 接口才能启动声音的播放。
 
 在绝大多数场景下，用户进入房间后都会订阅房间中所有主播的音视频流，因此 TRTC 默认采用了自动订阅模式，以求得最佳的“秒开体验”。
 
@@ -394,8 +394,8 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 >
 > 4. 同一个用户可以在多个 TRTCCloud 实例中推流，也可以调用子实例中与本地音视频相关的接口。但需要注意：
 >
-> -  多实例的音频需要同时为麦克风采集或自定义采集，而且与音频设备相关的接口调用会以最后一次为准；
-> -  与摄像头相关的调用会以最后一次为准：startLocalPreview。
+> - 多实例的音频需要同时为麦克风采集或自定义采集，而且与音频设备相关的接口调用会以最后一次为准；
+> - 与摄像头相关的调用会以最后一次为准：startLocalPreview。
 
 **返回值说明：**
 
@@ -426,12 +426,12 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 例如：
 
 房间“101”中有主播 A 与观众 B，房间“102”中有主播 C，主播 C 正常发布音视频流。主播 A 通过 connectOtherRoom 跟主播 C 建立跨房通话。
--  此时，主播 A 与观众 B 都会收到主播 C 的  `onRemoteUserEnterRoom(C)` ,  `onUserVideoAvailable(C,true)`  和  `onUserAudioAvailable(C,true)`  这三个事件回调，可以订阅主播 C 的音视频。
+- 此时，主播 A 与观众 B 都会收到主播 C 的  `onRemoteUserEnterRoom(C)` ,  `onUserVideoAvailable(C,true)`  和  `onUserAudioAvailable(C,true)`  这三个事件回调，可以订阅主播 C 的音视频。
 
 之后，主播 A 调用该接口禁用主播 C 在本房间发布音频的能力。
--  此后，主播 C 的音频流将无法发布至房间“101”，主播 A 与观众 B 都将收到  `onUserAudioAvailable(C,false)`  事件回调，且无法再通过  `muteRemoteAudio(C,false)`  订阅主播 C 的音频。
+- 此后，主播 C 的音频流将无法发布至房间“101”，主播 A 与观众 B 都将收到  `onUserAudioAvailable(C,false)`  事件回调，且无法再通过  `muteRemoteAudio(C,false)`  订阅主播 C 的音频。
 
--  主播 C 的视频流将不受影响。房间“102”中的其他观众也不受影响，可以正常订阅主播 C 的音频。
+- 主播 C 的视频流将不受影响。房间“102”中的其他观众也不受影响，可以正常订阅主播 C 的音频。
 
 该接口的参数考虑到后续扩展字段的兼容性问题，暂时采用了 JSON 格式的参数，示例如下：
 
@@ -542,8 +542,8 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 >
 > 如果希望开播前预览摄像头画面并通过 BeautyManager 调节美颜参数，您可以：
 >
-> -  方案一：在调用 enterRoom 之前调用  `startLocalPreview` 。
-> -  方案二：在调用 enterRoom 之后调用  `startLocalPreview + muteLocalVideo(true)` 。
+> - 方案一：在调用 enterRoom 之前调用  `startLocalPreview` 。
+> - 方案二：在调用 enterRoom 之后调用  `startLocalPreview + muteLocalVideo(true)` 。
 
 ## startLocalPreview
 
@@ -565,8 +565,8 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 >
 > 如果希望开播前预览摄像头画面并通过 BeautyManager 调节美颜参数，您可以：
 >
-> -  方案一：在调用 enterRoom 之前调用  `startLocalPreview` 。
-> -  方案二：在调用 enterRoom 之后调用  `startLocalPreview + muteLocalVideo(true)` 。
+> - 方案一：在调用 enterRoom 之前调用  `startLocalPreview` 。
+> - 方案二：在调用 enterRoom 之后调用  `startLocalPreview + muteLocalVideo(true)` 。
 
 ## updateLocalView
 
@@ -613,14 +613,14 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 **订阅远端用户的视频流，并绑定视频渲染控件。**
 
 调用该接口可以让 SDK 拉取指定 userId 的视频流，并渲染到参数  `view`  指定的渲染控件上。您可以通过 setRemoteRenderParams 设置画面的显示模式。
--  如果您已经知道房间中有视频流的用户的 userId，可以直接调用  `startRemoteView`  订阅该用户的画面。
+- 如果您已经知道房间中有视频流的用户的 userId，可以直接调用  `startRemoteView`  订阅该用户的画面。
 
--  如果您不知道房间中有哪些用户在发布视频，您可以在 enterRoom 之后等待来自 onUserVideoAvailable 的通知。
+- 如果您不知道房间中有哪些用户在发布视频，您可以在 enterRoom 之后等待来自 onUserVideoAvailable 的通知。
 
 调用本接口只是启动视频流的拉取，此时画面还需要加载和缓冲，当缓冲完毕后您会收到来自 onFirstVideoFrame 的通知。
 | 参数 | 描述 |
 | --- | --- |
-| streamType | 指定要观看 userId 的视频流类型。<br>-  高清大画面：TRTCVideoStreamTypeBig。<br>-  低清小画面：TRTCVideoStreamTypeSmall（需要远端用户通过 enableSmallVideoStream 开启双路编码后才有效果）。<br>-  辅流画面（常用于屏幕分享）：TRTCVideoStreamTypeSub。 |
+| streamType | 指定要观看 userId 的视频流类型。<br>- 高清大画面：TRTCVideoStreamTypeBig。<br>- 低清小画面：TRTCVideoStreamTypeSmall（需要远端用户通过 enableSmallVideoStream 开启双路编码后才有效果）。<br>- 辅流画面（常用于屏幕分享）：TRTCVideoStreamTypeSub。 |
 | userId | 指定远端用户的 ID。 |
 | view | 用于承载视频画面的渲染控件。 |
 
@@ -654,7 +654,7 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 调用此接口会让 SDK 停止接收该用户的视频流，并释放该路视频流的解码和渲染资源。
 | 参数 | 描述 |
 | --- | --- |
-| streamType | 指定要观看 userId 的视频流类型。<br>-  高清大画面：TRTCVideoStreamTypeBig。<br>-  低清小画面：TRTCVideoStreamTypeSmall。<br>-  辅流画面（常用于屏幕分享）：TRTCVideoStreamTypeSub。 |
+| streamType | 指定要观看 userId 的视频流类型。<br>- 高清大画面：TRTCVideoStreamTypeBig。<br>- 低清小画面：TRTCVideoStreamTypeSmall。<br>- 辅流画面（常用于屏幕分享）：TRTCVideoStreamTypeSub。 |
 | userId | 指定远端用户的 ID。 |
 
 ## stopAllRemoteView
@@ -676,7 +676,7 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
 | 参数 | 描述 |
 | --- | --- |
 | mute | 是否暂停接收。 |
-| streamType | 要暂停/恢复的视频流类型。<br>-  高清大画面：TRTCVideoStreamTypeBig。<br>-  低清小画面：TRTCVideoStreamTypeSmall。<br>-  辅流画面（常用于屏幕分享）：TRTCVideoStreamTypeSub。 |
+| streamType | 要暂停/恢复的视频流类型。<br>- 高清大画面：TRTCVideoStreamTypeBig。<br>- 低清小画面：TRTCVideoStreamTypeSmall。<br>- 辅流画面（常用于屏幕分享）：TRTCVideoStreamTypeSub。 |
 | userId | 指定远端用户的 ID。 |
 
 > **注意**
@@ -830,7 +830,7 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
 开启本地音频的采集和发布后，房间中的其他用户会收到 onUserAudioAvailable(userId, true) 的通知。
 | 参数 | 描述 |
 | --- | --- |
-| quality | 声音音质<br>-  TRTCAudioQualitySpeech，流畅：单声道；音频裸码率：18kbps；适合语音通话为主的场景，例如在线会议，语音通话。<br>-  TRTCAudioQualityDefault，默认：单声道；音频裸码率：50kbps；SDK 默认的音频质量，如无特殊需求推荐选择之。<br>-  TRTCAudioQualityMusic，高音质：双声道 + 全频带；音频裸码率：128kbps；适合需要高保真传输音乐的场景，例如在线K歌、音乐直播等。 |
+| quality | 声音音质<br>- TRTCAudioQualitySpeech，流畅：单声道；音频裸码率：18kbps；适合语音通话为主的场景，例如在线会议，语音通话。<br>- TRTCAudioQualityDefault，默认：单声道；音频裸码率：50kbps；SDK 默认的音频质量，如无特殊需求推荐选择之。<br>- TRTCAudioQualityMusic，高音质：双声道 + 全频带；音频裸码率：128kbps；适合需要高保真传输音乐的场景，例如在线K歌、音乐直播等。 |
 
 > **注意**
 >
@@ -1089,17 +1089,17 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
 **获取美颜管理类（TXBeautyManager）。**
 
 通过美颜管理，您可以使用以下功能：
--  设置“磨皮”、“美白”、“红润”等美颜特效。
+- 设置“磨皮”、“美白”、“红润”等美颜特效。
 
--  以下功能仅iOS/Android支持：
+- 以下功能仅iOS/Android支持：
 
--  设置“大眼”、“瘦脸”、“V脸”、“下巴”、“短脸”、“小鼻”、“亮眼”、“白牙”、“祛眼袋”、“祛皱纹”、“祛法令纹”等修脸特效。
+- 设置“大眼”、“瘦脸”、“V脸”、“下巴”、“短脸”、“小鼻”、“亮眼”、“白牙”、“祛眼袋”、“祛皱纹”、“祛法令纹”等修脸特效。
 
--  设置“发际线”、“眼间距”、“眼角”、“嘴形”、“鼻翼”、“鼻子位置”、“嘴唇厚度”、“脸型”等修脸特效。
+- 设置“发际线”、“眼间距”、“眼角”、“嘴形”、“鼻翼”、“鼻子位置”、“嘴唇厚度”、“脸型”等修脸特效。
 
--  设置“眼影”、“腮红”等美妆特效。
+- 设置“眼影”、“腮红”等美妆特效。
 
--  设置动态贴纸和人脸挂件等动画特效。
+- 设置动态贴纸和人脸挂件等动画特效。
 **返回值说明：**
 
 美颜管理类 TXBeautyManager。
@@ -1109,11 +1109,11 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
 **添加水印。**
 
 水印的位置是通过 xOffset, yOffset, fWidthRatio 来指定的。
--  xOffset：水印的坐标，取值范围为 [0, 1] 的浮点数。
+- xOffset：水印的坐标，取值范围为 [0, 1] 的浮点数。
 
--  yOffset：水印的坐标，取值范围为 [0, 1] 的浮点数。
+- yOffset：水印的坐标，取值范围为 [0, 1] 的浮点数。
 
--  fWidthRatio：水印的大小比例，取值范围为 [0, 1] 的浮点数。
+- fWidthRatio：水印的大小比例，取值范围为 [0, 1] 的浮点数。
 
 |参数|描述|
 |---------|---------|
@@ -1137,15 +1137,15 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
 **获取音效管理类（TXAudioEffectManager）。**
 
 TXAudioEffectManager 是音效管理接口，您可以通过该接口实现如下功能：
--  背景音乐：支持在线音乐和本地音乐，支持变速、变调等特效、支持原生和伴奏并播放和循环播放。
+- 背景音乐：支持在线音乐和本地音乐，支持变速、变调等特效、支持原生和伴奏并播放和循环播放。
 
--  耳机耳返：麦克风捕捉的声音实时通过耳机播放，常用于音乐直播。
+- 耳机耳返：麦克风捕捉的声音实时通过耳机播放，常用于音乐直播。
 
--  混响效果：KTV、小房间、大会堂、低沉、洪亮等。
+- 混响效果：KTV、小房间、大会堂、低沉、洪亮等。
 
--  变声特效：萝莉、大叔、重金属等。
+- 变声特效：萝莉、大叔、重金属等。
 
--  短音效：鼓掌声、欢笑声等简短的音效文件（对于小于10秒的文件，请将 isShortFile 参数设置为 true）。
+- 短音效：鼓掌声、欢笑声等简短的音效文件（对于小于10秒的文件，请将 isShortFile 参数设置为 true）。
 **返回值说明：**
 
 音效管理类 TXAudioEffectManager。
@@ -1202,7 +1202,7 @@ AI 转录管理类 AITranscriberManager。
 该接口可以抓取整个屏幕的内容，或抓取您指定的某个应用的窗口内容，并将其分享给同房间中的其他用户。
 | 参数 | 描述 |
 | --- | --- |
-| 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 | 渲染控件所在的父控件，可以设置为空值，表示不显示屏幕分享的预览效果。 |
 
@@ -1267,13 +1267,13 @@ AI 转录管理类 AITranscriberManager。
 在屏幕分享的过程中，您也可以随时调用该接口以切换分享目标。
 
 支持如下四种情况：
--  共享整个屏幕：source 中 type 为 TRTCScreenCaptureSourceTypeScreen 的 source，captureRect 设为 { 0, 0, 0, 0 }。
+- 共享整个屏幕：source 中 type 为 TRTCScreenCaptureSourceTypeScreen 的 source，captureRect 设为 { 0, 0, 0, 0 }。
 
--  共享指定区域：source 中 type 为 TRTCScreenCaptureSourceTypeScreen 的 source，captureRect 设为非 nullptr，例如 { 100, 100, 300, 300 }。
+- 共享指定区域：source 中 type 为 TRTCScreenCaptureSourceTypeScreen 的 source，captureRect 设为非 nullptr，例如 { 100, 100, 300, 300 }。
 
--  共享整个窗口：source 中 type 为 TRTCScreenCaptureSourceTypeWindow 的 source，captureRect 设为 { 0, 0, 0, 0 }。
+- 共享整个窗口：source 中 type 为 TRTCScreenCaptureSourceTypeWindow 的 source，captureRect 设为 { 0, 0, 0, 0 }。
 
--  共享窗口区域：source 中 type 为 TRTCScreenCaptureSourceTypeWindow 的 source，captureRect 设为非 nullptr，例如 { 100, 100, 300, 300 }。
+- 共享窗口区域：source 中 type 为 TRTCScreenCaptureSourceTypeWindow 的 source，captureRect 设为非 nullptr，例如 { 100, 100, 300, 300 }。
 
 |参数|描述|
 |---------|---------|
@@ -1293,9 +1293,9 @@ AI 转录管理类 AITranscriberManager。
 该接口可以设定远端用户所看到的屏幕分享（即辅路）的画面质量，同时也能决定云端录制出的视频文件中屏幕分享的画面质量。
 
 请注意如下两个接口的差异：
--  setVideoEncoderParam 用于设置主路画面（TRTCVideoStreamTypeBig，一般用于摄像头）的视频编码参数。
+- setVideoEncoderParam 用于设置主路画面（TRTCVideoStreamTypeBig，一般用于摄像头）的视频编码参数。
 
--  setSubStreamEncoderParam 用于设置辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）的视频编码参数。
+- setSubStreamEncoderParam 用于设置辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）的视频编码参数。
 
 |参数|描述|
 |---------|---------|
@@ -1401,19 +1401,19 @@ AI 转录管理类 AITranscriberManager。
 使用此接口可以向 SDK 投送自己采集的视频帧，SDK 会将视频帧进行编码并通过自身的网络模块传输出去。
 
 参数 TRTCVideoFrame 推荐下列填写方式（其他字段不需要填写）：
--  pixelFormat：Windows 和 Android 平台仅支持 TRTCVideoPixelFormat_I420，iOS 和 Mac平台支持 TRTCVideoPixelFormat_I420 和 TRTCVideoPixelFormat_BGRA32。
+- pixelFormat：Windows 和 Android 平台仅支持 TRTCVideoPixelFormat_I420，iOS 和 Mac平台支持 TRTCVideoPixelFormat_I420 和 TRTCVideoPixelFormat_BGRA32。
 
--  bufferType：推荐选择 TRTCVideoBufferType_Buffer。
+- bufferType：推荐选择 TRTCVideoBufferType_Buffer。
 
--  data：用于承载视频帧数据的 buffer。
+- data：用于承载视频帧数据的 buffer。
 
--  length：视频帧数据长度，如果 pixelFormat 设定为 I420 格式，length 可以按照如下公式计算： `length = width × height × 3 / 2` 。
+- length：视频帧数据长度，如果 pixelFormat 设定为 I420 格式，length 可以按照如下公式计算： `length = width × height × 3 / 2` 。
 
--  width：视频图像的宽度，如 640 px。
+- width：视频图像的宽度，如 640 px。
 
--  height：视频图像的高度，如 480 px。
+- height：视频图像的高度，如 480 px。
 
--  timestamp：时间戳，单位为毫秒（ms），请使用视频帧在采集时被记录下来的时间戳（可以在采集到一帧视频帧之后，通过调用 generateCustomPTS 获取时间戳）。
+- timestamp：时间戳，单位为毫秒（ms），请使用视频帧在采集时被记录下来的时间戳（可以在采集到一帧视频帧之后，通过调用 generateCustomPTS 获取时间戳）。
 
 参考文档：[自定义采集和渲染](https://cloud.tencent.com/document/product/647/34066)。
 
@@ -1457,15 +1457,15 @@ AI 转录管理类 AITranscriberManager。
 **向 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)。
 
@@ -1509,13 +1509,13 @@ AI 转录管理类 AITranscriberManager。
 当您调用该接口后，如果发现返回值大于 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 获得时间戳）。
 
 |参数|描述|
 |---------|---------|
@@ -1585,11 +1585,11 @@ AI 转录管理类 AITranscriberManager。
 **设置本地视频自定义渲染回调。**
 
 设置该回调之后，SDK 内部会跳过原来的渲染流程，并把采集到的数据回调出来，您需要自己完成画面渲染。
--  您可以通过调用  `setLocalVideoRenderCallback(TRTCVideoPixelFormat_Unknown, TRTCVideoBufferType_Unknown, nullptr)`  停止回调。
+- 您可以通过调用  `setLocalVideoRenderCallback(TRTCVideoPixelFormat_Unknown, TRTCVideoBufferType_Unknown, nullptr)`  停止回调。
 
--  iOS、Mac、Windows 平台目前仅支持回调 TRTCVideoPixelFormat_I420 或 TRTCVideoPixelFormat_BGRA32 像素格式的视频帧。
+- iOS、Mac、Windows 平台目前仅支持回调 TRTCVideoPixelFormat_I420 或 TRTCVideoPixelFormat_BGRA32 像素格式的视频帧。
 
--  Android 平台目前仅支持传入 TRTCVideoPixelFormat_I420, TRTCVideoPixelFormat_RGBA32 或 TRTCVideoPixelFormat_Texture_2D 像素格式的视频帧。
+- Android 平台目前仅支持传入 TRTCVideoPixelFormat_I420, TRTCVideoPixelFormat_RGBA32 或 TRTCVideoPixelFormat_Texture_2D 像素格式的视频帧。
 
 |参数|描述|
 |---------|---------|
@@ -1605,11 +1605,11 @@ AI 转录管理类 AITranscriberManager。
 **设置远端视频自定义渲染回调。**
 
 设置该回调之后，SDK 内部会跳过原来的渲染流程，并把采集到的数据回调出来，您需要自己完成画面渲染。
--  您可以通过调用  `setRemoteVideoRenderCallback(TRTCVideoPixelFormat_Unknown, TRTCVideoBufferType_Unknown, nullptr)`  停止回调。
+- 您可以通过调用  `setRemoteVideoRenderCallback(TRTCVideoPixelFormat_Unknown, TRTCVideoBufferType_Unknown, nullptr)`  停止回调。
 
--  iOS、Mac、Windows 平台目前仅支持回调 TRTCVideoPixelFormat_I420 或 TRTCVideoPixelFormat_BGRA32 像素格式的视频帧。
+- iOS、Mac、Windows 平台目前仅支持回调 TRTCVideoPixelFormat_I420 或 TRTCVideoPixelFormat_BGRA32 像素格式的视频帧。
 
--  Android 平台目前仅支持传入 TRTCVideoPixelFormat_I420, TRTCVideoPixelFormat_RGBA32 或 TRTCVideoPixelFormat_Texture_2D 像素格式的视频帧。
+- Android 平台目前仅支持传入 TRTCVideoPixelFormat_I420, TRTCVideoPixelFormat_RGBA32 或 TRTCVideoPixelFormat_Texture_2D 像素格式的视频帧。
 
 |参数|描述|
 |---------|---------|
@@ -1632,13 +1632,13 @@ AI 转录管理类 AITranscriberManager。
 **设置音频数据自定义回调。**
 
 设置该回调之后，SDK 内部会把音频数据（PCM 格式）回调出来，包括：
--  onCapturedAudioFrame：本地麦克风采集到的音频数据回调
+- onCapturedAudioFrame：本地麦克风采集到的音频数据回调
 
--  onLocalProcessedAudioFrame：本地采集并经过音频模块前处理后的音频数据回调
+- onLocalProcessedAudioFrame：本地采集并经过音频模块前处理后的音频数据回调
 
--  onPlayAudioFrame：混音前的每一路远程用户的音频数据
+- onPlayAudioFrame：混音前的每一路远程用户的音频数据
 
--  onMixedPlayAudioFrame：将各路音频混合之后并最终要由系统播放出的音频数据回调
+- onMixedPlayAudioFrame：将各路音频混合之后并最终要由系统播放出的音频数据回调
 
 > **注意**
 >
@@ -1650,11 +1650,11 @@ AI 转录管理类 AITranscriberManager。
 **设置本地麦克风采集出的音频帧回调格式。**
 
 本接口用于设置 onCapturedAudioFrame 回调出来的 AudioFrame 的格式：
--  sampleRate：采样率，支持：16000、32000、44100、48000。
+- sampleRate：采样率，支持：16000、32000、44100、48000。
 
--  channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
+- channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
 
--  samplesPerCall：采样点数，定义回调数据帧长。帧长必须为 10ms 的整数倍。
+- samplesPerCall：采样点数，定义回调数据帧长。帧长必须为 10ms 的整数倍。
 
 如果希望用毫秒数计算回调帧长，则将毫秒数转换成采样点数的公式为： `采样点数 = 毫秒数 * 采样率 / 1000` 。
 
@@ -1678,11 +1678,11 @@ AI 转录管理类 AITranscriberManager。
 **设置经过前处理后的本地音频帧回调格式。**
 
 本接口用于设置 onLocalProcessedAudioFrame 回调出来的 AudioFrame 的格式：
--  sampleRate：采样率，支持：16000、32000、44100、48000。
+- sampleRate：采样率，支持：16000、32000、44100、48000。
 
--  channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
+- channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
 
--  samplesPerCall：采样点数，定义回调数据帧长。帧长必须为 10ms 的整数倍。
+- samplesPerCall：采样点数，定义回调数据帧长。帧长必须为 10ms 的整数倍。
 
 如果希望用毫秒数计算回调帧长，则将毫秒数转换成采样点数的公式为： `采样点数 = 毫秒数 * 采样率 / 1000` 。
 
@@ -1706,11 +1706,11 @@ AI 转录管理类 AITranscriberManager。
 **设置最终要由系统播放出的音频帧回调格式。**
 
 本接口用于设置 onMixedPlayAudioFrame 回调出来的 AudioFrame 的格式：
--  sampleRate：采样率，支持：16000、32000、44100、48000。
+- sampleRate：采样率，支持：16000、32000、44100、48000。
 
--  channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
+- channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
 
--  samplesPerCall：采样点数，定义回调数据帧长。帧长必须为 10ms 的整数倍。
+- samplesPerCall：采样点数，定义回调数据帧长。帧长必须为 10ms 的整数倍。
 
 如果希望用毫秒数计算回调帧长，则将毫秒数转换成采样点数的公式为： `采样点数 = 毫秒数 * 采样率 / 1000` 。
 
@@ -1753,11 +1753,11 @@ AI 转录管理类 AITranscriberManager。
 调用该接口之前，您需要先通过 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字节` 。
 
@@ -1858,7 +1858,7 @@ true：消息已通过限制，等待后续视频帧发送；false：消息被
 
 > **注意**
 >
-> 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. 请在进入房间前进行网速测试，在房间中网速测试会影响正常的音视频传输效果，而且由于干扰过多，网速测试结果也不准确。
 >
@@ -1910,11 +1910,11 @@ true：消息已通过限制，等待后续视频帧发送；false：消息被
 **设置本地日志的保存路径。**
 
 通过该接口您可以更改 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/ 下。
 
 |参数|描述|
 |---------|---------|

package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md

@@ -8,16 +8,16 @@ Function: 用于对背景音乐、短音效和人声特效进行设置的管理
 
 |函数列表|描述|
 |---------|---------|
-|onLoadProgress|背景音乐预加载进度|
-|onLoadError|背景音乐预加载出错|
+|onLoadProgress|背景音乐预加载进度。|
+|onLoadError|背景音乐预加载出错。|
 
 ## ITXMusicPlayObserver
 
 |函数列表|描述|
 |---------|---------|
-|onStart|背景音乐开始播放|
-|onPlayProgress|背景音乐的播放进度|
-|onComplete|背景音乐已经播放完毕|
+|onStart|背景音乐开始播放。|
+|onPlayProgress|背景音乐的播放进度。|
+|onComplete|背景音乐已经播放完毕。|
 
 ## ITXAudioEffectManager
 
@@ -52,22 +52,22 @@ Function: 用于对背景音乐、短音效和人声特效进行设置的管理
 
 |函数列表|描述|
 |---------|---------|
-|AudioMusicParam|背景音乐的播放控制信息|
+|AudioMusicParam|背景音乐的播放控制信息。|
 
 ## 枚举类型
 
 |枚举类型|描述|
 |---------|---------|
-|TXVoiceReverbType|混响特效|
-|TXVoiceChangerType|变声特效|
+|TXVoiceReverbType|混响特效。|
+|TXVoiceChangerType|变声特效。|
 
 ## onLoadProgress
 
-**背景音乐预加载进度**
+**背景音乐预加载进度。**
 
 ## onLoadError
 
-**背景音乐预加载出错**
+**背景音乐预加载出错。**
 
 |参数|描述|
 |---------|---------|
@@ -75,7 +75,7 @@ Function: 用于对背景音乐、短音效和人声特效进行设置的管理
 
 ## onStart
 
-**背景音乐开始播放**
+**背景音乐开始播放。**
 
 在背景音乐开始播放成功或者失败时调用。
 
@@ -86,11 +86,11 @@ Function: 用于对背景音乐、短音效和人声特效进行设置的管理
 
 ## onPlayProgress
 
-**背景音乐的播放进度**
+**背景音乐的播放进度。**
 
 ## onComplete
 
-**背景音乐已经播放完毕**
+**背景音乐已经播放完毕。**
 
 在背景音乐播放完毕或播放错误时调用。
 
@@ -244,9 +244,9 @@ Function: 用于对背景音乐、短音效和人声特效进行设置的管理
 **设置所有背景音乐的本地音量和远端音量的大小。**
 
 该接口可以设置所有背景音乐的本地音量和远端音量。
--  本地音量：即主播本地可以听到的背景音乐的音量大小。
+- 本地音量：即主播本地可以听到的背景音乐的音量大小。
 
--  远端音量：即观众端可以听到的背景音乐的音量大小。
+- 远端音量：即观众端可以听到的背景音乐的音量大小。
 
 |参数|描述|
 |---------|---------|
@@ -414,7 +414,7 @@ Function: 用于对背景音乐、短音效和人声特效进行设置的管理
 
 ## TXVoiceReverbType
 
-**混响特效**
+**混响特效。**
 
 混响特效可以作用于人声之上，通过声学算法对声音进行叠加处理，模拟出各种不同环境下的临场感受，目前支持如下几种混响效果：
 
@@ -437,7 +437,7 @@ Function: 用于对背景音乐、短音效和人声特效进行设置的管理
 
 ## TXVoiceChangeType
 
-**变声特效**
+**变声特效。**
 
 变声特效可以作用于人声之上，通过声学算法对人声进行二次处理，以获得与原始声音所不同的音色，目前支持如下几种变声特效：
 
@@ -462,7 +462,7 @@ Function: 用于对背景音乐、短音效和人声特效进行设置的管理
 
 ## TXAudioMusicParam
 
-**背景音乐的播放控制信息**
+**背景音乐的播放控制信息。**
 
 该信息用于在接口 [startPlayMusic 中指定背景音乐的相关信息，包括播放 ID、文件路径和循环次数等：
 

package/resource/knowledge/trtc/c++/ITXDeviceManager.md

@@ -138,10 +138,10 @@ Function: 用于管理摄像头、麦克风和扬声器等音视频相关的硬
 
 > **注意**
 >
-> -  使用完毕后请调用 release 方法释放资源，这样可以让 SDK 维护 ITXDeviceCollection 对象的生命周期。
-> -  不要使用 delete 释放返回的 Collection 对象， `delete ITXDeviceCollection*`  指针会导致异常崩溃。
-> -  type 只支持  `TXMediaDeviceTypeMic` 、 `TXMediaDeviceTypeSpeaker` 、 `TXMediaDeviceTypeCamera` 。
-> -  此接口只支持 Mac 和 Windows 平台。
+> - 使用完毕后请调用 release 方法释放资源，这样可以让 SDK 维护 ITXDeviceCollection 对象的生命周期。
+> - 不要使用 delete 释放返回的 Collection 对象， `delete ITXDeviceCollection*`  指针会导致异常崩溃。
+> - type 只支持  `TXMediaDeviceTypeMic` 、 `TXMediaDeviceTypeSpeaker` 、 `TXMediaDeviceTypeCamera` 。
+> - 此接口只支持 Mac 和 Windows 平台。
 
 ## setCurrentDevice
 
@@ -194,7 +194,7 @@ Function: 用于管理摄像头、麦克风和扬声器等音视频相关的硬
 仅支持设置麦克风和扬声器类型，摄像头暂不支持跟随系统默认设备
 | 参数 | 描述 |
 | --- | --- |
-| enable | 是否跟随系统默认的音频设备。<br>-  true：跟随。当系统默认音频设备发生改变或者有新音频设备插入时，SDK 立即切换音频设备。<br>-  false：不跟随。当系统默认音频设备发生改变或者有新音频设备插入时，SDK 不会切换音频设备。 |
+| enable | 是否跟随系统默认的音频设备。<br>- true：跟随。当系统默认音频设备发生改变或者有新音频设备插入时，SDK 立即切换音频设备。<br>- false：不跟随。当系统默认音频设备发生改变或者有新音频设备插入时，SDK 不会切换音频设备。 |
 | type | 设备类型。 |
 
 ## startCameraDeviceTest
@@ -297,10 +297,10 @@ Function: 用于管理摄像头、麦克风和扬声器等音视频相关的硬
 @deprecated v9.5 版本开始不推荐使用。
 
 现代智能手机中一般都具备两套系统音量类型，即“通话音量”和“媒体音量”。
--  通话音量：手机专门为接打电话所设计的音量类型，自带回声抵消（AEC）功能，并且支持通过蓝牙耳机上的麦克风进行拾音，缺点是音质比较一般。
+- 通话音量：手机专门为接打电话所设计的音量类型，自带回声抵消（AEC）功能，并且支持通过蓝牙耳机上的麦克风进行拾音，缺点是音质比较一般。
 
 当您通过手机侧面的音量按键下调手机音量时，如果无法将其调至零（也就是无法彻底静音），说明您的手机当前处于通话音量。
--  媒体音量：手机专门为音乐场景所设计的音量类型，无法使用系统的 AEC 功能，并且不支持通过蓝牙耳机的麦克风进行拾音，但具备更好的音乐播放效果。
+- 媒体音量：手机专门为音乐场景所设计的音量类型，无法使用系统的 AEC 功能，并且不支持通过蓝牙耳机的麦克风进行拾音，但具备更好的音乐播放效果。
 
 当您通过手机侧面的音量按键下调手机音量时，如果能够将手机音量调至彻底静音，说明您的手机当前处于媒体音量。
 
@@ -319,9 +319,9 @@ SDK 目前提供了三种系统音量类型的控制模式：自动切换模式
 音频路由，即声音是从手机的扬声器还是从听筒中播放出来，因此该接口仅适用于手机等移动端设备。
 
 手机有两个扬声器：一个是位于手机顶部的听筒，一个是位于手机底部的立体声扬声器。
--  设置音频路由为听筒时，声音比较小，只有将耳朵凑近才能听清楚，隐私性较好，适合用于接听电话。
+- 设置音频路由为听筒时，声音比较小，只有将耳朵凑近才能听清楚，隐私性较好，适合用于接听电话。
 
--  设置音频路由为扬声器时，声音比较大，不用将手机贴脸也能听清，因此可以实现“免提”的功能。
+- 设置音频路由为扬声器时，声音比较大，不用将手机贴脸也能听清，因此可以实现“免提”的功能。
 
 |枚举|取值|描述|
 |---------|---------|---------|