@tencent-rtc/mcp 1.4.6 → 1.6.0-beta.1

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

@@ -0,0 +1,127 @@
+## EnumType
+
+|EnumType|DESC|
+|---------|---------|
+|TXLiteAVError|Error Codes.|
+|TXLiteAVWarning|Warning codes.|
+
+## TXLiteAVError
+
+**Error Codes.**
+| Enum | Value | DESC |
+| --- | --- | --- |
+| ERR_NULL | 0 | No error. |
+| ERR_FAILED | -1 | Unclassified error. |
+| ERR_INVALID_PARAMETER | -2 | An invalid parameter was passed in when the API was called. |
+| ERR_REFUSED | -3 | The API call was rejected. |
+| ERR_NOT_SUPPORTED | -4 | The current API cannot be called. |
+| ERR_INVALID_LICENSE | -5 | Failed to call the API because the license is invalid. |
+| ERR_REQUEST_SERVER_TIMEOUT | -6 | The request timed out. |
+| ERR_SERVER_PROCESS_FAILED | -7 | The server cannot process your request. |
+| ERR_DISCONNECTED | -8 | Disconnected from the server. |
+| ERR_CAMERA_START_FAIL | -1301 | Failed to turn the camera on. After authorization, calling the system interface to open the camera was abnormal on mobile. This may occur when there is a problem with the camera configuration program (driver) on Windows or macOS. Disable and reenable the camera, restart the camera, or update the configuration program. |
+| ERR_CAMERA_NOT_AUTHORIZED | -1314 | No permission to access to the camera. This usually occurs on mobile devices and may be because the user denied access. |
+| ERR_CAMERA_SET_PARAM_FAIL | -1315 | Incorrect camera parameter settings (unsupported values or others). |
+| ERR_CAMERA_OCCUPY | -1316 | The camera is being used. Try another camera. |
+| ERR_SCREEN_CAPTURE_START_FAIL | -1308 | Failed to start screen recording. It occurs on a mobile device, it may be because the user denied screen sharing permission, it occurs on Windows or macOS, check whether the parameters of the screen recording API are set as required. |
+| ERR_SCREEN_CAPTURE_UNSURPORT | -1309 | Screen recording failed. Screen recording is only supported on Android versions later than 5.0 and iOS versions later than 11.0. |
+| ERR_SCREEN_CAPTURE_STOPPED | -7001 | Screen recording was stopped by the system. |
+| ERR_SCREEN_SHARE_NOT_AUTHORIZED | -102015 | No permission to publish the substream. |
+| ERR_SCREEN_SHRAE_OCCUPIED_BY_OTHER | -102016 | Another user is publishing the substream. |
+| ERR_VIDEO_ENCODE_FAIL | -1303 | Failed to encode video frames. Encoder exception caused encoding failure. |
+| ERR_UNSUPPORTED_RESOLUTION | -1305 | Unsupported video resolution. |
+| ERR_PIXEL_FORMAT_UNSUPPORTED | -1327 | Custom video capturing: Unsupported pixel format. |
+| ERR_BUFFER_TYPE_UNSUPPORTED | -1328 | Custom video capturing: Unsupported buffer type. |
+| ERR_NO_AVAILABLE_HEVC_DECODERS | -2304 | No available HEVC decoder found. |
+| ERR_MIC_START_FAIL | -1302 | Failed to turn the mic on. This may occur when there is a problem with the mic configuration program (driver) on Windows or macOS. Disable and reenable the mic, restart the mic, or update the configuration program. |
+| ERR_MIC_NOT_AUTHORIZED | -1317 | No permission to access to the mic. This usually occurs on mobile devices and may be because the user denied access. |
+| ERR_MIC_OCCUPY | -1319 | The mic is being used. The mic cannot be turned on when, for example, the user is having a call on the mobile device. |
+| ERR_MIC_STOP_FAIL | -1320 | Failed to turn the mic off. |
+| ERR_SPEAKER_START_FAIL | -1321 | Failed to turn the speaker on. This may occur when there is a problem with the speaker configuration program (driver) on Windows or macOS. Disable and reenable the speaker, restart the speaker, or update the configuration program. |
+| ERR_SPEAKER_SET_PARAM_FAIL | -1322 | Failed to set speaker parameters. |
+| ERR_SPEAKER_STOP_FAIL | -1323 | Failed to turn the speaker off. |
+| ERR_AUDIO_PLUGIN_START_FAIL | -1330 | Failed to record computer audio, which may be because the audio driver is unavailable. |
+| ERR_AUDIO_PLUGIN_INSTALL_NOT_AUTHORIZED | -1331 | No permission to install the audio driver. |
+| ERR_AUDIO_PLUGIN_INSTALL_FAILED | -1332 | Failed to install the audio driver. |
+| ERR_AUDIO_PLUGIN_INSTALLED_BUT_NEED_RESTART | -1333 | The virtual sound card is installed successfully, but due to the restrictions of macOS, you cannot use it right after installation. Ask users to restart the app upon receiving this error code. |
+| ERR_AUDIO_ENCODE_FAIL | -1304 | Failed to encode audio frames. This may occur if the SDK could not process the custom audio data passed in. |
+| ERR_UNSUPPORTED_SAMPLERATE | -1306 | Unsupported audio sample rate. |
+| ERR_SYSTEM_LOOPBACK_START_FAILED | -1307 | System audio loopback startup encountered an error. Common error reasons and solutions are: 1. The current system version does not support the include or excluded specified process loopback function, which requires Windows system version 10.0.19042 (20H2) or higher. For x64 specified path loopback function, it also requires Windows system version 10.0.19042 (20H2) or higher. Please check the current system version. 2. Invalid input parameters (including empty parameters, non-existent input paths, non-existent process IDs, and non-existent device names). Please check whether the input parameters are legal. 3. No available speaker device, please check whether it is available. |
+| ERR_SYSTEM_LOOPBACK_THIRD_PARTY_APP_EXIT | -1324 | The third party app loopback capture encountered an error. This error occurred after the third party app loopback was successfully started. During the sound collection process, the specified process or application unexpectedly exited. Please check the status of the specified process or application and try again by re-entering the process number |
+| ERR_TRTC_ENTER_ROOM_FAILED | -3301 | Failed to enter the room. For the reason, refer to the error message for -3301 in <code> onError </code>. |
+| ERR_TRTC_REQUEST_IP_TIMEOUT | -3307 | IP and signature request timed out. Check your network connection and whether your firewall allows UDP.<br>Try visiting the IP address 162.14.22.165:8000 or 162.14.6.105:8000 and the domain default-query.trtc.tencent-cloud.com:8000. |
+| ERR_TRTC_CONNECT_SERVER_TIMEOUT | -3308 | Room entry request timed out. Check your network connection and whether VPN is used. You can also switch to 4G to run a test. |
+| ERR_TRTC_ROOM_PARAM_NULL | -3316 | Empty room entry parameters. Please check whether valid parameters were passed in to the <code> enterRoom:appScene: </code> API. |
+| ERR_TRTC_INVALID_SDK_APPID | -3317 | Incorrect room entry parameter. Check whether <code> TRTCParams.sdkAppId </code> is empty. |
+| ERR_TRTC_INVALID_ROOM_ID | -3318 | Incorrect room entry parameter. Check whether <code> TRTCParams.roomId </code> or <code> TRTCParams.strRoomId </code> is empty. Note that you cannot set both parameters. |
+| ERR_TRTC_INVALID_USER_ID | -3319 | Incorrect room entry parameter. Check whether <code> TRTCParams.userId </code> is empty. |
+| ERR_TRTC_INVALID_USER_SIG | -3320 | Incorrect room entry parameter. Check whether <code> TRTCParams.userSig </code> is empty. |
+| ERR_TRTC_ENTER_ROOM_REFUSED | -3340 | Request to enter room denied. Check whether you called <code> enterRoom </code> twice to enter the same room. |
+| ERR_TRTC_INVALID_PRIVATE_MAPKEY | -100006 | Advanced permission control is enabled but failed to verify <code> TRTCParams.privateMapKey </code>.<br>For details, see <a href="https://intl.cloud.tencent.com/document/product/647/35157">Enabling Advanced Permission Control</a>. |
+| ERR_TRTC_SERVICE_SUSPENDED | -100013 | The service is unavailable. Check if you have used up your package or whether your Tencent Cloud account has overdue payments. |
+| ERR_TRTC_USER_SIG_CHECK_FAILED | -100018 | Failed to verify <code> UserSig </code>. Check whether <code> TRTCParams.userSig </code> is correct or valid.<br>For details, see <a href="https://intl.cloud.tencent.com/document/product/647/39074">UserSig Generation and Verification</a>. |
+| ERR_TRTC_PUSH_THIRD_PARTY_CLOUD_TIMEOUT | -3321 | The relay to CDN request timed out |
+| ERR_TRTC_MIX_TRANSCODING_TIMEOUT | -3322 | The On-Cloud MixTranscoding request timed out. |
+| ERR_TRTC_PUSH_THIRD_PARTY_CLOUD_FAILED | -3323 | Abnormal response packets for relay. |
+| ERR_TRTC_MIX_TRANSCODING_FAILED | -3324 | Abnormal response packet for On-Cloud MixTranscoding. |
+| ERR_TRTC_START_PUBLISHING_TIMEOUT | -3333 | Signaling for publishing to the Tencent Cloud CDN timed out. |
+| ERR_TRTC_START_PUBLISHING_FAILED | -3334 | Signaling for publishing to the Tencent Cloud CDN was abnormal. |
+| ERR_TRTC_STOP_PUBLISHING_TIMEOUT | -3335 | Signaling for stopping publishing to the Tencent Cloud CDN timed out. |
+| ERR_TRTC_STOP_PUBLISHING_FAILED | -3336 | Signaling for stopping publishing to the Tencent Cloud CDN was abnormal. |
+| ERR_TRTC_CONNECT_OTHER_ROOM_TIMEOUT | -3326 | The co-anchoring request timed out. |
+| ERR_TRTC_DISCONNECT_OTHER_ROOM_TIMEOUT | -3327 | The request to stop co-anchoring timed out. |
+| ERR_TRTC_CONNECT_OTHER_ROOM_INVALID_PARAMETER | -3328 | Invalid parameter. |
+| ERR_TRTC_CONNECT_OTHER_ROOM_AS_AUDIENCE | -3330 | The current user is an audience member and cannot request or stop cross-room communication. Please call <code> switchRole </code> to switch to an anchor first. |
+| ERR_BGM_OPEN_FAILED | -4001 | Failed to open the file, such as invalid data found when processing input, ffmpeg protocol not found, etc. |
+| ERR_BGM_DECODE_FAILED | -4002 | Audio file decoding failed. |
+| ERR_BGM_OVER_LIMIT | -4003 | The number exceeds the limit, such as preloading two background music at the same time. |
+| ERR_BGM_INVALID_OPERATION | -4004 | Invalid operation, such as calling a preload function after starting playback. |
+| ERR_BGM_INVALID_PATH | -4005 | Invalid path, Please check whether the path you passed points to a legal music file. |
+| ERR_BGM_INVALID_URL | -4006 | Invalid URL, Please use a browser to check whether the URL address you passed in can download the desired music file. If the operating system is iOS or MacOS, please ensure the use of HTTPS links.. |
+| ERR_BGM_NO_AUDIO_STREAM | -4007 | No audio stream, Please confirm whether the file you passed is a legal audio file and whether the file is damaged. |
+| ERR_BGM_FORMAT_NOT_SUPPORTED | -4008 | Unsupported format, Please confirm whether the file format you passed is a supported file format. The mobile version supports [mp3, aac, m4a, wav, ogg, mp4, mkv], and the desktop version supports [mp3, aac, m4a, wav, mp4, mkv]. |
+| ERR_CONCURRENT_BGM_OVER_LIMIT | -4009 | The number of concurrent BGM playbacks has exceeded the limit. This error occurs when more than 10 BGMs are playing simultaneously. Please check the number of concurrent BGM playbacks.ConcurrentBgmOverLimit |
+
+## TXLiteAVWarning
+
+**Warning codes.**
+| Enum | Value | DESC |
+| --- | --- | --- |
+| WARNING_HW_ENCODER_START_FAIL | 1103 | Failed to start the hardware encoder. Switched to software encoding. |
+| WARNING_CURRENT_ENCODE_TYPE_CHANGED | 1104 | The codec changed.<br>The additional field <code> type </code> in <code> onWarning </code> indicates the codec currently in use. <code> 0 </code> indicates H.264, and <code> 1 </code> indicates H.265.<br>The additional field <code> hardware </code> in <code> onWarning </code> indicates the encoder type currently in use. <code> 0 </code> indicates software encoder, and <code> 1 </code> indicates hardware encoder.<br>The additional field <code> stream </code> in <code> onWarning </code> indicates the stream type currently in use. <code> 0 </code> indicates big stream, and <code> 1 </code> indicates small stream, and <code> 2 </code> indicates sub stream. |
+| WARNING_VIDEO_ENCODER_SW_TO_HW | 1107 | Insufficient CPU for software encoding. Switched to hardware encoding. |
+| WARNING_INSUFFICIENT_CAPTURE_FPS | 1108 | The capturing frame rate of the camera is insufficient. This error occurs on some Android phones with built-in beauty filters. |
+| WARNING_SW_ENCODER_START_FAIL | 1109 | Failed to start the software encoder. |
+| WARNING_REDUCE_CAPTURE_RESOLUTION | 1110 | The capturing frame rate of the camera was reduced for balance between frame rate and performance. |
+| WARNING_CAMERA_DEVICE_EMPTY | 1111 | No available camera found. |
+| WARNING_CAMERA_NOT_AUTHORIZED | 1112 | The user didn’t grant the application camera permission. |
+| WARNING_OUT_OF_MEMORY | 1113 | Some functions may not work properly due to out of memory. |
+| WARNING_CAMERA_IS_OCCUPIED | 1114 | The camera is occupied. |
+| WARNING_CAMERA_DEVICE_ERROR | 1115 | The camera device is error. |
+| WARNING_CAMERA_DISCONNECTED | 1116 | The camera is disconnected. |
+| WARNING_CAMERA_START_FAILED | 1117 | The camera is started failed. |
+| WARNING_CAMERA_SERVER_DIED | 1118 | The camera sever is died. |
+| WARNING_SCREEN_CAPTURE_NOT_AUTHORIZED | 1206 | The user didn’t grant the application screen recording permission. |
+| WARNING_CURRENT_DECODE_TYPE_CHANGED | 2008 | The codec changed. The additional field <code> type </code> in <code> onWarning </code> indicates the codec currently in use. <code> 1 </code> indicates H.265, and <code> 0 </code> indicates H.264. This field is not supported on Windows. |
+| WARNING_VIDEO_FRAME_DECODE_FAIL | 2101 | Failed to decode the current video frame. |
+| WARNING_HW_DECODER_START_FAIL | 2106 | Failed to start the hardware decoder. The software decoder is used instead. |
+| WARNING_VIDEO_DECODER_HW_TO_SW | 2108 | The hardware decoder failed to decode the first I-frame of the current stream. The SDK automatically switched to the software decoder. |
+| WARNING_SW_DECODER_START_FAIL | 2109 | Failed to start the software decoder. |
+| WARNING_VIDEO_RENDER_FAIL | 2110 | Failed to render the video. |
+| WARNING_VIRTUAL_BACKGROUND_DEVICE_UNSURPORTED | 8001 | The device does not support virtual background |
+| WARNING_VIRTUAL_BACKGROUND_NOT_AUTHORIZED | 8002 | Virtual background not authorized |
+| WARNING_VIRTUAL_BACKGROUND_INVALID_PARAMETER | 8003 | Enable virtual background with invalid parameter |
+| WARNING_VIRTUAL_BACKGROUND_PERFORMANCE_INSUFFICIENT | 8004 | Virtual background performance insufficient |
+| WARNING_MICROPHONE_DEVICE_EMPTY | 1201 | No available mic found. |
+| WARNING_SPEAKER_DEVICE_EMPTY | 1202 | No available speaker found. |
+| WARNING_MICROPHONE_NOT_AUTHORIZED | 1203 | The user didn’t grant the application mic permission. |
+| WARNING_MICROPHONE_DEVICE_ABNORMAL | 1204 | The audio capturing device is unavailable (which may be because the device is used by another application or is considered invalid by the system). |
+| WARNING_SPEAKER_DEVICE_ABNORMAL | 1205 | The audio playback device is unavailable (which may be because the device is used by another application or is considered invalid by the system). |
+| WARNING_BLUETOOTH_DEVICE_CONNECT_FAIL | 1207 | The bluetooth device failed to connect (which may be because another app is occupying the audio channel by setting communication mode). |
+| WARNING_MICROPHONE_IS_OCCUPIED | 1208 | The audio capturing device is occupied. |
+| WARNING_AUDIO_FRAME_DECODE_FAIL | 2102 | Failed to decode the current audio frame. |
+| WARNING_AUDIO_RECORDING_WRITE_FAIL | 7001 | Failed to write recorded audio into the file. |
+| WARNING_MICROPHONE_HOWLING_DETECTED | 7002 | Detect capture audio howling |
+| WARNING_IGNORE_UPSTREAM_FOR_AUDIENCE | 6001 | The current user is an audience member and cannot publish audio or video. Please switch to an anchor first. |
+| WARNING_UPSTREAM_AUDIO_AND_VIDEO_OUT_OF_SYNC | 6006 | The audio or video sending timestamps are abnormal, which may cause audio and video synchronization issues. |
+| WARNING_RECONNECT_ON_SERVER_STATUS_ABNORMAL | 6007 | The server status is abnormal and reconnecting is in progress |