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

package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TXLiteAVCode.md

@@ -1,17 +1,19 @@
-# 腾讯云实时音视频(TRTC SDK )文档
+Copyright (c) 2021 Tencent. All rights reserved.
 
-## 概述
-`TXLiteAVCode.h` 是腾讯云实时音视频(TRTC SDK ) C++ 的状态码文档，用于通知客户 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 自动切软解 |