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

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

@@ -0,0 +1,399 @@
+Copyright (c) 2021 Tencent. All rights reserved.
+
+Module:   音视频设备管理模块
+
+Function: 用于管理摄像头、麦克风和扬声器等音视频相关的硬件设备
+
+## TXDeviceObserver
+
+|函数列表|描述|
+|---------|---------|
+|onDeviceChanged:type:state:|本地设备的通断状态发生变化（仅适用于桌面系统）。|
+
+## TXDeviceManager
+
+|函数列表|描述|
+|---------|---------|
+|isFrontCamera|判断当前是否为前置摄像头（仅适用于移动端）。|
+|switchCamera:|切换前置或后置摄像头（仅适用于移动端）。|
+|isCameraZoomSupported|查询当前摄像头是否支持缩放（仅适用于移动端）。|
+|getCameraZoomMaxRatio|获取摄像头的最大缩放倍数（仅适用于移动端）。|
+|setCameraZoomRatio:|设置摄像头的缩放倍数（仅适用于移动端）。|
+|isAutoFocusEnabled|查询是否支持自动识别人脸位置（仅适用于移动端）。|
+|enableCameraAutoFocus:|开启自动对焦功能（仅适用于移动端）。|
+|setCameraFocusPosition:|设置摄像头的对焦位置（仅适用于移动端）。|
+|isCameraTorchSupported|查询是否支持开启闪光灯（仅适用于移动端）。|
+|enableCameraTorch:|开启/关闭闪光灯，也就是手电筒模式（仅适用于移动端）。|
+|setAudioRoute:|设置音频路由（仅适用于移动端）。|
+|setExposureCompensation:|设置摄像头的曝光参数，取值范围为 [-1, 1]。|
+|getDevicesList:|获取设备列表（仅适用于桌面端）。|
+|setCurrentDevice:deviceId:|设置当前要使用的设备（仅适用于桌面端）。|
+|getCurrentDevice:|获取当前正在使用的设备（仅适用于桌面端）。|
+|setCurrentDeviceVolume:deviceType:|设置当前设备的音量（仅适用于桌面端）。|
+|getCurrentDeviceVolume:|获取当前设备的音量（仅适用于桌面端）。|
+|setCurrentDeviceMute:deviceType:|设置当前设备的静音状态（仅适用于桌面端）。|
+|getCurrentDeviceMute:|获取当前设备的静音状态（仅适用于桌面端）。|
+|enableFollowingDefaultAudioDevice:enable:|设置 SDK 使用的音频设备根据跟随系统默认设备（仅适用于桌面端）。|
+|startCameraDeviceTest:|开始摄像头测试（仅适用于桌面端）。|
+|stopCameraDeviceTest|结束摄像头测试（仅适用于桌面端）。|
+|startMicDeviceTest:|开始麦克风测试（仅适用于桌面端）。|
+|startMicDeviceTest:playback:|开始麦克风测试（仅适用于桌面端）。|
+|stopMicDeviceTest|结束麦克风测试（仅适用于桌面端）。|
+|startSpeakerDeviceTest:|开始扬声器测试（仅适用于桌面端）。|
+|stopSpeakerDeviceTest|结束扬声器测试（仅适用于桌面端）。|
+|setObserver:|设备热插拔回调（仅适用于 Mac 系统）。|
+|setCameraCapturerParam:|设置摄像头采集偏好。|
+|setSystemVolumeType:|设置系统音量类型（仅适用于移动端）。|
+
+## 结构体类型
+
+|函数列表|描述|
+|---------|---------|
+|TXCameraCaptureParam|摄像头采集参数。|
+|TXMediaDeviceInfo|音视频设备的相关信息（仅适用于桌面平台）。|
+
+## 枚举类型
+
+|枚举类型|描述|
+|---------|---------|
+|TXSystemVolumeType|系统音量类型（仅适用于移动设备）。|
+|TXAudioRoute|音频路由（即声音的播放模式）。|
+|TXMediaDeviceType|设备类型（仅适用于桌面平台）。|
+|TXMediaDeviceState|设备操作。|
+|TXCameraCaptureMode|摄像头采集偏好。|
+
+## onDeviceChanged:type:state:
+
+**本地设备的通断状态发生变化（仅适用于桌面系统）。**
+
+当本地设备（包括摄像头、麦克风以及扬声器）被插入或者拔出时，SDK 便会抛出此事件回调。
+
+|参数|描述|
+|---------|---------|
+|deviceId|设备 ID|
+|state|通断状态，0：设备已添加；1：设备已被移除；2：设备已启用。|
+|type|设备类型|
+
+## isFrontCamera
+
+**判断当前是否为前置摄像头（仅适用于移动端）。**
+
+## switchCamera:
+
+**切换前置或后置摄像头（仅适用于移动端）。**
+
+## isCameraZoomSupported
+
+**查询当前摄像头是否支持缩放（仅适用于移动端）。**
+
+## getCameraZoomMaxRatio
+
+**获取摄像头的最大缩放倍数（仅适用于移动端）。**
+
+## setCameraZoomRatio:
+
+**设置摄像头的缩放倍数（仅适用于移动端）。**
+
+|参数|描述|
+|---------|---------|
+|zoomRatio|取值范围 [1, 5]，取值为1表示最远视角（正常镜头），取值为5表示最近视角（放大镜头）。最大值推荐为5，若超过5，视频数据会变得模糊不清。|
+
+## isAutoFocusEnabled
+
+**查询是否支持自动识别人脸位置（仅适用于移动端）。**
+
+## enableCameraAutoFocus:
+
+**开启自动对焦功能（仅适用于移动端）。**
+
+开启后，SDK 会自动检测画面中的人脸位置，并将摄像头的焦点始终对焦在人脸位置上。
+
+## setCameraFocusPosition:
+
+**设置摄像头的对焦位置（仅适用于移动端）。**
+
+您可以通过该接口实现如下交互：
+
+1. 在本地摄像头的预览画面上，允许用户单击操作。
+
+2. 在用户的单击位置显示一个矩形方框，以示摄像头会在此处对焦。
+
+3. 随后将用户点击位置的坐标通过本接口传递给 SDK，之后 SDK 会操控摄像头按照用户期望的位置进行对焦。
+
+|参数|描述|
+|---------|---------|
+|position|对焦位置，请传入期望对焦点的坐标值|
+
+> **注意**
+>
+
+> 使用该接口的前提是先通过 enableCameraAutoFocus 关闭自动对焦功能。
+>
+**返回值说明：**
+
+0：操作成功；负数：操作失败。
+
+## isCameraTorchSupported
+
+**查询是否支持开启闪光灯（仅适用于移动端）。**
+
+## enableCameraTorch:
+
+**开启/关闭闪光灯，也就是手电筒模式（仅适用于移动端）。**
+
+## setAudioRoute:
+
+**设置音频路由（仅适用于移动端）。**
+
+手机有两个音频播放设备：一个是位于手机顶部的听筒，一个是位于手机底部的立体声扬声器。
+
+设置音频路由为听筒时，声音比较小，只有将耳朵凑近才能听清楚，隐私性较好，适合用于接听电话。
+
+设置音频路由为扬声器时，声音比较大，不用将手机贴脸也能听清，因此可以实现“免提”的功能。
+
+## setExposureCompensation:
+
+**设置摄像头的曝光参数，取值范围为 [-1, 1]。**
+
+## getDevicesList:
+
+**获取设备列表（仅适用于桌面端）。**
+
+|参数|描述|
+|---------|---------|
+|type|设备类型，指定需要获取哪种设备的列表。详见 TXMediaDeviceType 定义。|
+
+> **注意**
+>
+> -  使用完毕后请调用 release 方法释放资源，这样可以让 SDK 维护 ITXDeviceCollection 对象的生命周期。
+> -  不要使用 delete 释放返回的 Collection 对象，` delete ITXDeviceCollection* ` 指针会导致异常崩溃。
+> -  type 只支持 ` TXMediaDeviceTypeMic `、` TXMediaDeviceTypeSpeaker `、` TXMediaDeviceTypeCamera `。
+> -  此接口只支持 Mac 和 Windows 平台。
+
+## setCurrentDevice:deviceId:
+
+**设置当前要使用的设备（仅适用于桌面端）。**
+
+|参数|描述|
+|---------|---------|
+|deviceId|设备 ID，您可以通过接口 getDevicesList 获得设备 ID。|
+|type|设备类型，详见 TXMediaDeviceType 定义。|
+**返回值说明：**
+
+0：操作成功；负数：操作失败。
+
+## getCurrentDevice:
+
+**获取当前正在使用的设备（仅适用于桌面端）。**
+
+## setCurrentDeviceVolume:deviceType:
+
+**设置当前设备的音量（仅适用于桌面端）。**
+
+这里的音量指的是麦克风的采集音量或者扬声器的播放音量，摄像头是不支持设置音量的。
+
+|参数|描述|
+|---------|---------|
+|volume|音量大小，取值范围为 [0, 100]，默认值：100。|
+
+## getCurrentDeviceVolume:
+
+**获取当前设备的音量（仅适用于桌面端）。**
+
+这里的音量指的是麦克风的采集音量或者扬声器的播放音量，摄像头是不支持获取音量的。
+
+## setCurrentDeviceMute:deviceType:
+
+**设置当前设备的静音状态（仅适用于桌面端）。**
+
+这里的音量指的是麦克风和扬声器，摄像头是不支持静音操作的。
+
+## getCurrentDeviceMute:
+
+**获取当前设备的静音状态（仅适用于桌面端）。**
+
+这里的音量指的是麦克风和扬声器，摄像头是不支持静音操作的。
+
+## enableFollowingDefaultAudioDevice:enable:
+
+**设置 SDK 使用的音频设备根据跟随系统默认设备（仅适用于桌面端）。**
+
+仅支持设置麦克风和扬声器类型，摄像头暂不支持跟随系统默认设备
+| 参数 | 描述 |
+| --- | --- |
+| enable | 是否跟随系统默认的音频设备。<br>-  true：跟随。当系统默认音频设备发生改变或者有新音频设备插入时，SDK 立即切换音频设备。<br>-  false：不跟随。当系统默认音频设备发生改变或者有新音频设备插入时，SDK 不会切换音频设备。 |
+| type | 设备类型，详见 TXMediaDeviceType 定义。 |
+
+## startCameraDeviceTest:
+
+**开始摄像头测试（仅适用于桌面端）。**
+
+> **注意**
+>
+
+> 在测试过程中可以使用 setCurrentDevice 接口切换摄像头。
+>
+
+## stopCameraDeviceTest
+
+**结束摄像头测试（仅适用于桌面端）。**
+
+## startMicDeviceTest:
+
+**开始麦克风测试（仅适用于桌面端）。**
+
+该接口可以测试麦克风是否能正常工作，测试到的麦克风采集音量的大小，会以回调的形式通知给您，其中 volume 的取值范围为 [0, 100]。
+
+|参数|描述|
+|---------|---------|
+|interval|麦克风音量的回调间隔，单位为毫秒（ms）。|
+
+> **注意**
+>
+
+> 该接口调用后默认会回播麦克风录制到的声音到扬声器中。
+>
+
+## startMicDeviceTest:playback:
+
+**开始麦克风测试（仅适用于桌面端）。**
+
+该接口可以测试麦克风是否能正常工作，测试到的麦克风采集音量的大小，会以回调的形式通知给您，其中 volume 的取值范围为 [0, 100]。
+
+|参数|描述|
+|---------|---------|
+|interval|麦克风音量的回调间隔，单位为毫秒（ms）。|
+|playback|是否开启回播麦克风声音，开启后用户测试麦克风时会听到自己的声音。|
+
+## stopMicDeviceTest
+
+**结束麦克风测试（仅适用于桌面端）。**
+
+## startSpeakerDeviceTest:
+
+**开始扬声器测试（仅适用于桌面端）。**
+
+该接口通过播放指定的音频文件，用于测试播放设备是否能正常工作。如果用户在测试时能听到声音，说明播放设备能正常工作。
+
+|参数|描述|
+|---------|---------|
+|filePath|声音文件的路径|
+
+## stopSpeakerDeviceTest
+
+**结束扬声器测试（仅适用于桌面端）。**
+
+## setObserver:
+
+**设备热插拔回调（仅适用于 Mac 系统）。**
+
+## setCameraCapturerParam:
+
+**设置摄像头采集偏好。**
+
+## setSystemVolumeType:
+
+**设置系统音量类型（仅适用于移动端）。**
+
+@deprecated v9.5 版本开始不推荐使用，建议使用 ` TRTCCloud ` 中的 ` startLocalAudio(quality) ` 接口替代之，通过 quality 参数来决策音质。
+
+## TXSystemVolumeType(Deprecated)
+
+**系统音量类型（仅适用于移动设备）。**
+
+@deprecated v9.5 版本开始不推荐使用。
+
+现代智能手机中一般都具备两套系统音量类型，即“通话音量”和“媒体音量”。
+-  通话音量：手机专门为接打电话所设计的音量类型，自带回声抵消（AEC）功能，并且支持通过蓝牙耳机上的麦克风进行拾音，缺点是音质比较一般。
+
+当您通过手机侧面的音量按键下调手机音量时，如果无法将其调至零（也就是无法彻底静音），说明您的手机当前处于通话音量。
+-  媒体音量：手机专门为音乐场景所设计的音量类型，无法使用系统的 AEC 功能，并且不支持通过蓝牙耳机的麦克风进行拾音，但具备更好的音乐播放效果。
+
+当您通过手机侧面的音量按键下调手机音量时，如果能够将手机音量调至彻底静音，说明您的手机当前处于媒体音量。
+
+SDK 目前提供了三种系统音量类型的控制模式：自动切换模式、全程通话音量模式、全程媒体音量模式。
+
+|枚举|取值|描述|
+|---------|---------|---------|
+|TXSystemVolumeTypeAuto|0|自动切换模式|
+|TXSystemVolumeTypeMedia|1|全程媒体音量|
+|TXSystemVolumeTypeVOIP|2|全程通话音量|
+
+## TXAudioRoute
+
+**音频路由（即声音的播放模式）。**
+
+音频路由，即声音是从手机的扬声器还是从听筒中播放出来，因此该接口仅适用于手机等移动端设备。
+
+手机有两个扬声器：一个是位于手机顶部的听筒，一个是位于手机底部的立体声扬声器。
+-  设置音频路由为听筒时，声音比较小，只有将耳朵凑近才能听清楚，隐私性较好，适合用于接听电话。
+
+-  设置音频路由为扬声器时，声音比较大，不用将手机贴脸也能听清，因此可以实现“免提”的功能。
+
+|枚举|取值|描述|
+|---------|---------|---------|
+|TXAudioRouteSpeakerphone|0|Speakerphone：使用扬声器播放（即“免提”），扬声器位于手机底部，声音偏大，适合外放音乐。|
+|TXAudioRouteEarpiece|1|Earpiece：使用听筒播放，听筒位于手机顶部，声音偏小，适合需要保护隐私的通话场景。|
+
+## TXMediaDeviceType
+
+**设备类型（仅适用于桌面平台）。**
+
+该枚举值用于定义三种类型的音视频设备，即摄像头、麦克风和扬声器，以便让一套设备管理接口可以操控三种不同类型的设备。
+
+|枚举|取值|描述|
+|---------|---------|---------|
+|TXMediaDeviceTypeUnknown|-1|未定义的设备类型|
+|TXMediaDeviceTypeAudioInput|0|麦克风类型设备|
+|TXMediaDeviceTypeAudioOutput|1|扬声器类型设备|
+|TXMediaDeviceTypeVideoCamera|2|摄像头类型设备|
+
+## TXMediaDeviceState
+
+**设备操作。**
+
+该枚举值用于本地设备的状态变化通知 onDeviceChanged。
+
+|枚举|取值|描述|
+|---------|---------|---------|
+|TXMediaDeviceStateAdd|0|设备已被插入|
+|TXMediaDeviceStateRemove|1|设备已被移除|
+|TXMediaDeviceStateActive|2|设备已启用|
+|TXMediaDefaultDeviceChanged|3|系统默认设备变更|
+
+## TXCameraCaptureMode
+
+**摄像头采集偏好。**
+
+该枚举类型用于摄像头采集参数设置。
+| 枚举 | 取值 | 描述 |
+| --- | --- | --- |
+| TXCameraResolutionStrategyAuto | 0 | 自动调整采集参数。<br>SDK 根据实际的采集设备性能及网络情况，选择合适的摄像头输出参数，在设备性能及视频预览质量之间，维持平衡。 |
+| TXCameraResolutionStrategyPerformance | Not Defined | 优先保证设备性能。<br>SDK 根据用户设置编码器的分辨率和帧率，选择最接近的摄像头输出参数，从而保证设备性能。 |
+| TXCameraResolutionStrategyHighQuality | Not Defined | 优先保证视频预览质量。<br>SDK选择较高的摄像头输出参数，从而提高预览视频的质量。在这种情况下，会消耗更多的 CPU 及内存做视频前处理。 |
+| TXCameraCaptureManual | Not Defined | 允许用户设置本地摄像头采集的视频宽高。 |
+
+## TXCameraCaptureParam
+
+**摄像头采集参数。**
+
+该设置能决定本地预览图像画质。
+
+|枚举类型|描述|
+|---------|---------|
+|height|**字段含义：** 采集图像宽度|
+|mode|**字段含义：** 摄像头采集偏好，请参见 TXCameraCaptureMode|
+|width|**字段含义：** 采集图像长度|
+
+## TXMediaDeviceInfo
+
+**音视频设备的相关信息（仅适用于桌面平台）。**
+
+该结构体用于描述一个音视频设备的关键信息，例如设备 ID、设备名称等等，以便用户能够在用户界面上选择自己期望使用的音视频设备。
+
+|枚举类型|描述|
+|---------|---------|
+|deviceId|设备 ID （UTF-8）|
+|deviceName|设备名称 （UTF-8）|
+|deviceProperties|设备属性|
+|type|设备类型|

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

@@ -1,17 +1,19 @@
-# 腾讯云实时音视频(TRTC SDK )文档
+Copyright (c) 2021 Tencent. All rights reserved.
 
-## 概述
-`TXLiteAVCode.h` 是腾讯云实时音视频(TRTC SDK ) iOS 平台的状态码文档，用于通知客户 TRTC 在使用过程中出现的警告和错误。
+Module:   TRTC 错误码表
+
+Function: 用于通知客户 TRTC 在使用过程中出现的警告和错误
 
 ## 枚举类型
-| 枚举类型 | 描述 |
-| --- | --- |
-| TXLiteAVError | 错误码。 |
-| TXLiteAVWarning | 警告码。 |
+
+|枚举类型|描述|
+|---------|---------|
+|TXLiteAVError|错误码。|
+|TXLiteAVWarning|警告码。|
 
 ## TXLiteAVError
 
-#### 错误码。
+**错误码。**
 | 枚举 | 取值 | 描述 |
 | --- | --- | --- |
 | ERR_NULL | 0 | 无错误 |
@@ -47,13 +49,13 @@
 | ERR_AUDIO_PLUGIN_START_FAIL | -1330 | 开启系统声音录制失败，例如音频驱动插件不可用 |
 | ERR_AUDIO_PLUGIN_INSTALL_NOT_AUTHORIZED | -1331 | 安装音频驱动插件未授权 |
 | ERR_AUDIO_PLUGIN_INSTALL_FAILED | -1332 | 安装音频驱动插件失败 |
-| ERR_AUDIO_PLUGIN_INSTALLED_BUT_NEED_RESTART | -1333 | 安装虚拟声卡插件成功，但首次安装后功能暂时不可用，此为 Mac 系统限制，请在收到此错误码后提示用户重启当前 APP |
+| ERR_AUDIO_PLUGIN_INSTALLED_BUT_NEED_RESTART | -1333 | 安装虚拟声卡插件成功，但首次安装后功能暂时不可用，此为 Mac 系统限制，请在收到此错误码后提示用户重启当前 App |
 | ERR_AUDIO_ENCODE_FAIL | -1304 | 音频帧编码失败，例如传入自定义音频数据，SDK 无法处理 |
 | ERR_UNSUPPORTED_SAMPLERATE | -1306 | 不支持的音频采样率 |
 | ERR_SYSTEM_LOOPBACK_START_FAILED | -1307 | 系统混音启动出错，常见的出错原因及解决：1.当前系统版本无法支持，指定、排除指定进程混音功能需满足 Windows 系统为10.0.19042（20H2）或更高版本，指定路径混音功能 x64 版本需满足 Windows 系统为10.0.19042（20H2）或更高版本，请检查当前系统版本。2.传入参数非法（包括参数为空、传入路径不存在、传入进程号不存在、传入设备名不存在），请检查传入参数是否合法。3.无可用扬声器设备，请检查是否可用 |
 | ERR_SYSTEM_LOOPBACK_THIRD_PARTY_APP_EXIT | -1324 | 第三方应用混音采集出错，该错误可能出现于第三方应用混音启动成功后，在采集声音的过程中指定进程或应用意外退出，请检查指定进程或应用的状态，可通过重新输入进程号进行重试 |
 | ERR_TRTC_ENTER_ROOM_FAILED | -3301 | 进入房间失败，请查看 onError 中的 -3301 对应的 msg 提示确认失败原因 |
-| ERR_TRTC_REQUEST_IP_TIMEOUT | -3307 | 请求 IP 和 sig 超时，请检查网络是否正常，或网络防火墙是否放行 UDP。<br>可尝试访问下列 IP：162.14.22.165:8000 162.14.6.105:8000 和域名：default-query.trtc.tencent-cloud.com:8000 |
+| ERR_TRTC_REQUEST_IP_TIMEOUT | -3307 | 请求 IP 和 sig 超时，请检查网络是否正常，或网络防火墙是否放行 UDP。<br>可尝试访问下列 IP: 162.14.22.165:8000 162.14.6.105:8000 和域名: default-query.trtc.tencent-cloud.com:8000 |
 | ERR_TRTC_CONNECT_SERVER_TIMEOUT | -3308 | 请求进房超时，请检查是否断网或者是否开启vpn，您也可以切换4G进行测试确认 |
 | ERR_TRTC_ROOM_PARAM_NULL | -3316 | 进房参数为空，请检查： enterRoom:appScene: 接口调用是否传入有效的 param |
 | ERR_TRTC_INVALID_SDK_APPID | -3317 | 进房参数 sdkAppId 错误，请检查 TRTCParams.sdkAppId 是否为空 |
@@ -61,9 +63,9 @@
 | ERR_TRTC_INVALID_USER_ID | -3319 | 进房参数 userId 不正确，请检查 TRTCParams.userId 是否为空 |
 | ERR_TRTC_INVALID_USER_SIG | -3320 | 进房参数 userSig 不正确，请检查 TRTCParams.userSig 是否为空 |
 | ERR_TRTC_ENTER_ROOM_REFUSED | -3340 | 进房请求被拒绝，请检查是否连续调用 enterRoom 进入相同 Id 的房间 |
-| ERR_TRTC_INVALID_PRIVATE_MAPKEY | -100006 | 您开启了高级权限控制，但参数 TRTCParams.privateMapKey 校验失败，<br>您可参考 [高级权限控制](https://cloud.tencent.com/document/product/647/32240) 进行检查 |
-| ERR_TRTC_SERVICE_SUSPENDED | -100013 | 服务不可用。请检查：套餐包剩余分钟数是否大于0，腾讯云账号是否欠费。<br>您可参考 [套餐包管理](https://cloud.tencent.com/document/product/647/50492) 进行查看与配置 |
-| ERR_TRTC_USER_SIG_CHECK_FAILED | -100018 | UserSig 校验失败，请检查参数 TRTCParams.userSig 是否填写正确，或是否已经过期。<br>您可参考 [UserSig 生成与校验](https://cloud.tencent.com/document/product/647/50686) 进行校验 |
+| ERR_TRTC_INVALID_PRIVATE_MAPKEY | -100006 | 您开启了高级权限控制，但参数 TRTCParams.privateMapKey 校验失败，<br>您可参考 <a href="https://cloud.tencent.com/document/product/647/32240">高级权限控制</a> 进行检查 |
+| ERR_TRTC_SERVICE_SUSPENDED | -100013 | 服务不可用。请检查：套餐包剩余分钟数是否大于0，腾讯云账号是否欠费。<br>您可参考 <a href="https://cloud.tencent.com/document/product/647/50492">套餐包管理</a> 进行查看与配置 |
+| ERR_TRTC_USER_SIG_CHECK_FAILED | -100018 | UserSig 校验失败，请检查参数 TRTCParams.userSig 是否填写正确，或是否已经过期。<br>您可参考 <a href="https://cloud.tencent.com/document/product/647/50686">UserSig 生成与校验</a> 进行校验 |
 | ERR_TRTC_PUSH_THIRD_PARTY_CLOUD_TIMEOUT | -3321 | 旁路转推请求超时 |
 | ERR_TRTC_MIX_TRANSCODING_TIMEOUT | -3322 | 云端混流请求超时 |
 | ERR_TRTC_PUSH_THIRD_PARTY_CLOUD_FAILED | -3323 | 旁路转推回包异常 |
@@ -75,7 +77,7 @@
 | ERR_TRTC_CONNECT_OTHER_ROOM_TIMEOUT | -3326 | 请求连麦超时 |
 | ERR_TRTC_DISCONNECT_OTHER_ROOM_TIMEOUT | -3327 | 请求退出连麦超时 |
 | ERR_TRTC_CONNECT_OTHER_ROOM_INVALID_PARAMETER | -3328 | 无效参数 |
-| ERR_TRTC_CONNECT_OTHER_ROOM_AS_AUDIENCE | -3330 | 当前是观众角色，不能请求或断开跨房连麦，需要先 ` switchRole ` 到主播 |
+| ERR_TRTC_CONNECT_OTHER_ROOM_AS_AUDIENCE | -3330 | 当前是观众角色，不能请求或断开跨房连麦，需要先 <code> switchRole </code> 到主播 |
 | ERR_BGM_OPEN_FAILED | -4001 | 打开文件失败，如音频数据无效，FFMPEG 协议未找到等 |
 | ERR_BGM_DECODE_FAILED | -4002 | 音频文件解码失败 |
 | ERR_BGM_OVER_LIMIT | -4003 | 数量超过限定值，如同时预加载两首背景音乐 |
@@ -83,12 +85,12 @@
 | ERR_BGM_INVALID_PATH | -4005 | 非法路径导致打开文件失败，请检查您传入的路径参数是否指向一个合法的音乐文件 |
 | ERR_BGM_INVALID_URL | -4006 | 非法URL导致打开文件失败，请用浏览器检查您传入的 URL 地址是否可以下载到期望的音乐文件，如果操作系统为 iOS 或 MacOS 请确保使用 https 链接 |
 | ERR_BGM_NO_AUDIO_STREAM | -4007 | 无音频流导致打开文件失败，请确认您传入的文件是否是合法的音频文件，以及文件是否被损坏 |
-| ERR_BGM_FORMAT_NOT_SUPPORTED | -4008 | 格式不支持导致打开文件失败，请确认您传入的文件格式是否是支持的文件格式，移动端支持【mp3，aac，m4a，wav，ogg，mp4，mkv】，桌面端支持 【mp3，aac，m4a，wav，mp4，mkv】 |
+| ERR_BGM_FORMAT_NOT_SUPPORTED | -4008 | 格式不支持导致打开文件失败，请确认您传入的文件格式是否是支持的文件格式，移动端支持【mp3, aac, m4a, wav, ogg, mp4, mkv】，桌面端支持 【mp3, aac, m4a, wav, mp4, mkv】 |
 | ERR_CONCURRENT_BGM_OVER_LIMIT | -4009 | 同时播放 bgm 数量超过限定值，如当前同时播放 bgm 数量超过 10 后提示该错误，请检查并发播放 bgm 数量 |
 
 ## TXLiteAVWarning
 
-#### 警告码。
+**警告码。**
 | 枚举 | 取值 | 描述 |
 | --- | --- | --- |
 | WARNING_HW_ENCODER_START_FAIL | 1103 | 硬编码启动出现问题，自动切换到软编码 |
@@ -106,7 +108,7 @@
 | WARNING_CAMERA_START_FAILED | 1117 | 摄像头启动失败. |
 | WARNING_CAMERA_SERVER_DIED | 1118 | 系统异常. |
 | WARNING_SCREEN_CAPTURE_NOT_AUTHORIZED | 1206 | 用户未授权当前应用使用屏幕录制 |
-| WARNING_CURRENT_DECODE_TYPE_CHANGED | 2008 | 表示解码器发生改变，可以通过 onWarning 函数的扩展信息中的 type 字段来获取当前的解码格式。<br>其中 1 代表 265 解码，0 代表 264 解码。注意 Windows 端不支持此错误码的扩展信息。 |
+| WARNING_CURRENT_DECODE_TYPE_CHANGED | 2008 | 表示解码器发生改变，可以通过 onWarning 函数的扩展信息中的 type 字段来获取当前的解码格式。<br>其中 1 代表 265 解码，0 代表 264 解码。注意 Windows 端不支持此警告码的扩展信息。 |
 | WARNING_VIDEO_FRAME_DECODE_FAIL | 2101 | 当前视频帧解码失败 |
 | WARNING_HW_DECODER_START_FAIL | 2106 | 硬解启动失败，采用软解码 |
 | WARNING_VIDEO_DECODER_HW_TO_SW | 2108 | 当前流硬解第一个 I 帧失败，SDK 自动切软解 |