@tencent-rtc/mcp 1.3.8 → 1.4.0

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

@@ -0,0 +1,410 @@
+## 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.
+
+## API overview
+| API | Description |
+| --- | --- |
+| login | Log in |
+| logout | Sign out |
+| setSelfInfo | Sets the user nickname and profile photo. |
+| calls | Start a call. |
+| join | Join the call. |
+| enableMuteMode | Sets whether to turn on the mute mode. |
+| enableFloatWindow | Sets whether to enable floating windows. |
+| setCallingBell | Custom ringtone. |
+| enableVirtualBackground | Turn On/Off the Virtual Background feature |
+
+## Details
+
+### login
+``` cpp
+Future<TUIResult> login(int sdkAppId, String userId, String userSig)
+```
+| Parameter | Type | Description |
+| --- | --- | --- |
+| sdkAppId | int | User SDKAppID |
+| userId | String | User ID, a string type, can only include English letters (a-z and A-Z), numbers (0-9), hyphens (-), and underscores (_). |
+| userSig | String | User Signature.<br>UserSig is obtained by encrypting information such as sdkAppId and userId using the SDKSecretKey([Signature calculation method](https://www.tencentcloud.com/document/product/647/35166)). It serves as a ticket for authentication, enabling Tencent Cloud to determine if the current user is authorized to use TRTC services. |
+| return value | TUIResult | Contains code and message information: code is empty ("") means the call is successful; code is not empty ("") means the call failed, see message for the reason of failure |
+
+### logout
+``` cpp
+Future<void> logout()
+```
+
+### 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.
+``` cpp
+Future<TUIResult> setSelfInfo(String nickname, String avatar)
+```
+| Parameter | Type | Description |
+| --- | --- | --- |
+| nickName | String | The nick name. |
+| avatar | String | The profile photo. |
+| return value | TUIResult | Contains code and message information: code is empty ("") means the call is successful; code is not empty ("") means the call failed, see message for the reason of failure |
+
+### calls
+
+Initiate a call. **Supported by v2.9+.**
+``` java
+Future<TUIResult> calls(List<String> userIdList, TUICallMediaType mediaType, TUICallParams params)
+```
+| Parameter | Type | Description |
+| --- | --- | --- |
+| userIdList | List<String> | The target user IDs. |
+| callMediaType | TUICallMediaType | The call type, which can be video or audio. |
+| params | TUICallParams | **Optional **Extended call parameters, such as room number, call invitation timeout, offline push of custom content, etc. |
+
+### join
+
+Actively join the call. **Supported by v2.9+.**
+``` java
+Future<void> join(String callId)
+```
+| Parameter | Type | Description |
+| --- | --- | --- |
+| callId | String | Unique ID for this call. |
+
+### enableMuteMode
+
+This API is used to set whether to turn on the mute mode.
+``` javascript
+Future<void> enableMuteMode(bool enable)
+```
+| Parameter | Type | Description |
+| --- | --- | --- |
+| enable | bool | Turn on and off the mute; true means to turn on the mute |
+
+### 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.
+``` javascript
+Future<void> enableFloatWindow(bool enable)
+```
+| Parameter | Type | Description |
+| --- | --- | --- |
+| enable | bool | 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. |
+
+### setCallingBell
+
+Custom ringtone.
+``` javascript
+Future<void> setCallingBell(String assetName)
+```
+| Parameter | Type | Description |
+| --- | --- | --- |
+| assetName | String | The path of the ringtone. The ringtone file needs to be added to the assets resource of the main project. |
+
+### enableVirtualBackground
+
+Turn On/Off the Virtual Background feature. After enabling the Virtual Background feature, you can display the Blurry Background feature button on the UI. Clicking the button will directly enable the Blurry Background feature.
+``` javascript
+Future<void> enableVirtualBackground(bool enable)
+```
+| Parameter | Type | Meaning |
+| --- | --- | --- |
+| enable | bool | Turn on, turn off mute; true means mute is on |
+
+## Deprecated interfaces
+
+### call
+
+This API is used to make a (one-to-one) call.
+
+> **Note：**
+>
+
+> This interface has been deprecated in v2.9+. It is recommended to use the calls interface instead.
+>
+
+``` cpp
+Future<void> call(String userId, TUICallMediaType callMediaType, [TUICallParams? params])
+```
+
+The parameters are described below:
+| Parameter | Type | Description |
+| --- | --- | --- |
+| userId | String | The target user ID. |
+| callMediaType | TUICallMediaType | `The call type, which can be video or audio.` |
+
+### groupCall
+
+This API is used to make a group call.
+
+> **Note：**
+>
+
+> This interface has been deprecated in v2.9+. It is recommended to use the calls interface instead.
+>
+
+``` javascript
+Future<void> groupCall(String groupId, List<String> userIdList, TUICallMediaType callMediaType,[TUICallParams? params])
+```
+
+The parameters are described below:
+| Parameter | Type | Description |
+| --- | --- | --- |
+| groupId | String | The group ID. |
+| userIdList | List<String> | The target user IDs. |
+| callMediaType | TUICallMediaType | `The call type, which can be video or audio.` |
+
+### joinInGroupCall
+
+This API is used to join a group call.Before making a group call, you need to create an IM group first.
+
+> **Note：**
+>
+
+> This interface has been deprecated in v2.9+. It is recommended to use the join interface instead.
+>
+
+``` javascript
+Future<void> joinInGroupCall(TUIRoomId roomId, String groupId, TUICallMediaType callMediaType)
+```
+| Parameter | Type | Description |
+| --- | --- | --- |
+| roomId | TUIRoomID | The room ID. |
+| groupId | String | The group ID. |
+| callMediaType | TUICallMediaType | `The call type, which can be video or audio.` |
+
+## Common structures
+
+### TUIResult
+
+The return value of calling the API.
+| Value | Type | Description |
+| --- | --- | --- |
+| code | String | If the code is empty "", it means the call succeeded, if the code is not empty "", it means the call failed. |
+| message | String? | Error message |
+
+### TUIRoomId
+
+Room ID for audio and video in a call.
+
+**Note：**
+
+(1) `intRoomId` and `strRoomId` are mutually exclusive. If you choose to use `strRoomId`, `intRoomId` needs to be filled in as 0. If both are filled in, the SDK will prioritize `intRoomId`.
+
+(2) Do not mix `intRoomId` and `strRoomId` because they are not interchangeable. For example, the number 123 and the string "123" represent two completely different rooms.
+| Value | Type | Description |
+| --- | --- | --- |
+| intRoomId | int | Numeric room ID. |
+| strRoomId | String | String room number. |
+
+### VideoRenderParams
+
+Video render parameters.
+| Value | Type | Description |
+| --- | --- | --- |
+| fillMode | FillMode | Video image fill mode |
+| rotation | Rotation | Video image rotation direction |
+
+### VideoEncoderParams
+
+Video encoding parameters.
+| Value | Type | Description |
+| --- | --- | --- |
+| resolution | Resolution | Video resolution |
+| resolutionMode | ResolutionMode | Video aspect ratio mode |
+
+### TUICallParams
+
+Call params.
+| Value | Type | Description |
+| --- | --- | --- |
+| roomId | TUIRoomId | Room Id. |
+| offlinePushInfo | TUIOfflinePushInfo | Offline push vendor configuration information. |
+| timeout | String | Call timeout period, default: 30s, unit: seconds. |
+| userData | String | An additional parameter. |
+| chatGroupId | String | Group ID. |
+
+### TUIOfflinePushInfo
+
+Offline push vendor configuration information，please refer to:Offline call push.
+| Value | Type | Description |
+| --- | --- | --- |
+| title | String | offlinepush notification title |
+| desc | String | offlinepush notification description |
+| ignoreIOSBadge | bool | Ignore badge count for offline push (only for iOS), if set to true, the message will not increase the unread count of the app icon on the iOS receiver's side. |
+| iOSSound | String | Offline push sound setting (only for iOS). When<br>sound = IOS_OFFLINE_PUSH_NO_SOUND<br>, there will be no sound played when the message is received. When<br>sound = IOS_OFFLINE_PUSH_DEFAULT_SOUND<br>, the system sound will be played when the message is received. If you want to customize the iOSSound, you need to link the audio file into the Xcode project first, and then set the audio file name (with extension) to the iOSSound. |
+| androidSound | String | Offline push sound setting (only for Android, supported by IMSDK 6.1 and above). Only Huawei and Google phones support setting sound prompts. For Xiaomi phones, please refer to:<br>Xiaomi custom ringtones<br>. In addition, for Google phones, in order to set sound prompts for FCM push on Android 8.0 and above systems, you must call<br>setAndroidFCMChannelID<br>to set the channelID for it to take effect. |
+| androidOPPOChannelID | String | Set the channel ID for OPPO phones with Android 8.0 and above systems. |
+| androidVIVOClassification | int | Classification of VIVO push messages (deprecated interface, VIVO push service will optimize message classification rules on April 3, 2023. It is recommended to use setAndroidVIVOCategory to set the message category). 0: Operational messages, 1: System messages. The default value is 1. |
+| androidXiaoMiChannelID | String | Set the channel ID for Xiaomi phones with Android 8.0 and above systems. |
+| androidFCMChannelID | String | Set the channel ID for google phones with Android 8.0 and above systems. |
+| androidHuaWeiCategory | String | Classification of Huawei push messages, please refer to:<br>[Huawei message classification standard.](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835) |
+| isDisablePush | bool | Whether to turn off push notifications (default is on). |
+| iOSPushType | TUICallIOSOfflinePushType | iOS offline push type，default is APNs |
+
+### TUICallRecords
+
+Call recording information.
+| Value | Type | Description |
+| --- | --- | --- |
+| callId | String | Call recording ID. |
+| inviter | String | Inviter ID. |
+| inviteList | List<String> | List of invited user IDs. |
+| scene | TUICallScene | Call scenario. |
+| mediaType | TUICallMediaType | Media type. |
+| groupId | String | Group ID. |
+| role | TUICallRole | Role. |
+| result | TUICallResultType | Call result type. |
+| beginTime | int | Start time. |
+| totalTime | int | Total time. |
+
+### TUICallRecentCallsFilter
+
+Call recording filtering conditions.
+| Value | Type | Description |
+| --- | --- | --- |
+| begin | double | Start time. |
+| end | double | End time. |
+| resultType | TUICallResultType | Call result type. |
+
+### CallObserverExtraInfo
+
+Callback extended information.
+| Type | Type | Description |
+| --- | --- | --- |
+| roomId | TUIRoomId | room ID |
+| role | TUICallRole | Call role |
+| userData | String | Custom extended field when initiating a call. For details, see TUICallParams. |
+| chatGroupId | String | Group ID |
+
+## **enum definition**
+
+### TUICallMediaType
+
+Call media type.
+| Type | Description |
+| --- | --- |
+| none | Unknown |
+| audio | Audio call |
+| video | Video call |
+
+### TUICallRole
+
+Call role.
+| Type | Description |
+| --- | --- |
+| none | Unknown |
+| caller | Caller（inviter） |
+| called | Callee（invitee） |
+
+### TUICallStatus
+
+Call status.
+| Type | Description |
+| --- | --- |
+| none | Unknown |
+| waiting | The call is currently waiting |
+| accept | The call has been accepted |
+
+### TUICallScene
+
+Call scene.
+| Type | Description |
+| --- | --- |
+| groupCall | Group call |
+| singleCall | one to one call |
+
+### TUINetworkQuality
+
+Network quality.
+| Type | Description |
+| --- | --- |
+| unknown | Unknown |
+| excellent | Excellent |
+| good | Good |
+| poor | Poor |
+| bad | Bad |
+| vBad | Very bad |
+| down | Down |
+
+### FillMode
+
+If the aspect ratio of the video display area is not equal to that of the video image, you need to specify the fill mode:
+| Type | Description |
+| --- | --- |
+| fill | Fill mode: the video image will be centered and scaled to fill the entire display area, where parts that exceed the area will be cropped. The displayed image may be incomplete in this mode. |
+| fit | Fit mode: the video image will be scaled based on its long side to fit the display area, where the short side will be filled with black bars. The displayed image is complete in this mode, but there may be black bars. |
+
+### Rotation
+
+We provides rotation angle setting APIs for local and remote images. The following rotation angles are all clockwise.
+| Type | Description |
+| --- | --- |
+| rotation_0 | No rotation |
+| rotation_90 | Clockwise rotation by 90 degrees |
+| rotation_180 | Clockwise rotation by 180 degrees |
+| rotation_270 | Clockwise rotation by 270 degrees |
+
+### ResolutionMode
+
+Video aspect ratio mode.
+| Type | Description |
+| --- | --- |
+| landscape | Landscape resolution, such as Resolution.Resolution_640_360 + ResolutionMode.Landscape = 640 × 360. |
+| portrait | Portrait resolution, such as Resolution.Resolution_640_360 + ResolutionMode.Portrait = 360 × 640. |
+
+### Resolution
+
+Video resolution.
+| Type | Description |
+| --- | --- |
+| resolution_640_360 | Aspect ratio: 16:9；resolution: 640x360；recommended bitrate: 500kbps |
+| resolution_960_540 | Aspect ratio: 16:9；resolution: 960x540；recommended bitrate: 850kbps |
+| resolution_1280_720 | Aspect ratio: 16:9；resolution: 1280x720；recommended bitrate: 1200kbps |
+| resolution_1920_1080 | Aspect ratio: 16:9；resolution: 1920x1080；recommended bitrate: 2000kbps |
+
+### TUICallIOSOfflinePushType
+
+iOS offline push type.
+| Type | Description |
+| --- | --- |
+| APNs | APNs |
+| VoIP | VoIP |
+
+### TUICamera
+
+Camera type.
+| Type | Description |
+| --- | --- |
+| front | Front camera. |
+| back | Rear camera. |
+
+### TUIAudioPlaybackDevice
+
+Audio playback device.
+| Type | Description |
+| --- | --- |
+| speakerphone | Speaker |
+| earpiece | Earpiece |
+
+### TUICallResultType
+
+Call recording type.
+| Type | Description |
+| --- | --- |
+| unknown | Unknown |
+| missed | Missed |
+| incoming | Incoming call |
+| outgoing | Outgoing Call |
+
+### CallEndReason
+
+Call end reason.
+| Type | Description |
+| --- | --- |
+| unknown | Unknown |
+| hangup | Hang up |
+| reject | Deny |
+| noResponse | No response |
+| offline | Offline |
+| lineBusy | Busy Line |
+| canceled | Cancel call |
+| otherDeviceAccepted | Other device answers |
+| otherDeviceReject | Other device denies |
+| endByServer | Backend ends |

package/resource/doc/{tuicallkit → callkit/preset}/flutter/integration.md

@@ -1,18 +1,7 @@
 This article will guide you through the process of integrating the TUICallKit component quickly. By following this documentation, you can complete the access work in just 10 minutes and ultimately obtain an application with a complete user interface as well as audio and video calling features.
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >Video Call</td>
-
-<td rowspan="1" colSpan="1" >Group call</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182394/1390039d18d011ef9ff4525400f65c2a.png)</td>
-
-<td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182394/4cd1634b18ce11efb8185254005ac0ca.png)</td>
-</tr>
-</table>
-
+| Video Call | Group call |
+| --- | --- |
+|  |  |
 
 ## Environment Preparations
 
@@ -20,7 +9,7 @@ Flutter 3.0 or higher version.
 
 ## Step 1. Activate the service
 
-Before using the audio and video services provided by Tencent Cloud, you need to go to the console to activate the audio and video services for your application, and obtain `SDKAppID, SDKSecretKey`. They will be used in [Step 5](https://write.woa.com/document/113558560409751552). For specific steps, please refer to [activate the Service.](https://write.woa.com/document/140196392040579072)
+Before using the audio and video services provided by Tencent Cloud, you need to go to the console to activate the audio and video services for your application, and obtain `SDKAppID, SDKSecretKey`. They will be used in Step 5. For specific steps, please refer to activate the Service.
 
 ## Step 2. Import the component
 
@@ -31,8 +20,6 @@ flutter pub add tencent_calls_uikit
 
 ## Step 3. Configure the project
 
-
-
 【Android】
 1. If you need to compile and run on the Android platform, since the SDK uses Java's reflection feature internally, certain classes in the SDK must be added to the non-aliasing list.
 
@@ -40,13 +27,13 @@ flutter pub add tencent_calls_uikit
 
 ``` java
   android {
-    ......    
-    buildTypes {  
-        release {  
+    ......
+    buildTypes {
+        release {
             ......
-            minifyEnabled true  
-            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'  
-        } 
+            minifyEnabled true
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
     }
 }
 ```
@@ -58,12 +45,12 @@ flutter pub add tencent_calls_uikit
 2. Configure to enable Multidex support in the `android/app/build.gradle` file of your project.
 
 ``` java
-  android {  
+  android {
     ......
     defaultConfig {
       ......
       multiDexEnabled true
-    } 
+    }
 }
 ```
 
@@ -84,12 +71,12 @@ Authorization Operation Method: In your iOS project's `Info.plist`, under the fi
 
    ``` java
    import 'package:tencent_calls_uikit/tencent_calls_uikit.dart';
-   
+
     ......
-   
+
    class XXX extends StatelessWidget {
      const XXX({super.key});
-   
+
     @override
      Widget build(BuildContext context) {
        return MaterialApp(
@@ -102,7 +89,7 @@ Authorization Operation Method: In your iOS project's `Info.plist`, under the fi
 
 ## Step 5: Log in to the TUICallKit Component
 
-Use the [login](https://write.woa.com/document/114033067004104704) interface to complete the log-in. For specific usage, refer to the following code:
+Use the login interface to complete the log-in. For specific usage, refer to the following code:
 ``` java
 import 'package:tencent_calls_uikit/tencent_calls_uikit.dart';
 import 'package:tencent_calls_uikit/debug/generate_test_user_sig.dart';
@@ -122,55 +109,18 @@ void login() async {
     }
 }
 ```
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >Parameter</td>
-
-<td rowspan="1" colSpan="1" >Type</td>
-
-<td rowspan="1" colSpan="1" >Description</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >userID</td>
-
-<td rowspan="1" colSpan="1" >String</td>
-
-<td rowspan="1" colSpan="1" >Customers define their own User ID based on their business. You can only include letters (a-z, A-Z), digits (0-9), underscores, and hyphens.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >sdkAppID</td>
-
-<td rowspan="1" colSpan="1" >int</td>
-
-<td rowspan="1" colSpan="1" >The unique identifier of the audio and video application created in the [Tencent RTC Console](https://console.trtc.io/).</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >secretKey</td>
-
-<td rowspan="1" colSpan="1" >String</td>
-
-<td rowspan="1" colSpan="1" >SDKSecretKey for the audio and video application created in [Tencent RTC Console](https://console.trtc.io/).</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >userSig</td>
-
-<td rowspan="1" colSpan="1" >String</td>
-
-<td rowspan="1" colSpan="1" >A security protection signature used for user log in authentication to confirm the user's identity and prevent malicious attackers from stealing your cloud service usage rights.</td>
-</tr>
-</table>
-
+| Parameter | Type | Description |
+| --- | --- | --- |
+| userID | String | Customers define their own User ID based on their business. You can only include letters (a-z, A-Z), digits (0-9), underscores, and hyphens. |
+| sdkAppID | int | The unique identifier of the audio and video application created in the [Tencent RTC Console](https://console.trtc.io/). |
+| secretKey | String | SDKSecretKey for the audio and video application created in [Tencent RTC Console](https://console.trtc.io/). |
+| userSig | String | A security protection signature used for user log in authentication to confirm the user's identity and prevent malicious attackers from stealing your cloud service usage rights. |
 
 > **Note:**
-> 
+>
 > - **Development Environment**: If you are in the local development and debugging stage, you can use the local `GenerateTestUserSig.genTestSig` function to generate userSig. In this method, the SDKSecretKey is vulnerable to decompilation and reverse engineering, and once your key is leaked, attackers can steal your Tencent Cloud traffic.
 > - **Production Environment**: If your project is going to be launched, please adopt the method of [Server-side Generation of UserSig](https://www.tencentcloud.com/document/product/647/35166?lang=en&pg=#how-do-i-calculate-.60usersig.60-in-a-production-environment.3F).
 
-
 ## Step 6. Make your first phone call
 
 After both the caller and callee have successfully signed in, the caller can initiate an audio or video call by calling the TUICallKit's call method and specifying the call type and the callee's userId. At this point, the callee will receive an incoming call invitation.
@@ -184,42 +134,30 @@ void call() {
     TUICallKit.instance.calls(userIdList, TUICallMediaType.audio);
 }
 ```
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182394/9a7977f7ec0f11ee896d5254005cb287.png)</td>
-
-<td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182394/96d0cc00ec0f11eeb5dc525400aa857d.png)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >Caller</td>
-
-<td rowspan="1" colSpan="1" >Callee</td>
-</tr>
-</table>
-
+|  |  |
+| --- | --- |
+| Caller | Callee |
 
 ## Additional Features
-- [Customize Interface](https://write.woa.com/document/119356800679190528)
-
-- [Offline Push](https://write.woa.com/document/142911918280658944)
+- Customize Interface
 
-- [Group Call](https://write.woa.com/document/140196498678116352)
+- Offline Push
 
-- [Floating Window](https://write.woa.com/document/140196506800930816)
+- Group Call
 
-- [Custom Ringtone](https://write.woa.com/document/140196510742061056)
+- Floating Window
 
-- [Call Status Monitoring](https://write.woa.com/document/140196527978475520)
+- Custom Ringtone
 
-- [Cloud Recording](https://write.woa.com/document/95824491274473472)
+- Call Status Monitoring
 
-- [Beauty Effects](https://write.woa.com/document/133965491956793344)
+- Cloud Recording
 
+- Beauty Effects
 
 ## FAQs
 
-If you encounter any issues during integration and use, please refer to [Frequently Asked Questions](https://write.woa.com/document/121896145600688128).
+If you encounter any issues during integration and use, please refer to Frequently Asked Questions.
 
 ## Suggestions and Feedback