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

package/resource/doc/trtc/iOS/TXDeviceManager.md

@@ -1,381 +0,0 @@
-# TRTC SDK Documentation
-## Feature Overview
-`TXDeviceManager.h` provides audio and video device management for the TRTC (Real-Time Communication) SDK on iOS. Use this module to control hardware devices such as cameras, microphones, and speakers.
-
-## TXDeviceObserver
-| Function List | Description |
-| --- | --- |
-| onDeviceChanged:type:state: | Local device connection status has changed (applicable only to desktop systems) |
-
-## TXDeviceManager
-| Function List | Description |
-| --- | --- |
-| isFrontCamera | Determine whether the current camera is front-facing (only for mobile terminal) |
-| switchCamera: | Switch between front and rear cameras (only for mobile terminal) |
-| isCameraZoomSupported | Check if the current camera supports scaling (only for mobile terminal) |
-| getCameraZoomMaxRatio | Get the maximum zoom level of the camera (only for mobile terminal) |
-| setCameraZoomRatio: | Set the zoom level of the camera (only for mobile terminal) |
-| isAutoFocusEnabled | Check if automatic face position recognition is supported (only for mobile terminal) |
-| enableCameraAutoFocus: | Enable autofocus feature (only for mobile terminal) |
-| setCameraFocusPosition: | Set the focus position of the camera (only for mobile terminal) |
-| isCameraTorchSupported | Check if the flash can be turned on (only for mobile terminal) |
-| enableCameraTorch: | Turn the flash on/off, also known as flashlight mode (only for mobile terminal) |
-| setAudioRoute: | Set audio routing (only for mobile terminal) |
-| setExposureCompensation: | Set the exposure parameters of the camera, ranging from -1 to 1 |
-| getDevicesList: | Get the device list (only for desktop terminal) |
-| setCurrentDevice:deviceId: | Set the current device to use (only for desktop terminal) |
-| getCurrentDevice: | Get the current device in use (only for desktop terminal) |
-| setCurrentDeviceVolume:deviceType: | Set the current device volume (only for desktop terminal) |
-| getCurrentDeviceVolume: | Get the current device volume (only for desktop terminal) |
-| setCurrentDeviceMute:deviceType: | Set the mute status of the current device (only for desktop terminal) |
-| getCurrentDeviceMute: | Get the mute status of the current device (only for desktop terminal) |
-| enableFollowingDefaultAudioDevice:enable: | Set SDK to use the audio device according to the default system device (only for desktop terminal) |
-| startCameraDeviceTest: | Start camera testing (only for desktop terminal) |
-| stopCameraDeviceTest | End camera testing (only for desktop terminal) |
-| startMicDeviceTest: | Start mic testing (only for desktop terminal) |
-| startMicDeviceTest:playback: | Start mic testing (only for desktop terminal) |
-| stopMicDeviceTest | End mic testing (only for desktop terminal) |
-| startSpeakerDeviceTest: | Start speaker testing (only for desktop terminal) |
-| stopSpeakerDeviceTest | End speaker testing (only for desktop terminal) |
-| setObserver: | Device hot swap callback (only for macOS System) |
-| setCameraCapturerParam: | Set camera capture preferences |
-| setSystemVolumeType: | Set system volume type (only for mobile terminal) |
-
-## Struct Type
-| Function List | Description |
-| --- | --- |
-| TXCameraCaptureParam | Camera collection parameters |
-| TXMediaDeviceInfo | Information related to audio and video equipment (only for desktop platform) |
-
-## Enumeration Types
-| Enumeration Types | Description |
-| --- | --- |
-| TXSystemVolumeType | System volume type (only for mobile devices) |
-| TXAudioRoute | Audio routing (i.e., sound playback mode) |
-| TXMediaDeviceType | Device type (only for desktop platform) |
-| TXMediaDeviceState | Device operations |
-| TXCameraCaptureMode | Camera capture preferences |
-
-## onDeviceChanged:type:state:
-
-#### Local device connection status has changed (applicable only to desktop systems)
-
-When local devices (including camera, microphone, and speaker) are plugged in or unplugged, the SDK will trigger this event callback.
-| Parameters | Description |
-| --- | --- |
-| deviceId | Device ID |
-| state | On/Off status, 0: Device added; 1: Device removed; 2: Device enabled. |
-| type | Device Type |
-
-## isFrontCamera
-
-#### Determine whether the current camera is front-facing (only for mobile terminal)
-
-## switchCamera:
-
-#### Switch between front and rear cameras (only for mobile terminal)
-
-## isCameraZoomSupported
-
-#### Check if the current camera supports scaling (only for mobile terminal)
-
-## getCameraZoomMaxRatio
-
-#### Get the maximum zoom level of the camera (only for mobile terminal)
-
-## setCameraZoomRatio:
-
-#### Set the zoom level of the camera (only for mobile terminal)
-| Parameters | Description |
-| --- | --- |
-| zoomRatio | Value range 1 - 5, with 1 representing the farthest view (normal lens) and 5 representing the closest view (magnifier lens). The recommended maximum value is 5; exceeding 5 may cause video data to become blurry. |
-
-## isAutoFocusEnabled
-
-#### Check if automatic face position recognition is supported (only for mobile terminal)
-
-## enableCameraAutoFocus:
-
-#### Enable autofocus feature (only for mobile terminal)
-
-Once enabled, the SDK will automatically detect the face position in the frame and keep the camera focus on the face position.
-
-## setCameraFocusPosition:
-
-#### Set the focus position of the camera (only for mobile terminal)
-
-You can achieve the following interactions with this interface:
-
-1. Allow users to click on the local camera preview screen.
-
-2. Display a rectangular box at the click position to indicate that the camera will focus on this point.
-
-3. Then, pass the coordinates of the user's click position through this interface to the SDK. The SDK will control the camera to focus on the user's desired location.
-| Parameters | Description |
-| --- | --- |
-| position | Focus position, please pass the coordinates of the desired focus point |
-
-> **Note**
->
-
-> The prerequisite for using this interface is to disable the auto-focus feature through enableCameraAutoFocus.
->
-
-#### Return value description:
-
-0: Operation successful; Negative value: Operation failed.
-
-## isCameraTorchSupported
-
-#### Check if the flash can be turned on (only for mobile terminal)
-
-## enableCameraTorch:
-
-#### Turn the flash on/off, also known as flashlight mode (only for mobile terminal)
-
-## setAudioRoute:
-
-#### Set audio routing (only for mobile terminal)
-
-A phone has two audio playback devices: one is the earpiece at the top of the phone, and the other is the stereo speaker at the bottom of the phone.
-
-When the audio routing is set to the earpiece, the sound is relatively low, and you need to bring your ear close to hear it clearly, ensuring better privacy. It is suitable for phone calls.
-
-When the audio routing is set to the speaker, the sound is relatively loud. You can hear it clearly without holding the phone to your face, thus enabling the "hands-free" feature.
-
-## setExposureCompensation:
-
-#### Set the exposure parameters of the camera, ranging from -1 to 1
-
-## getDevicesList:
-
-#### Get the device list (only for desktop terminal)
-| Parameters | Description |
-| --- | --- |
-| type | Device type, specify which type of device list to retrieve. See TXMediaDeviceType Definition for details. |
-
-> **Note**
->
-> -  After use, please call the release method to release resources so that the SDK can maintain the lifecycle of the ITXDeviceCollection object.
-> -  Do not use delete to release the returned Collection object. Deleting the ITXDeviceCollection* pointer will cause an abnormal crash.
-> -  type only supports TXMediaDeviceTypeMic, TXMediaDeviceTypeSpeaker, TXMediaDeviceTypeCamera.
-> -  This interface only supports Mac and Windows platforms.
-
-## setCurrentDevice:deviceId:
-
-#### Set the current device to use (only for desktop terminal)
-| Parameters | Description |
-| --- | --- |
-| deviceId | Device ID, you can obtain the device ID through the getDevicesList interface. |
-| type | Device type, see TXMediaDeviceType Definition for details. |
-
-#### Return value description:
-
-0: Operation successful; Negative value: Operation failed.
-
-## getCurrentDevice:
-
-#### Get the current device in use (only for desktop terminal)
-
-## setCurrentDeviceVolume:deviceType:
-
-#### Set the current device volume (only for desktop terminal)
-
-The volume here refers to the capture volume of the microphone or the playback volume of the speaker. The camera does not support setting the volume.
-| Parameters | Description |
-| --- | --- |
-| volume | Volume. Value range: 0-100. Default value: 100. |
-
-## getCurrentDeviceVolume:
-
-#### Get the current device volume (only for desktop terminal)
-
-The volume here refers to the capture volume of the microphone or the playback volume of the speaker. The camera does not support retrieving the volume.
-
-## setCurrentDeviceMute:deviceType:
-
-#### Set the mute status of the current device (only for desktop terminal)
-
-The volume here refers to the microphone and speaker, and the camera does not support silent operation.
-
-## getCurrentDeviceMute:
-
-#### Get the mute status of the current device (only for desktop terminal)
-
-The volume here refers to the microphone and speaker, and the camera does not support silent operation.
-
-## enableFollowingDefaultAudioDevice:enable:
-
-#### Set SDK to use the audio device according to the default system device (only for desktop terminal)
-
-Only microphone and speaker types are supported. The camera does not yet support following the system default device
-| Parameters | Description |
-| --- | --- |
-| enable | Whether to follow the system default audio device.<br>-  true: Follow. When the system default audio device changes or a new audio device is plugged in, the SDK will immediately switch the audio device.<br>-  false: Do not follow. When the system default audio device changes or a new audio device is plugged in, the SDK will not switch the audio device. |
-| type | Device type, see TXMediaDeviceType Definition for details. |
-
-## startCameraDeviceTest:
-
-#### Start camera testing (only for desktop terminal)
-
-> **Note**
->
-
-> During testing, you can use the setCurrentDevice interface to switch cameras.
->
-
-## stopCameraDeviceTest
-
-#### End camera testing (only for desktop terminal)
-
-## startMicDeviceTest:
-
-#### Start mic testing (only for desktop terminal)
-
-This interface can test whether the microphone is working properly. The volume of the microphone's audio stream will be notified to you via callback, with the volume range being 0 to 100.
-| Parameters | Description |
-| --- | --- |
-| interval | Microphone volume callback interval. |
-
-> **Note**
->
-
-> After invoking this interface, the recorded microphone sound will be played back through the speaker by default.
->
-
-## startMicDeviceTest:playback:
-
-#### Start mic testing (only for desktop terminal)
-
-This interface can test whether the microphone is working properly. The volume of the microphone's audio stream will be notified to you via callback, with the volume range being 0 to 100.
-| Parameters | Description |
-| --- | --- |
-| interval | Microphone volume callback interval. |
-| playback | Whether to enable microphone sound playback. When enabled, users will hear their own voice during microphone testing. |
-
-## stopMicDeviceTest
-
-#### End mic testing (only for desktop terminal)
-
-## startSpeakerDeviceTest:
-
-#### Start speaker testing (only for desktop terminal)
-
-This interface tests the playback device by playing a specified audio file. If the user hears sound during the test, it means the playback device is working properly.
-| Parameters | Description |
-| --- | --- |
-| filePath | Path to the audio file |
-
-## stopSpeakerDeviceTest
-
-#### End speaker testing (only for desktop terminal)
-
-## setObserver:
-
-#### Device hot swap callback (only for macOS System)
-
-## setCameraCapturerParam:
-
-#### Set camera capture preferences
-
-## setSystemVolumeType:
-
-#### Set system volume type (only for mobile terminal)
-
-@deprecated Not recommended starting from version 9.5. It is advised to use the startLocalAudio(quality) interface in ` TRTCCloud ` as a replacement, and decide the sound quality via the quality parameter.
-
-## TXSystemVolumeType(Deprecated)
-
-#### System volume type (only for mobile devices)
-
-@deprecated Not recommended starting from version 9.5.
-
-Modern smartphones generally have two sets of system volume types, namely "Call volume" and "Media volume".
--  Call Volume: A volume type designed specifically for making and receiving phone calls, featuring built-in echo cancellation (AEC), and supporting microphone input via Bluetooth headphones. However, the sound quality is relatively average.
-
-If you press the volume button on the side of your phone to lower the volume and it cannot be set to zero (completely silent), it indicates that your phone is currently in Call Volume mode.
--  Media Volume: A volume type designed specifically for music scenarios, which cannot use the system's AEC feature, and does not support microphone input via Bluetooth headphones, but provides better music playback quality.
-
-If you press the volume button on the side of your phone to lower the volume and it can be set to completely silent, it indicates that your phone is currently in Media Volume mode.
-
-The SDK currently provides three control modes for system volume types: automatic switching mode, full-time call volume mode, and full-time media volume mode.
-| Enumeration | Value | Description |
-| --- | --- | --- |
-| TXSystemVolumeTypeAuto | 0 | Automatic Switching Mode |
-| TXSystemVolumeTypeMedia | 1 | Full Media Volume |
-| TXSystemVolumeTypeVOIP | 2 | Full Call Volume |
-
-## TXAudioRoute
-
-#### Audio routing (i.e., sound playback mode)
-
-Audio routing refers to whether the sound is played through the phone's speaker or receiver, and thus this interface is only applicable to mobile devices such as smartphones.
-
-A mobile phone has two speakers: one is the earpiece located at the top of the phone, and the other is the stereo speaker located at the bottom.
--  When the audio routing is set to the earpiece, the sound is relatively low, and you need to bring your ear close to hear it clearly, ensuring better privacy. It is suitable for phone calls.
-
--  When the audio routing is set to the speaker, the sound is relatively loud. You can hear it clearly without holding the phone to your face, thus enabling the "hands-free" feature.
-
-| Enumeration | Value | Description |
-| --- | --- | --- |
-| TXAudioRouteSpeakerphone | 0 | Speakerphone: Plays through the speaker (i.e., "hands-free"), located at the bottom of the phone, with a louder volume, suitable for playing music aloud. |
-| TXAudioRouteEarpiece | 1 | Earpiece: Use the earpiece to play audio. The earpiece is located at the top of the phone and produces a low volume, making it suitable for privacy-sensitive call scenarios. |
-
-## TXMediaDeviceType
-
-#### Device type (only for desktop platform)
-
-This enumeration value is used for the three types of audio and video devices in Definition: camera, microphone, and speaker, allowing a single device management interface to control different types of devices.
-| Enumeration | Value | Description |
-| --- | --- | --- |
-| TXMediaDeviceTypeUnknown | -1 | Undefined device type |
-| TXMediaDeviceTypeAudioInput | 0 | Microphone-type device |
-| TXMediaDeviceTypeAudioOutput | 1 | Speaker-type device |
-| TXMediaDeviceTypeVideoCamera | 2 | Camera-type device |
-
-## TXMediaDeviceState
-
-#### Device operations
-
-This enumeration value is used for local device status change notifications onDeviceChanged.
-| Enumeration | Value | Description |
-| --- | --- | --- |
-| TXMediaDeviceStateAdd | 0 | Device inserted |
-| TXMediaDeviceStateRemove | 1 | Device removed |
-| TXMediaDeviceStateActive | 2 | Device enabled |
-| TXMediaDefaultDeviceChanged | 3 | System default device changed |
-
-## TXCameraCaptureMode
-
-#### Camera capture preferences
-
-This enumeration type is used for camera collection parameter settings.
-| Enumeration | Value | Description |
-| --- | --- | --- |
-| TXCameraResolutionStrategyAuto | 0 | Auto-adjust collection parameters.<br>The SDK selects appropriate camera output parameters based on the performance of the actual capture device and network conditions, maintaining a balance between device performance and video preview quality. |
-| TXCameraResolutionStrategyPerformance | Not Defined | Prioritize device performance.<br>The SDK selects the closest camera output parameters based on the encoder resolution and frame rate set by the user, thus ensuring device performance. |
-| TXCameraResolutionStrategyHighQuality | Not Defined | Priority is given to ensuring video preview quality.<br>The SDK selects higher camera output parameters to improve the quality of preview video. In this case, more CPU and memory will be consumed for video preprocessing. |
-| TXCameraCaptureManual | Not Defined | Users are allowed to set the video aspect ratio captured by the local camera. |
-
-## TXCameraCaptureParam
-
-#### Camera collection parameters
-
-This setting determines the image quality of the local preview.
-| Enumeration Types | Description |
-| --- | --- |
-| height | **Field Definition:** Captured Image Width |
-| mode | **Field Definition:** Camera Capture Preferences, refer to TXCameraCaptureMode |
-| width | **Field Definition:** Captured Image Length |
-
-## TXMediaDeviceInfo
-
-#### Information related to audio and video equipment (only for desktop platform)
-
-This structure is used to describe key information of an audio and video device, such as Device ID, Device Name, etc., so that users can select their desired audio and video device in the user interface.
-| Enumeration Types | Description |
-| --- | --- |
-| deviceId | Device ID (UTF-8) |
-| deviceName | Device Name (UTF-8) |
-| deviceProperties | Device Attributes |
-| type | Device Type |

package/resource/doc/trtc/iOS/TXLiteAVCode.md

@@ -1,130 +0,0 @@
-# TRTC Real-Time Communication (TRTC SDK) Documentation
-## Overview
-`TXLiteAVCode.h` provides status code definitions for TRTC Real-Time Communication (TRTC SDK) on iOS. This file is used to notify developers of warnings and errors that occur while using TRTC.
-
-## 枚举类型
-| Enumeration Types | Description |
-| --- | --- |
-| TXLiteAVError | Error Code |
-| TXLiteAVWarning | Warning Codes |
-
-## TXLiteAVError
-
-#### 错误码。
-| Enumeration | Value | Description |
-| --- | --- | --- |
-| ERR_NULL | 0 | No error |
-| ERR_FAILED | -1 | A common error not yet classified |
-| ERR_INVALID_PARAMETER | -2 | An invalid parameter was passed in during API calling |
-| ERR_REFUSED | -3 | The API call was rejected |
-| ERR_NOT_SUPPORTED | -4 | Does not support API call currently |
-| ERR_INVALID_LICENSE | -5 | Failed to call the API due to invalid license |
-| ERR_REQUEST_SERVER_TIMEOUT | -6 | The server request timed out |
-| ERR_SERVER_PROCESS_FAILED | -7 | The server could not handle your request |
-| ERR_DISCONNECTED | -8 | Disconnect from user |
-| ERR_CAMERA_START_FAIL | -1301 | Failed to enable the camera; for example, the configuration program (driver) of the camera on Windows or macOS was exceptional. In this case, please try to disable and then enable the camera again, restart the device, or update the configuration program |
-| ERR_CAMERA_NOT_AUTHORIZED | -1314 | The camera is not authorized. This error usually occurs on mobile devices and may be caused by permission denial by user |
-| ERR_CAMERA_SET_PARAM_FAIL | -1315 | Incorrect camera parameter settings (unsupported value or other causes) |
-| ERR_CAMERA_OCCUPY | -1316 | The camera is being used. Please try to enable another camera |
-| ERR_SCREEN_CAPTURE_START_FAIL | -1308 | Failed to start screen sharing. If this error occurs on a mobile device, it may be caused by permission denial by user; if on Windows or macOS, please check whether parameters of the screen sharing API meet the requirements |
-| ERR_SCREEN_CAPTURE_UNSURPORT | -1309 | Screen sharing failed. Please use Android 5.0 or above if the device is on Android or use iOS 11.0 or above if the device is on iOS |
-| ERR_SCREEN_CAPTURE_STOPPED | -7001 | Screencapturing was stopped by the system |
-| ERR_SCREEN_SHARE_NOT_AUTHORIZED | -102015 | No permission for uplink auxiliary route |
-| ERR_SCREEN_SHRAE_OCCUPIED_BY_OTHER | -102016 | Other users are upstreaming substream |
-| ERR_VIDEO_ENCODE_FAIL | -1303 | Failed to encode video frames; for example, when a user switches from an iOS device to another device, the hardware encoder may be released by the system; and after the user switches back, this error may be thrown before the hardware encoder is restarted |
-| ERR_UNSUPPORTED_RESOLUTION | -1305 | Unsupported video resolution |
-| ERR_PIXEL_FORMAT_UNSUPPORTED | -1327 | Custom Video Capture: Unsupported pixel format |
-| ERR_BUFFER_TYPE_UNSUPPORTED | -1328 | Custom Video Capture: Unsupported buffer type |
-| ERR_NO_AVAILABLE_HEVC_DECODERS | -2304 | No available HEVC decoder found |
-| ERR_MIC_START_FAIL | -1302 | Failed to enable the mic; for example, the configuration program (driver) of the mic on Windows or macOS was exceptional. In this case, please try to disable and then enable the mic again, restart the device, or update the configuration program |
-| ERR_MIC_NOT_AUTHORIZED | -1317 | No access to the microphone. This usually occurs on mobile devices and may be because the user denied the access. |
-| ERR_MIC_OCCUPY | -1319 | The microphone is occupied. This occurs when, for example, the user is currently having a call on the mobile device. |
-| ERR_MIC_STOP_FAIL | -1320 | Failed to stop the microphone. |
-| ERR_SPEAKER_START_FAIL | -1321 | Failed to enable the speaker; for example, the configuration program (driver) of the speaker on Windows or macOS was exceptional. In this case, please try to disable and then enable the speaker again, restart the device, or update the configuration program |
-| ERR_SPEAKER_SET_PARAM_FAIL | -1322 | Failed to set speaker parameters. |
-| ERR_SPEAKER_STOP_FAIL | -1323 | Failed to stop the speaker. |
-| ERR_AUDIO_PLUGIN_START_FAIL | -1330 | console.log('Failed to enable system sound recording; for example, the audio driver plugin was unavailable'); |
-| ERR_AUDIO_PLUGIN_INSTALL_NOT_AUTHORIZED | -1331 | Installation of the audio driver plugin was unauthorized |
-| ERR_AUDIO_PLUGIN_INSTALL_FAILED | -1332 | Failed to install the audio driver plugin |
-| ERR_AUDIO_PLUGIN_INSTALLED_BUT_NEED_RESTART | -1333 | Successfully installed the virtual sound card plugin, but the feature is temporarily unavailable after the first installation. This is a macOS system limitation. Please prompt the user to restart the current app upon receiving this error code |
-| ERR_AUDIO_ENCODE_FAIL | -1304 | Failed to encode audio frames; for example, 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 mixing startup error. Common causes and solutions: 1. The current system version is incompatible. Specifying or excluding specific processes for mixing requires Windows version 10.0.19042 (20H2) or higher. Specifying a path for mixing (x64 version) also requires Windows version 10.0.19042 (20H2) or higher. Please check your current system version. 2. Invalid input parameters (including empty parameters, non-existent paths, non-existent process IDs, and non-existent device names). Please check if the input parameters are valid. 3. No available speaker devices. Please check if any are available. |
-| ERR_SYSTEM_LOOPBACK_THIRD_PARTY_APP_EXIT | -1324 | An error occurred during the mixing and acquisition process of the third-party application. This error may occur after the third-party application's mixing process starts successfully, but the specified process or application unexpectedly exits during the sound acquisition process. Please check the status of the specified process or application. You can try retrying by re-entering the process ID. |
-| ERR_TRTC_ENTER_ROOM_FAILED | -3301 | Failed to enter the room. Please view -3301 in onError to confirm the message for the reason of the failure. |
-| ERR_TRTC_REQUEST_IP_TIMEOUT | -3307 | Request for IP and Sig timed out. Please check whether your network is functioning properly and whether UDP is unblocked in your network firewall.<br>You can try to access the following IPs: 162.14.22.165:8000, 162.14.6.105:8000 and the domain: default-query.trtc.tencent-cloud.com:8000 |
-| ERR_TRTC_CONNECT_SERVER_TIMEOUT | -3308 | Request for room entry timed out. Please check your network connection or whether you are on a VPN. You can also try switching to 4G for confirmation. |
-| ERR_TRTC_ROOM_PARAM_NULL | -3316 | Join Room Parameters are empty. Please check: enterRoom:appScene: whether the valid parameters were passed during the interface call |
-| ERR_TRTC_INVALID_SDK_APPID | -3317 | Join Room Parameters sdkAppId is incorrect. Please check whether TRTCParams.sdkAppId is empty |
-| ERR_TRTC_INVALID_ROOM_ID | -3318 | Join Room Parameters roomId is incorrect. Please check whether TRTCParams.roomId or TRTCParams.strRoomId is empty. Note that roomId and strRoomId cannot be used interchangeably |
-| ERR_TRTC_INVALID_USER_ID | -3319 | Join Room Parameters userId is incorrect. Please check whether TRTCParams.userId is empty |
-| ERR_TRTC_INVALID_USER_SIG | -3320 | Join Room Parameters userSig is incorrect. Please check whether TRTCParams.userSig is empty |
-| ERR_TRTC_ENTER_ROOM_REFUSED | -3340 | Join Room request was denied. Please check whether you continuously invoked enterRoom for the same ID room |
-| ERR_TRTC_INVALID_PRIVATE_MAPKEY | -100006 | You have enabled Advanced Permission Control, but the parameter TRTCParams.privateMapKey failed to verify<br>You can refer to [Advanced Permission Control](https://cloud.tencent.com/document/product/647/32240) for checks |
-| ERR_TRTC_SERVICE_SUSPENDED | -100013 | Unavailable service. Please check whether the remaining validity period in minutes in the package is greater than 0 and whether the Tencent Cloud account is in arrears.<br>You can refer to [Package management](https://cloud.tencent.com/document/product/647/50492) for viewing and configuration |
-| ERR_TRTC_USER_SIG_CHECK_FAILED | -100018 | UserSig verification failed. Please check whether the parameters TRTCParams.userSig are filled correctly or have expired.<br>You can refer to [UserSig Generation and Verification](https://cloud.tencent.com/document/product/647/50686) for verification |
-| ERR_TRTC_PUSH_THIRD_PARTY_CLOUD_TIMEOUT | -3321 | The relayed push request timed out |
-| ERR_TRTC_MIX_TRANSCODING_TIMEOUT | -3322 | The On-Cloud MixTranscoding request timed out |
-| ERR_TRTC_PUSH_THIRD_PARTY_CLOUD_FAILED | -3323 | Exception in Relay to CDN Callback |
-| ERR_TRTC_MIX_TRANSCODING_FAILED | -3324 | Exception in Cloud Mixed Streaming Callback |
-| ERR_TRTC_START_PUBLISHING_TIMEOUT | -3333 | Signaling timed out when starting pushing to Tencent Cloud LVB CDN |
-| ERR_TRTC_START_PUBLISHING_FAILED | -3334 | Signaling was exceptional when starting pushing to Tencent Cloud LVB CDN |
-| ERR_TRTC_STOP_PUBLISHING_TIMEOUT | -3335 | Signaling timed out when stopping pushing to Tencent Cloud LVB CDN |
-| ERR_TRTC_STOP_PUBLISHING_FAILED | -3336 | Signaling was exceptional when stopping pushing to Tencent Cloud LVB CDN |
-| ERR_TRTC_CONNECT_OTHER_ROOM_TIMEOUT | -3326 | Request for mic connection timed out |
-| ERR_TRTC_DISCONNECT_OTHER_ROOM_TIMEOUT | -3327 | Request to exit mic connection timed out |
-| ERR_TRTC_CONNECT_OTHER_ROOM_INVALID_PARAMETER | -3328 | Invalid parameter |
-| ERR_TRTC_CONNECT_OTHER_ROOM_AS_AUDIENCE | -3330 | Currently in audience role. Cannot request or disconnect cross-room mic connection. Please first ` switchRole ` to anchor |
-| ERR_BGM_OPEN_FAILED | -4001 | Failed to open file, such as invalid audio data, FFMPEG protocol not found, etc |
-| ERR_BGM_DECODE_FAILED | -4002 | Audio file decoding failed |
-| ERR_BGM_OVER_LIMIT | -4003 | Quantity exceeds the limit, such as preloading two background music tracks simultaneously |
-| ERR_BGM_INVALID_OPERATION | -4004 | Invalid operation, such as calling preload operation after starting playback |
-| ERR_BGM_INVALID_PATH | -4005 | Invalid path causing file opening failure. Please check if the path parameter points to a valid music file |
-| ERR_BGM_INVALID_URL | -4006 | Invalid URL causing file opening failure. Please check in the browser if the provided URL address can download the intended music file |
-| ERR_BGM_NO_AUDIO_STREAM | -4007 | No audio stream causing file opening failure. Please confirm the file is a valid audio file and is not corrupted |
-| ERR_BGM_FORMAT_NOT_SUPPORTED | -4008 | Unsupported format causing file opening failure. Please confirm if the file format is supported. Mobile supports [mp3, aac, m4a, wav, ogg, mp4, mkv], and desktop supports [mp3, aac, m4a, wav, mp4, mkv] |
-| ERR_CONCURRENT_BGM_OVER_LIMIT | -4009 | The number of background music tracks (BGMs) playing simultaneously has exceeded the limit. If this error message appears after the number of BGMs playing simultaneously exceeds 10, please check the number of concurrently playing BGMs. |
-
-## TXLiteAVWarning
-
-#### 警告码。
-| Enumeration | Value | Description |
-| --- | --- | --- |
-| WARNING_HW_ENCODER_START_FAIL | 1103 | Issue with starting hardware encoding, automatically switched to software encoding |
-| WARNING_CURRENT_ENCODE_TYPE_CHANGED | 1104 | Indicates a change in the encoder. You can get the current encoding format and type through the relevant fields in the extended information of the onWarning function.<br>A value of 0 in the 'type' field represents H.264 encoding, and 1 represents H.265 encoding<br>A value of 0 in the 'hardware' field represents software encoding, and 1 represents hardware encoding<br>A value of 0 in the 'stream' field represents a large stream, 1 represents a small stream, and 2 represents an auxiliary stream |
-| WARNING_VIDEO_ENCODER_SW_TO_HW | 1107 | The current CPU utilization is too high to meet software encoding needs, and the hardware encoder was automatically switch to |
-| WARNING_INSUFFICIENT_CAPTURE_FPS | 1108 | Insufficient frame rate for video capturing through camera. This error may occur in Android mobile devices with an in-built beauty filter algorithm |
-| WARNING_SW_ENCODER_START_FAIL | 1109 | Failed to enable the software encoder |
-| WARNING_REDUCE_CAPTURE_RESOLUTION | 1110 | Camera resolution reduced for balance between frame rate and performance. |
-| WARNING_CAMERA_DEVICE_EMPTY | 1111 | No available camera device detected |
-| WARNING_CAMERA_NOT_AUTHORIZED | 1112 | The current application is not authorized to use the camera |
-| WARNING_OUT_OF_MEMORY | 1113 | Insufficient memory, some features may not function properly. |
-| WARNING_CAMERA_IS_OCCUPIED | 1114 | The camera is being used. |
-| WARNING_CAMERA_DEVICE_ERROR | 1115 | Device anomaly with the camera. |
-| WARNING_CAMERA_DISCONNECTED | 1116 | Unable to connect to the camera. |
-| WARNING_CAMERA_START_FAILED | 1117 | Failed to start the camera. |
-| WARNING_CAMERA_SERVER_DIED | 1118 | System anomaly. |
-| WARNING_SCREEN_CAPTURE_NOT_AUTHORIZED | 1206 | The current application is not authorized to use screen recording |
-| WARNING_CURRENT_DECODE_TYPE_CHANGED | 2008 | Indicates a change in the decoder. You can get the current decoding format through the 'type' field in the extended information of the onWarning function.<br>Among them, 1 represents 265 decoding, and 0 represents 264 decoding. Note that this error code's extended information 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 enable the hardware decoder, and the software decoder was used |
-| WARNING_VIDEO_DECODER_HW_TO_SW | 2108 | The hardware decoder failed to decode the first I frame of the current stream, and the SDK automatically switched to the software decoder |
-| WARNING_SW_DECODER_START_FAIL | 2109 | Failed to enable the software decoder |
-| WARNING_VIDEO_RENDER_FAIL | 2110 | Failed to render video |
-| WARNING_VIRTUAL_BACKGROUND_DEVICE_UNSURPORTED | 8001 | Virtual background device not supported |
-| WARNING_VIRTUAL_BACKGROUND_NOT_AUTHORIZED | 8002 | Virtual background not authorized |
-| WARNING_VIRTUAL_BACKGROUND_INVALID_PARAMETER | 8003 | Virtual background parameter exception |
-| WARNING_VIRTUAL_BACKGROUND_PERFORMANCE_INSUFFICIENT | 8004 | Insufficient virtual background performance |
-| WARNING_MICROPHONE_DEVICE_EMPTY | 1201 | No available mic device detected |
-| WARNING_SPEAKER_DEVICE_EMPTY | 1202 | No available speaker device detected |
-| WARNING_MICROPHONE_NOT_AUTHORIZED | 1203 | The current application is not authorized to use the mic |
-| WARNING_MICROPHONE_DEVICE_ABNORMAL | 1204 | The audio capture device is unavailable (for example, it is in use or the PC determines it as an invalid device) |
-| WARNING_SPEAKER_DEVICE_ABNORMAL | 1205 | The audio playback device is unavailable (for example, it is in use or the PC determines it as an invalid device) |
-| WARNING_BLUETOOTH_DEVICE_CONNECT_FAIL | 1207 | Bluetooth device connection failed (for example, other applications occupying the audio channel through setting the call volume) |
-| WARNING_MICROPHONE_IS_OCCUPIED | 1208 | Audio capture 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 the recorded audio to a file |
-| WARNING_MICROPHONE_HOWLING_DETECTED | 7002 | Howling detected while recording audio |
-| WARNING_IGNORE_UPSTREAM_FOR_AUDIENCE | 6001 | Currently in audience role, publishing audio and video is not supported. Please switch to the anchor role first |
-| WARNING_UPSTREAM_AUDIO_AND_VIDEO_OUT_OF_SYNC | 6006 | Abnormal timestamp of audio and video transmission, which may cause audio and video out of sync issues |
-| WARNING_RECONNECT_ON_SERVER_STATUS_ABNORMAL | 6007 | The server is experiencing an error and is reconnecting |

package/tools/call/get_callkit_api.js

@@ -1,33 +0,0 @@
-import { z } from 'zod';
-import { GET_CALLKIT_API_DEFINITION } from '../definitions/get_callkit_api_def.js';
-import { getDocContent } from '../../utils/get-doc-content.js';
-import { reportCLSClient } from '../../utils/report-cls-client.js';
-import { enrichDocToolResponse } from '../../utils/build-session-directives.js';
-function getResultText(params) {
-    const { framework = '', prompt = '' } = params;
-    reportCLSClient({
-        method: 'get_callkit_api',
-        prompt,
-        framework,
-    });
-    return enrichDocToolResponse(getDocContent(['callkit', 'preset', framework, 'api.md']), { prompt, framework, toolsUsed: 'get_callkit_api' });
-}
-const registryGetCallKitAPITool = (mcpServer) => {
-    const { name, description, parameter_descriptions } = GET_CALLKIT_API_DEFINITION;
-    mcpServer.registerTool(name, {
-        description,
-        inputSchema: {
-            framework: z.enum(['react', 'vue', 'android', 'ios', 'flutter']).describe(parameter_descriptions.framework),
-            prompt: z.string().describe(parameter_descriptions.prompt),
-        },
-    }, (params) => ({
-        content: [
-            {
-                type: 'text',
-                text: getResultText(params),
-            }
-        ]
-    }));
-};
-export { registryGetCallKitAPITool };
-//# sourceMappingURL=get_callkit_api.js.map

package/tools/call/get_callkit_api.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"get_callkit_api.js","sourceRoot":"","sources":["../../../src/tools/call/get_callkit_api.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,0BAA0B,EAAE,MAAM,uCAAuC,CAAC;AACnF,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACnE,OAAO,EAAE,qBAAqB,EAAE,MAAM,yCAAyC,CAAC;AAEhF,SAAS,aAAa,CAAC,MAA2B;IAChD,MAAM,EAAE,SAAS,GAAG,EAAE,EAAE,MAAM,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC;IAC/C,eAAe,CAAC;QACd,MAAM,EAAE,iBAAiB;QACzB,MAAM;QACN,SAAS;KACV,CAAC,CAAC;IACH,OAAO,qBAAqB,CAAC,aAAa,CAAC,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,iBAAiB,EAAE,CAAC,CAAC;AAC/I,CAAC;AAED,MAAM,yBAAyB,GAAG,CAAC,SAAoB,EAAE,EAAE;IACzD,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,sBAAsB,EAAE,GAAG,0BAA0B,CAAC;IACjF,SAAS,CAAC,YAAY,CACpB,IAAI,EACJ;QACE,WAAW;QACX,WAAW,EAAE;YACX,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,sBAAsB,CAAC,SAAS,CAAC;YAC3G,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,sBAAsB,CAAC,MAAM,CAAC;SAC3D;KACF,EACD,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACX,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC;aAC5B;SACF;KACF,CAAC,CACH,CAAC;AACJ,CAAC,CAAC;AAEF,OAAO,EAAE,yBAAyB,EAAE,CAAC"}

package/tools/chat/get_native_chat_uikit_feature_detail.js

@@ -1,35 +0,0 @@
-import { z } from 'zod';
-import { GET_NATIVE_CHAT_UIKIT_FEATURE_DETAIL_DEFINITION } from '../definitions/get_native_chat_uikit_feature_detail_def.js';
-import { getDocContent } from '../../utils/get-doc-content.js';
-import { reportCLSClient } from '../../utils/report-cls-client.js';
-import { enrichDocToolResponse } from '../../utils/build-session-directives.js';
-function getResultText(params) {
-    const { framework, featureName = '', prompt = '' } = params;
-    reportCLSClient({
-        method: 'get_native_chat_feature_detail',
-        prompt,
-        framework,
-        info: featureName,
-    });
-    return enrichDocToolResponse(getDocContent(['chatkit', framework, 'features', `${featureName}.md`]), { prompt, framework, toolsUsed: 'get_native_chat_feature_detail' });
-}
-const registryGetNativeChatUIKitFeatureDetailTool = (mcpServer) => {
-    const { name, description, parameter_descriptions } = GET_NATIVE_CHAT_UIKIT_FEATURE_DETAIL_DEFINITION;
-    mcpServer.registerTool(name, {
-        description,
-        inputSchema: {
-            framework: z.enum(['android', 'ios', 'flutter']).describe(parameter_descriptions.framework),
-            featureName: z.string().describe(parameter_descriptions.featureName),
-            prompt: z.string().describe(parameter_descriptions.prompt),
-        },
-    }, (params) => ({
-        content: [
-            {
-                type: 'text',
-                text: getResultText(params),
-            }
-        ]
-    }));
-};
-export { registryGetNativeChatUIKitFeatureDetailTool };
-//# sourceMappingURL=get_native_chat_uikit_feature_detail.js.map

package/tools/chat/get_native_chat_uikit_feature_detail.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"get_native_chat_uikit_feature_detail.js","sourceRoot":"","sources":["../../../src/tools/chat/get_native_chat_uikit_feature_detail.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,+CAA+C,EAAE,MAAM,4DAA4D,CAAC;AAC7H,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACnE,OAAO,EAAE,qBAAqB,EAAE,MAAM,yCAAyC,CAAC;AAGhF,SAAS,aAAa,CAAC,MAA2B;IAChD,MAAM,EAAE,SAAS,EAAE,WAAW,GAAG,EAAE,EAAE,MAAM,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC;IAC5D,eAAe,CAAC;QACd,MAAM,EAAE,gCAAgC;QACxC,MAAM;QACN,SAAS;QACT,IAAI,EAAE,WAAW;KAClB,CAAC,CAAC;IACH,OAAO,qBAAqB,CAAC,aAAa,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,WAAW,KAAK,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,gCAAgC,EAAE,CAAC,CAAC;AAC3K,CAAC;AAED,MAAM,2CAA2C,GAAG,CAAC,SAAoB,EAAE,EAAE;IAC3E,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,sBAAsB,EAAE,GAAG,+CAA+C,CAAC;IACtG,SAAS,CAAC,YAAY,CACpB,IAAI,EACJ;QACE,WAAW;QACX,WAAW,EAAE;YACX,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,sBAAsB,CAAC,SAAS,CAAC;YAC3F,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,sBAAsB,CAAC,WAAW,CAAC;YACpE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,sBAAsB,CAAC,MAAM,CAAC;SAC3D;KACF,EACD,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACX,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC;aAC5B;SACF;KACF,CAAC,CAAC,CAAC;AACR,CAAC,CAAC;AAEF,OAAO,EAAE,2CAA2C,EAAE,CAAC"}

package/tools/chat/get_web_chat_uikit_component_detail.js

@@ -1,35 +0,0 @@
-import { z } from 'zod';
-import { GET_WEB_CHAT_UIKIT_COMPONENT_DETAIL_DEFINITION } from '../definitions/get_web_chat_uikit_component_detail_def.js';
-import { getDocContent } from '../../utils/get-doc-content.js';
-import { reportCLSClient } from '../../utils/report-cls-client.js';
-import { enrichDocToolResponse } from '../../utils/build-session-directives.js';
-function getResultText(params) {
-    const { framework, componentName = '', prompt = '' } = params;
-    reportCLSClient({
-        method: 'get_web_chat_uikit_component_detail',
-        prompt,
-        framework,
-        info: componentName,
-    });
-    return enrichDocToolResponse(getDocContent(['chatkit', framework, 'components', `${componentName}.md`]), { prompt, framework, toolsUsed: 'get_web_chat_uikit_component_detail' });
-}
-const registryGetWebChatUIKitComponentDetailTool = (mcpServer) => {
-    const { name, description, parameter_descriptions } = GET_WEB_CHAT_UIKIT_COMPONENT_DETAIL_DEFINITION;
-    mcpServer.registerTool(name, {
-        description,
-        inputSchema: {
-            framework: z.enum(['react', 'vue']).describe(parameter_descriptions.framework),
-            componentName: z.string().describe(parameter_descriptions.componentName),
-            prompt: z.string().describe(parameter_descriptions.prompt),
-        },
-    }, (params) => ({
-        content: [
-            {
-                type: 'text',
-                text: getResultText(params),
-            }
-        ]
-    }));
-};
-export { registryGetWebChatUIKitComponentDetailTool };
-//# sourceMappingURL=get_web_chat_uikit_component_detail.js.map

package/tools/chat/get_web_chat_uikit_component_detail.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"get_web_chat_uikit_component_detail.js","sourceRoot":"","sources":["../../../src/tools/chat/get_web_chat_uikit_component_detail.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,8CAA8C,EAAE,MAAM,2DAA2D,CAAC;AAC3H,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACnE,OAAO,EAAE,qBAAqB,EAAE,MAAM,yCAAyC,CAAC;AAGhF,SAAS,aAAa,CAAC,MAA2B;IAChD,MAAM,EAAE,SAAS,EAAE,aAAa,GAAG,EAAE,EAAE,MAAM,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC;IAC9D,eAAe,CAAC;QACd,MAAM,EAAE,qCAAqC;QAC7C,MAAM;QACN,SAAS;QACT,IAAI,EAAE,aAAa;KACpB,CAAC,CAAC;IACH,OAAO,qBAAqB,CAAC,aAAa,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,YAAY,EAAE,GAAG,aAAa,KAAK,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,qCAAqC,EAAE,CAAC,CAAC;AACpL,CAAC;AAED,MAAM,0CAA0C,GAAG,CAAC,SAAoB,EAAE,EAAE;IAC1E,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,sBAAsB,EAAE,GAAG,8CAA8C,CAAC;IACrG,SAAS,CAAC,YAAY,CACpB,IAAI,EACJ;QACE,WAAW;QACX,WAAW,EAAE;YACX,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,sBAAsB,CAAC,SAAS,CAAC;YAC9E,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,sBAAsB,CAAC,aAAa,CAAC;YACxE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,sBAAsB,CAAC,MAAM,CAAC;SAC3D;KACF,EACF,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACV,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC;aAC5B;SACF;KACF,CAAC,CACH,CAAC;AACJ,CAAC,CAAC;AAEF,OAAO,EAAE,0CAA0C,EAAE,CAAC"}