@tencent-rtc/mcp 1.4.7 → 1.6.0

package/resource/doc/callkit/faq/common/error-code.md

@@ -1,47 +0,0 @@
----
-product: 'Call'
-tech_stack: 'callKit'
-framework: 'common'
-title: 'CallKit Error Code Reference'
-keywords: ['error code', 'error', 'callKit usage error', 'call initiation failure']
----
-
-# CallKit Error Code Reference
-
-## CallKit Error Codes (Topic: CallKit Error Code)
-
-## Error Code -1001
-**Cause:** Your application has not yet enabled audio/video call capability (TUICallKit).
-**Solution:** You can apply for a free trial in the console: https://console.intl.cloud.tencent.com/im/detail  or purchase a call capability package: https://buy.cloud.tencent.com/avc?addRavLicense=1&position=1600110000&ravLicenseType=1&regionId=1
-
-## Error Code -1002
-**Cause:** You do not currently have access to this capability.
-**Solution:** Please visit the purchase page to buy and activate: https://buy.cloud.tencent.com/avc?addRavLicense=1&position=1600110000&ravLicenseType=1&regionId=1
-
-## Error Code -1101
-**Cause:** Camera/microphone permission denied.
-**Solution:** Please check your browser settings to ensure camera and microphone access is allowed. If you have confirmed permission is granted, please visit the [Audio/Video Capability Detection Tool](https://web.sdk.qcloud.com/trtc/webrtc/demo/detect/index.html) to check if your device and environment support calling.
-
-## Error Code -1201
-**Cause:** TUICallEngine has not completed initialization or login.
-**Solution:** Please ensure that init or login operations have been successfully executed before calling this feature. Solution: https://cloud.tencent.com/document/product/647/78769#3a61f42b-e06f-49af-88bf-362d40025887
-
-## Error Code 60003
-**Cause:** Microphone device not detected.
-**Solution:** Please ensure your device has a connected microphone and check if the microphone is available in system or browser settings.
-
-## Error Code 60004
-**Cause:** Camera device not detected.
-**Solution:** Please ensure your camera is connected and check if the camera is available in system or browser settings.
-
-## Error Code 60006
-**Cause:** Current browser environment does not support WebRTC functionality.
-**Solution:** Please visit the [Audio/Video Capability Detection Tool](https://web.sdk.qcloud.com/trtc/webrtc/demo/detect/index.html) to check your device and environment compatibility.
-
-## Error Code 30000
-**Cause:** Detected that the current page is using the http protocol.
-**Solution:** To ensure smooth access and full functionality of TUICallEngine SDK for production environment users, please use https protocol (or localhost) to access the audio/video application page. Details: https://web.sdk.qcloud.com/trtc/webrtc/v5/doc/zh-cn/tutorial-05-info-browser.html#h2-3
-
-## Error Code 20007
-**Cause:** Call failed: You have been blocked by the other party or you have blocked the other party.
-**Solution:** Check if the account has been blocked by the other party.

package/resource/doc/callkit/faq/flutter-faq.md

@@ -1,115 +0,0 @@
-### 1. Error message `[-100035]The package you purchased does not support this ability. Please purchase the package` appears during voice or video call？
-
-To make voice or video calls, you need to subscribe to our Call Monthly Package. You can try it for free for 7 days. For more information on how to activate the service, please refer to: [Activate Service (TUICallKit)](https://www.tencentcloud.com/document/product/647/59832).
-
-### 2. Invalid or non-existent UserID of message sender or receiver？
-
-If the user you are calling has not logged in, the call will fail. Please try calling a user who has successfully logged in.
-
-### 3. Error: inviteID is invalid or the invitation has been processed？
-
-The inviteID may be invalid if it has been cancelled by the caller or if the invitation has already been accepted. In some cases, network bandwidth may also affect signaling, causing inviteID invalid errors.
-
-### **4. How to get the call room number RoomId?**
-
-After the call is connected, you can obtain the call room number (RoomId) through the [onCallBegin](https://www.tencentcloud.com/document/product/647/51007#onCallBegin) return roomid field.
-
-### 5. Can TUICallKit be used without importing the Chat SDK?
-
-**No**, all components of TUIKit use Tencent Cloud Chat SDK as the communication base service, including call signaling, busy line signaling, and other core logic. If you have already purchased another Chat product, you can also refer to the TUICallKit logic for adaptation.
-
-### 6. in the TUIChat + TUICallKit Integrated Scenarios, after Upgrading the TUICallKit Version, New Version Calls Old Version and Old Version Is Unable to Receive Call Issues
-
-Starting from TUICallKit version 3.1, in the TUIChat + TUICallKit integrated scenarios, initiating a call through the call button in TUIChat by default uses the new calls API. Therefore, if your business has already gone live, you can use the advanced API to switch the call interface to call or groupCall to maintain interconnectivity with users of the online edition.
-
-You need to call an advanced API once after successful log-in. Specific use on all platforms is as follows:
-
-【iOS(Swift)】
-``` swift
-let jsonParams: [String: Any] = ["api": "forceUseV2API",
-                                 "params": ["enable": true,],]
-guard let data = try? JSONSerialization.data(withJSONObject: jsonParams, options: JSONSerialization.WritingOptions(rawValue: 0)) else { return }
-guard let paramsString = NSString(data: data, encoding: String.Encoding.utf8.rawValue) as? String else { return }
-
-TUICallKit.createInstance().callExperimentalAPI(jsonStr: paramsString)
-```
-
-【iOS(Objective-C)】
-``` cpp
-NSDictionary *jsonParams = @{@"api": @"forceUseV2API",
-                             @"params": @{@"enable": @YES}};
-NSError *error = nil;
-NSData *data = [NSJSONSerialization dataWithJSONObject:jsonParams options:0 error:&error];
-if (error || !data) { return; }
-NSString *paramsString = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
-if (!paramsString) { return;}
-[[TUICallKit createInstance] callExperimentalAPIWithJsonStr:paramsString];
-
-```
-
-【Android(java)】
-``` java
- try {
-    JSONObject params = new JSONObject();
-    params.put("enable", true);
-    JSONObject jsonObject = new JSONObject();
-    jsonObject.put("api", "forceUseV2API");
-    jsonObject.put("params", params);
-    TUICallKit.createInstance(context).callExperimentalAPI(jsonObject.toString());
-} catch (Exception e) {
-    e.printStackTrace();
-}
-
-```
-
-【Android(kotlin)】
-``` java
-try {
-    val params = JSONObject()
-    params.put("enable", true)
-
-    val jsonObject = JSONObject()
-    jsonObject.put("api", "forceUseV2API")
-    jsonObject.put("params", params)
-    TUICallKit.createInstance(context).callExperimentalAPI(jsonObject.toString())
-} catch (e: Exception) {
-    e.printStackTrace()
-}
-
-```
-
-【Flutter(Dart)】
-``` java
-final jsonParams = {'api': 'forceUseV2API',
-                 'params': {'enable': true} };
-
-try {
-    final jsonString = json.encode(jsonParams);
-    TUICallKit.instance.callExperimentalAPI(jsonStr: jsonString);
-} catch (e) {
-    return;
-}
-```
-
-【Web & Mini Programs】
-``` javascript
-const jsonObject = {
-    api: "forceUseV2API",
-    params: {
-      enable: true,
-    }
-};
-TUICallKitServer.getTUICallEngineInstance().callExperimentalAPI(JSON.stringfy(jsonObject));
-```
-
-###
-
-### 7.How to get the log files of each platform?
-
-The current log file paths of each platform are as follows:
-
-- iOS or Mac: In the sandbox Documents/log folder.
-
-- Android: In the /sdcard/Android/data/[your application package name]/files/log/liteav/ folder.
-
-- Windows: In the C:/Users/[system username]/AppData/Roaming/liteav/log, i.e. %APPDATA%/liteav/log folder.

package/resource/doc/callkit/faq/ios-faq.md

@@ -1,115 +0,0 @@
-### 1. Error message `[-100035]The package you purchased does not support this ability. Please purchase the package` appears during voice or video call？
-
-To make voice or video calls, you need to subscribe to our Call Monthly Package. You can try it for free for 7 days. For more information on how to activate the service, please refer to: [Activate Service (TUICallKit)](https://www.tencentcloud.com/document/product/647/59832).
-
-### 2. Invalid or non-existent UserID of message sender or receiver？
-
-If the user you are calling has not logged in, the call will fail. Please try calling a user who has successfully logged in.
-
-### 3. Error: inviteID is invalid or the invitation has been processed？
-
-The inviteID may be invalid if it has been cancelled by the caller or if the invitation has already been accepted. In some cases, network bandwidth may also affect signaling, causing inviteID invalid errors.
-
-### **4. How to get the call room number RoomId?**
-
-After the call is connected, you can obtain the call room number (RoomId) through the [onCallBegin](https://www.tencentcloud.com/document/product/647/51007#onCallBegin) return roomid field.
-
-### 5. Can TUICallKit be used without importing the Chat SDK?
-
-**No**, all components of TUIKit use Tencent Cloud Chat SDK as the communication base service, including call signaling, busy line signaling, and other core logic. If you have already purchased another Chat product, you can also refer to the TUICallKit logic for adaptation.
-
-### 6. in the TUIChat + TUICallKit Integrated Scenarios, after Upgrading the TUICallKit Version, New Version Calls Old Version and Old Version Is Unable to Receive Call Issues
-
-Starting from TUICallKit version 3.1, in the TUIChat + TUICallKit integrated scenarios, initiating a call through the call button in TUIChat by default uses the new calls API. Therefore, if your business has already gone live, you can use the advanced API to switch the call interface to call or groupCall to maintain interconnectivity with users of the online edition.
-
-You need to call an advanced API once after successful log-in. Specific use on all platforms is as follows:
-
-【iOS(Swift)】
-``` swift
-let jsonParams: [String: Any] = ["api": "forceUseV2API",
-                                 "params": ["enable": true,],]
-guard let data = try? JSONSerialization.data(withJSONObject: jsonParams, options: JSONSerialization.WritingOptions(rawValue: 0)) else { return }
-guard let paramsString = NSString(data: data, encoding: String.Encoding.utf8.rawValue) as? String else { return }
-
-TUICallKit.createInstance().callExperimentalAPI(jsonStr: paramsString)
-```
-
-【iOS(Objective-C)】
-``` cpp
-NSDictionary *jsonParams = @{@"api": @"forceUseV2API",
-                             @"params": @{@"enable": @YES}};
-NSError *error = nil;
-NSData *data = [NSJSONSerialization dataWithJSONObject:jsonParams options:0 error:&error];
-if (error || !data) { return; }
-NSString *paramsString = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
-if (!paramsString) { return;}
-[[TUICallKit createInstance] callExperimentalAPIWithJsonStr:paramsString];
-
-```
-
-【Android(java)】
-``` java
- try {
-    JSONObject params = new JSONObject();
-    params.put("enable", true);
-    JSONObject jsonObject = new JSONObject();
-    jsonObject.put("api", "forceUseV2API");
-    jsonObject.put("params", params);
-    TUICallKit.createInstance(context).callExperimentalAPI(jsonObject.toString());
-} catch (Exception e) {
-    e.printStackTrace();
-}
-
-```
-
-【Android(kotlin)】
-``` java
-try {
-    val params = JSONObject()
-    params.put("enable", true)
-
-    val jsonObject = JSONObject()
-    jsonObject.put("api", "forceUseV2API")
-    jsonObject.put("params", params)
-    TUICallKit.createInstance(context).callExperimentalAPI(jsonObject.toString())
-} catch (e: Exception) {
-    e.printStackTrace()
-}
-
-```
-
-【Flutter(Dart)】
-``` java
-final jsonParams = {'api': 'forceUseV2API',
-                 'params': {'enable': true} };
-
-try {
-    final jsonString = json.encode(jsonParams);
-    TUICallKit.instance.callExperimentalAPI(jsonStr: jsonString);
-} catch (e) {
-    return;
-}
-```
-
-【Web & Mini Programs】
-``` javascript
-const jsonObject = {
-    api: "forceUseV2API",
-    params: {
-      enable: true,
-    }
-};
-TUICallKitServer.getTUICallEngineInstance().callExperimentalAPI(JSON.stringfy(jsonObject));
-```
-
-###
-
-### 7.How to get the log files of each platform?
-
-The current log file paths of each platform are as follows:
-
-- iOS or Mac: In the sandbox Documents/log folder.
-
-- Android: In the /sdcard/Android/data/[your application package name]/files/log/liteav/ folder.
-
-- Windows: In the C:/Users/[system username]/AppData/Roaming/liteav/log, i.e. %APPDATA%/liteav/log folder.

package/resource/doc/callkit/faq/web-faq.md

@@ -1,36 +0,0 @@
-### 1. Error message `[-100035]The package you purchased does not support this ability. Please purchase the package` appears during voice or video call？
-
-To make voice or video calls, you need to subscribe to our Call Monthly Package. You can try it for free for 7 days. For more information on how to activate the service, please refer to: [Activate Service (TUICallKit)](https://www.tencentcloud.com/document/product/647/59832).
-
-### 2. Invalid or non-existent UserID of message sender or receiver？
-
-If the user you are calling has not logged in, the call will fail. Please try calling a user who has successfully logged in.
-
-### 3. Error: inviteID is invalid or the invitation has been processed？
-
-The inviteID may be invalid if it has been cancelled by the caller or if the invitation has already been accepted. In some cases, network bandwidth may also affect signaling, causing inviteID invalid errors.
-
-### **4. How to get the call room number RoomId?**
-
-After the call is connected, you can obtain the call room number (RoomId) through the [onCallBegin](https://www.tencentcloud.com/document/product/647/51007#onCallBegin) return roomid field.
-
-### 5. Can TUICallKit be used without importing the Chat SDK?
-
-**No**, all components of TUIKit use Tencent Cloud Chat SDK as the communication base service, including call signaling, busy line signaling, and other core logic. If you have already purchased another Chat product, you can also refer to the TUICallKit logic for adaptation.
-
-### 6. in the TUIChat + TUICallKit Integrated Scenarios, after Upgrading the TUICallKit Version, New Version Calls Old Version and Old Version Is Unable to Receive Call Issues
-
-Starting from TUICallKit version 3.1, in the TUIChat + TUICallKit integrated scenarios, initiating a call through the call button in TUIChat by default uses the new calls API. Therefore, if your business has already gone live, you can use the advanced API to switch the call interface to call or groupCall to maintain interconnectivity with users of the online edition.
-
-You need to call an advanced API once after successful log-in. Specific use on all platforms is as follows:
-
-【Web & Mini Programs】
-``` javascript
-const jsonObject = {
-    api: "forceUseV2API",
-    params: {
-      enable: true,
-    }
-};
-TUICallKitServer.getTUICallEngineInstance().callExperimentalAPI(JSON.stringfy(jsonObject));
-```

package/resource/doc/callkit/preset/android/api.md

@@ -1,296 +0,0 @@
-## TUICallKit APIs
-
-`TUICallKit` is an audio/video call component that **includes UI elements**. You can use its APIs to quickly implement an audio/video call application similar to WeChat. For directions on integration, see [Integrating TUICallKit](https://www.tencentcloud.com/document/product/647/50991).
-
-## API Overview
-| API | Description |
-| --- | --- |
-| createInstance | Creates a `TUICallKit` instance (singleton mode). |
-| setSelfInfo | Sets the alias and profile photo. |
-| calls | Initiate a one-to-one or multi-person call. |
-| join | Proactively join a call. |
-| setCallingBell | Sets the ringtone. |
-| enableMuteMode | Sets whether to turn on the mute mode. |
-| enableFloatWindow | Sets whether to enable floating windows. |
-| enableIncomingBanner | Sets whether to display incoming banner. |
-
-## Details
-
-### createInstance
-
-This API is used to create a `TUICallKit` singleton.
-
-【Kotlin】
-``` java
-fun createInstance(context: Context): TUICallKit
-```
-
-【Java】
-``` java
-TUICallKit createInstance(Context context)
-```
-
-### setSelfInfo
-
-This API is used to set the alias and profile photo. The alias cannot exceed 500 bytes, and the profile photo is specified by a URL.
-
-【Kotlin】
-``` java
-fun setSelfInfo(nickname: String?, avatar: String?, callback: TUICommonDefine.Callback?)
-```
-
-【Java】
-``` java
-void setSelfInfo(String nickname, String avatar, TUICommonDefine.Callback callback)
-```
-
-The parameters are described below:
-| Parameter | Type | Description |
-| --- | --- | --- |
-| userIdList | List<String> | The target user IDs. |
-| callMediaType | TUICallDefine.MediaType | The call type, which can be video or audio. |
-| params | TUICallDefine.CallParams | An additional parameter. such as roomID, call timeout, offline push info,etc |
-
-### calls
-
-Initiate a one-to-one or multi-person call.
-
-【kotlin】
-``` java
- fun calls(
-     userIdList: List<String?>?, mediaType: TUICallDefine.MediaType?,
-     params: TUICallDefine.CallParams?, callback: TUICommonDefine.Callback?
-)
-```
-
-【Java】
-``` java
- void calls(List<String> userIdList, TUICallDefine.MediaType mediaType,
-            TUICallDefine.CallParams params, TUICommonDefine.Callback callback)
-```
-
-The parameters are described below:
-| Parameter | Type | Description |
-| --- | --- | --- |
-| userIdList | List<String> | The target user IDs. |
-| callMediaType | TUICallDefine.MediaType | The call type, which can be video or audio. |
-| params | TUICallDefine.CallParams | An additional parameter. such as roomID, call timeout, offline push info,etc |
-
-### join
-
-Proactively join a call.
-
-【Kotlin】
-``` java
- fun join(callId: String?, callback: TUICommonDefine.Callback?)
-```
-
-【Java】
-``` java
-void join(String callId, TUICommonDefine.Callback callback)
-```
-
-The parameters are described below:
-| Parameter | Type | Description |
-| --- | --- | --- |
-| callId | String | Unique ID for this call |
-
-### setCallingBell
-
-This API is used to set the ringtone. `filePath` must be an accessible local file URL.
-
-The ringtone set is associated with the device and does not change with user.
-
-To reset the ringtone, pass in an empty string for `filePath`.
-
-【Kotlin】
-``` java
-fun setCallingBell(filePath: String?)
-```
-
-【Java】
-``` java
-void setCallingBell(String filePath);
-```
-
-### enableMuteMode
-
-This API is used to set whether to play the music when user received a call.
-
-【Kotlin】
-``` java
-fun enableMuteMode(enable: Boolean)
-```
-
-【Java】
-``` java
-void enableMuteMode(boolean enable);
-```
-
-### enableFloatWindow
-
-This API is used to set whether to enable floating windows.
-
-The default value is `false`, and the floating window button in the top left corner of the call view is hidden. If it is set to `true`, the button will become visible.
-
-【Kotlin】
-``` java
-fun enableFloatWindow(enable: Boolean)
-```
-
-【Java】
-``` java
-void enableFloatWindow(boolean enable);
-```
-
-### enableIncomingBanner
-
-The API is used to set whether show incoming banner when user received a new call invitation.
-
-The default value is `false`, The callee will pop up a full-screen call view by default when receiving the invitation. If it is set to `true`, the callee will display a banner first.
-``` java
-fun enableIncomingBanner(enable: Boolean)
-```
-
-## Deprecated Interface
-
-### call
-
-This API is used to make a (one-to-one) call. **Note:  it is recommended to use the calls API.**
-
-【Kotlin】
-``` java
-fun call(userId: String, callMediaType: TUICallDefine.MediaType)
-```
-
-【Java】
-``` java
- void call(String userId, TUICallDefine.MediaType callMediaType)
-```
-
-The parameters are described below:
-| Parameter | Type | Description |
-| --- | --- | --- |
-| userId | String | The target user ID. |
-| callMediaType | TUICallDefine.MediaType | The call type, which can be video or audio. |
-
-### call
-
-This API is used to make a (one-to-one) call, Support for custom room ID, call timeout, offline push content, etc. **Note:  it is recommended to use the calls API.**
-
-【Kotlin】
-``` java
-fun call(
-    userId: String, callMediaType: TUICallDefine.MediaType,
-    params: CallParams?, callback: TUICommonDefine.Callback?
-)
-```
-
-【Java】
-``` java
- void call(String userId, TUICallDefine.MediaType callMediaType,
-           TUICallDefine.CallParams params, TUICommonDefine.Callback callback)
-```
-
-The parameters are described below:
-| Parameter | Type | Description |
-| --- | --- | --- |
-| userId | String | The target user ID. |
-| callMediaType | TUICallDefine.MediaType | The call type, which can be video or audio. |
-| params | TUICallDefine.CallParams | Call extension parameters, such as roomID, call timeout, offline push info,etc |
-
-### groupCall
-
-This API is used to make a group call. **Note:  it is recommended to use the calls API.**
-
-> **Note:**
->
-
-> Before making a group call, you need to create an Chat group first.
->
-
-> For details about how to create a group, see [Chat Group Management](https://www.tencentcloud.com/zh/document/product/1047/48466#.E5.88.9B.E5.BB.BA.E7.BE.A4.E7.BB.84), or you can use [Chat UIKit](https://www.tencentcloud.com/zh/document/product/1047/60520) to integrate chat, call and other scenarios.
->
-
-【Kotlin】
-``` java
-fun groupCall(groupId: String, userIdList: List<String?>?, callMediaType: TUICallDefine.MediaType)
-```
-
-【Java】
-``` java
-void groupCall(String groupId, List<String> userIdList, TUICallDefine.MediaType callMediaType);
-```
-
-The parameters are described below:
-| Parameter | Type | Description |
-| --- | --- | --- |
-| groupId | String | The group ID. |
-| userIdList | List | The target user IDs. |
-| callMediaType | TUICallDefine.MediaType | The call type, which can be video or audio. |
-
-### groupCall
-
-This API is used to make a group call, Support for custom room ID, call timeout, offline push content, etc. **Note:  it is recommended to use the calls API.**
-
-> **Note:**
->
-
-> Before making a group call, you need to create an Chat group first.
->
-
-> For details about how to create a group, see [Chat Group Management](https://www.tencentcloud.com/zh/document/product/1047/48466#.E5.88.9B.E5.BB.BA.E7.BE.A4.E7.BB.84), or you can use [Chat UIKit](https://www.tencentcloud.com/zh/document/product/1047/60520) to integrate chat, call and other scenarios.
->
-
-【Kotlin】
-``` java
-fun groupCall(
-    groupId: String, userIdList: List<String?>?,
-    callMediaType: TUICallDefine.MediaType, params: CallParams?,
-    callback: TUICommonDefine.Callback?
-)
-```
-
-【Java】
-``` java
-void groupCall(String groupId, List<String> userIdList, TUICallDefine.MediaType callMediaType,
-               TUICallDefine.CallParams params, TUICommonDefine.Callback callback);
-```
-
-The parameters are described below:
-| Parameter | Type | Description |
-| --- | --- | --- |
-| groupId | String | The group ID. |
-| userIdList | List | The target user IDs. |
-| callMediaType | TUICallDefine.MediaType | The call type, which can be video or audio. |
-| params | TUICallDefine.CallParams | Call extension parameters, such as roomID, call timeout, offline push info,etc |
-
-### joinInGroupCall
-
-This API is used to join a group call. **Note:  it is recommended to use the join API.**
-
-> **Note:**
->
-
-> Before joining a group call, you need to create or join an Chat group in advance, and there are already users in the group who are in the call.
->
-
-> For details about how to create a group, see [Chat Group Management](https://www.tencentcloud.com/zh/document/product/1047/48466#.E5.88.9B.E5.BB.BA.E7.BE.A4.E7.BB.84), or you can use [Chat UIKit](https://www.tencentcloud.com/zh/document/product/1047/60520) to integrate chat, call and other scenarios.
->
-
-【Kotlin】
-``` java
-fun joinInGroupCall(roomId: RoomId?, groupId: String?, callMediaType: TUICallDefine.MediaType?)
-```
-
-【Java】
-``` java
-void joinInGroupCall(TUICommonDefine.RoomId roomId, String groupId, TUICallDefine.MediaType callMediaType);
-```
-
-The parameters are described below:
-| Parameter | Type | Description |
-| --- | --- | --- |
-| roomId | TUICommonDefine.RoomId | The room ID. |
-| groupId | String | The group ID. |
-| callMediaType | TUICallDefine.MediaType | The call type, which can be video or audio. |