@tencent-rtc/mcp 1.3.9 → 1.4.0

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

@@ -0,0 +1,80 @@
+## TUICallKit (UI Included)
+
+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.
+| API | Description |
+| --- | --- |
+| [createInstance](https://www.tencentcloud.com/document/product/647/51011#createInstance) | Create a TUICallKit instance (singleton mode). |
+| [setSelfInfo](https://www.tencentcloud.com/document/product/647/51011#setSelfInfo) | Set the user's profile picture and nickname. |
+| [calls](https://www.tencentcloud.com/document/product/647/51011#calls) | Initiate a one-to-one or multi-person call |
+| [join](https://www.tencentcloud.com/document/product/647/51011#join) | Proactively join a call |
+| [setCallingBell](https://www.tencentcloud.com/document/product/647/51011#setCallingBell) | Set the ringtone. |
+| [enableMuteMode](https://www.tencentcloud.com/document/product/647/51011#enableMuteMode) | Set whether to turn on the mute mode. |
+| [enableFloatWindow](https://www.tencentcloud.com/document/product/647/51011#enableFloatWindow) | Set whether to enable floating windows. |
+| [enableIncomingBanner](https://www.tencentcloud.com/document/product/647/51011#enableIncomingBanner) | Set whether to display incoming banner. |
+
+## TUICallEngine (No UI)
+
+`TUICallEngine` is an audio/video call component that **does not include UI elements**. If `TUICallKit` does not meet your requirements, you can use the APIs of `TUICallEngine` to customize your project.
+| API | Description |
+| --- | --- |
+| [createInstance](https://www.tencentcloud.com/document/product/647/51012#createInstance) | Create a TUICallEngine instance (singleton). |
+| [destroyInstance](https://www.tencentcloud.com/document/product/647/51012#destroyInstance) | Destroy TUICallEngine instance (singleton). |
+| [Init](https://www.tencentcloud.com/document/product/647/51012#Init) | Authenticates the basic audio/video call capabilities. |
+| [addObserver](https://www.tencentcloud.com/document/product/647/51012#addObserver) | Add listener. |
+| [removeObserver](https://www.tencentcloud.com/document/product/647/51012#removeObserver) | Remove listener. |
+| [calls](https://www.tencentcloud.com/document/product/647/51012#calls) | Initiate a one-to-one or multi-person call |
+| [join](https://www.tencentcloud.com/document/product/647/51012#join) | Proactively join a call |
+| [accept](https://www.tencentcloud.com/document/product/647/51012#accept) | Accept call. |
+| [reject](https://www.tencentcloud.com/document/product/647/51012#reject) | Reject call. |
+| [hangup](https://www.tencentcloud.com/document/product/647/51012#hangup) | Hang up call. |
+| [ignore](https://www.tencentcloud.com/document/product/647/51012#hangup) | Ignore call. |
+| [inviteUser](https://www.tencentcloud.com/document/product/647/51012#inviteUser) | Invite users to the current call. |
+| [switchCallMediaType](https://www.tencentcloud.com/document/product/647/51012#switchCallMediaType) | Switch the call media type, such as from video call to audio call. |
+| [startRemoteView](https://www.tencentcloud.com/document/product/647/51012#startRemoteView) | Subscribe to the video stream of a remote user. |
+| [stopRemoteView](https://www.tencentcloud.com/document/product/647/51012#stopRemoteView) | Unsubscribe from the video stream of a remote user. |
+| [openCamera](https://www.tencentcloud.com/document/product/647/51012#openCamera) | Turn on the camera. |
+| [closeCamera](https://www.tencentcloud.com/document/product/647/51012#closeCamera) | Turn off the camera. |
+| [switchCamera](https://www.tencentcloud.com/document/product/647/51012#switchCamera) | Switch camera. |
+| [openMicrophone](https://www.tencentcloud.com/document/product/647/51012#openMicrophone) | Enable microphone. |
+| [closeMicrophone](https://www.tencentcloud.com/document/product/647/51012#closeMicrophone) | Disable the microphone. |
+| [selectAudioPlaybackDevice](https://www.tencentcloud.com/document/product/647/51012#selectAudioPlaybackDevice) | Select the audio playback device (Earpiece/Speakerphone). |
+| [setSelfInfo](https://www.tencentcloud.com/document/product/647/51012#setSelfInfo) | Set the user's profile picture and nickname. |
+| [enableMultiDeviceAbility](https://www.tencentcloud.com/document/product/647/51012#enableMultiDeviceAbility) | Sets whether to enable multi-device login for TUICallEngine (supported by the [Group Call package](https://trtc.io/document/54632?platform=ios&product=call&menulabel=web)). |
+| [setVideoRenderParams](https://www.tencentcloud.com/document/product/647/51012#setVideoRenderParams) | Set the rendering mode of video. |
+| [setVideoEncoderParams](https://www.tencentcloud.com/document/product/647/51012#setVideoEncoderParams) | Set the encoding parameters of video encoder. |
+| [getTRTCCloudInstance](https://www.tencentcloud.com/document/product/647/51012#getTRTCCloudInstance) | Advanced features. |
+| [setBeautyLevel](https://www.tencentcloud.com/document/product/647/51012#setBeautyLevel) | Set beauty level, support turning off default beauty. |
+
+### TUICallObserver
+
+`TUICallObserver` is the callback class of `TUICallEngine`. You can use it to listen for events.
+| API | Description |
+| --- | --- |
+| [onError](https://www.tencentcloud.com/document/product/647/51013#onError) | An error occurred during the call. |
+| [onCallReceived](https://www.tencentcloud.com/document/product/647/51013#onCallReceived) | A call was received. |
+| [onCallCancelled](https://www.tencentcloud.com/document/product/647/51013#onCallCancelled) | The call was canceled. |
+| [onCallBegin](https://www.tencentcloud.com/document/product/647/51013#onCallBegin) | The call was connected. |
+| [onCallEnd](https://www.tencentcloud.com/document/product/647/51013#onCallEnd) | The call ended. |
+| [onCallMediaTypeChanged](https://www.tencentcloud.com/document/product/647/51013#onCallMediaTypeChanged) | The call type changed. |
+| [onUserReject](https://www.tencentcloud.com/document/product/647/51013#onUserReject) | A user declined the call. |
+| [onUserNoResponse](https://www.tencentcloud.com/document/product/647/51013#onUserNoResponse) | A user didn't respond. |
+| [onUserLineBusy](https://www.tencentcloud.com/document/product/647/51013#onUserLineBusy) | A user was busy. |
+| [onUserJoin](https://www.tencentcloud.com/document/product/647/51013#onUserJoin) | A user joined the call. |
+| [onUserLeave](https://www.tencentcloud.com/document/product/647/51013#onUserLeave) | A user left the call. |
+| [onUserVideoAvailable](https://www.tencentcloud.com/document/product/647/51013#onUserVideoAvailable) | Whether a user has a video stream. |
+| [onUserAudioAvailable](https://www.tencentcloud.com/document/product/647/51013#onUserAudioAvailable) | Whether a user has an audio stream. |
+| [onUserVoiceVolumeChanged](https://www.tencentcloud.com/document/product/647/51013#onUserVoiceVolumeChanged) | The volume levels of all users. |
+| [onUserNetworkQualityChanged](https://www.tencentcloud.com/document/product/647/51013#onUserNetworkQualityChanged) | The network quality of all users. |
+| [onKickedOffline](https://www.tencentcloud.com/document/product/647/51013#onKickedOffline) | The current user was kicked offline. |
+| [onUserSigExpired](https://www.tencentcloud.com/document/product/647/51013#onUserSigExpired) | The user sig is expired. |
+
+## Definitions of Key Typ
+| API | Description |
+| --- | --- |
+| TUICallMediaType | Call media type, Enumeration type: Unknown, Video, and Audio. |
+| TUICallRole | Call role, Enumeration type: None, Call, and Called. |
+| TUICallStatus | Call status, Enumeration type: None, Waiting, and Accept. |
+| TUIRoomId | The room ID, which can be a number or string. |
+| TUICallCamera | The camera type. Enumeration type: Front camera and Back camera. |
+| TUIAudioPlaybackDevice | The audio playback device type. Enumeration type: Earpiece and Speakerphone. |
+| TUINetworkQualityInfo | The current network quality. |

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

@@ -1,18 +1,7 @@
 This article will guide you through the quick integration of the TUICallKit component. You will complete several key steps within 10 minutes, ultimately obtaining a video call feature with a complete UI interface.
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >1v1 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/100027164818/b8670a89190311ef957f525400f65c2a.png)</td>
-
-<td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027164818/5866a4f4190311efa1975254005ac0ca.png)</td>
-</tr>
-</table>
-
+| 1v1 Video Call | Group call |
+| --- | --- |
+|  |  |
 
 ## Environment Preparations
 - Xcode 13 or later.
@@ -21,16 +10,15 @@ This article will guide you through the quick integration of the TUICallKit comp
 
 - CocoaPods environment installation, [Click to view](https://guides.cocoapods.org/using/getting-started.html).
 
-- If you experience any issues with access or usage, please consult the [FAQs](https://write.woa.com/document/145196720321933312).
-
+- If you experience any issues with access or usage, please consult the FAQs.
 
 ## Step 1. Activate the service
 
-Refer to [Activate the Service](https://write.woa.com/document/140196392040579072) to obtain `SDKAppID, SDKSecretKey`, which will be used as **Mandatory Parameters in **[Step 4: Log in to the TUICallKit component](https://write.woa.com/document/95734398531444736)**.**
+Refer to Activate the Service to obtain `SDKAppID, SDKSecretKey`, which will be used as **Mandatory Parameters in **Step 4: Log in to the TUICallKit component**.**
 
 ## Step 2. Import the component
 
-Use CocoaPods to import the component. If you encounter any issues, please refer to [Environment Preparation](https://write.woa.com/document/95734398531444736) first. Detailed steps for importing the component are as follows:
+Use CocoaPods to import the component. If you encounter any issues, please refer to Environment Preparation first. Detailed steps for importing the component are as follows:
 1. Please add the dependency `pod 'TUICallKit_Swift'` to your `Podfile`. If you encounter any problems, please refer to the [Example](https://github.com/Tencent-RTC/TUICallKit/blob/main/iOS/Example/Podfile) project.
 
    ``` bash
@@ -38,71 +26,56 @@ Use CocoaPods to import the component. If you encounter any issues, please refer
      ...
      pod 'TUICallKit_Swift/Professional'
    end
-   ```   
+   ```
 
    > **Note:**
-   > 
+   >
 
    > If your project lacks a `Podfile`, you need to `cd` into the `xxxx.xcodeproj` directory in Terminal, and then create a `Podfile` by executing the following command:
-   > 
+   >
    > `pod init`
 
 2. In Terminal, first `cd` into the `Podfile` directory and then run the following command to install components.
 
    ``` bash
    pod install
-   ```   
+   ```
 
    > **Note:**
-   > 
+   >
 
    > If you cannot install the latest version of TUICallKit, you may first delete **Podfile.lock** and **Pods**. Then run the following command to update the local CocoaPods repository list.
-   > 
+   >
    > `pod repo update`
 
    > Then, run the following command to update the Pod version of the component library.
-   > 
+   >
    > `pod update`
 
-3. We suggest you compile and run once. If you encounter any problems, you can refer to our [FAQs](https://write.woa.com/document/145196720321933312). If the problem remains unresolved, you may try running our [Example](https://github.com/Tencent-RTC/TUICallKit/tree/main/iOS/Example) project. If you encounter any issues during integration and use, you are welcome to [provide feedback](https://github.com/Tencent-RTC/TUICallKit/issues) to us.
-
+3. We suggest you compile and run once. If you encounter any problems, you can refer to our FAQs. If the problem remains unresolved, you may try running our [Example](https://github.com/Tencent-RTC/TUICallKit/tree/main/iOS/Example) project. If you encounter any issues during integration and use, you are welcome to [provide feedback](https://github.com/Tencent-RTC/TUICallKit/issues) to us.
 
 ## Step 3: Configure the Project
 
 To use audio and video features, you need to authorize the usage of the camera and microphone. Please set the required permissions according to the actual needs of the project.
 1. In **Xcode**, select **TARGETS** > **Info** > **Custom iOS Target Properties** from the menu.
 
-
-   ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027164818/3a48a98618fc11ef8a48525400762795.png)
-
 2. Click the **+** button to add camera and microphone permissions.
 
 - `Privacy - Camera Usage Description`
 
 - `Privacy - Microphone Usage Description`
 
-
-   ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027164818/3a33284618fc11efa1975254005ac0ca.png)
-
-
-   
-
 ## Step 4: Log in to the `TUICallKit` component
 
-
    Add the following code to your project. It works by calling the relevant interfaces in TUICore to complete the login to TUI Component. This step is very important, only after successfully logging in, you can normally use the features offered by TUICallKit.
 
-
-   
-
-
 【Swift】
 ``` swift
 import TUICore
 import TUICallKit_Swift
 
 func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
-        
+
     let userID = "denny"       // Please replace with your UserId
     let sdkAppID: Int32 = 0    // Please replace with the SDKAppID obtained from the console in the step 1
     let secretKey = "****"     // Please replace with the SecretKey obtained from the console in the step 1
@@ -119,14 +92,13 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau
 }
 ```
 
-
 【Objective-C】
 ``` objectivec
 #import <TUICore/TUILogin.h>
 #import <TUICallKit_Swift/TUICallKit_Swift-Swift.h>
 
 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
-    
+
     NSString *userID = @"denny";     // Please replace with your UserId
     int sdkAppID = 0;                // Please replace with the SDKAppID obtained from the console in the first step
     NSString *secretKey = @"****";   // Please replace with the SecretKey obtained from the console in the first step
@@ -141,67 +113,27 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau
     } fail:^(int code, NSString * _Nullable msg) {
         NSLog(@"login failed, code: %d, error: %@", code, msg);
     }];
-    
+
     return YES;
 }
 ```
 
-<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" >Your own User ID based on your business. It 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" >Int32</td>
-
-<td rowspan="1" colSpan="1" >The unique identifier SDKAppID for the audio and video application created in [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 signature for user login to verify identity and prevent unauthorized access to cloud services.</td>
-</tr>
-</table>
-   
+| Parameter | Type | Description |
+| --- | --- | --- |
+| userID | String | Your own User ID based on your business. It can only include letters (a-z, A-Z), digits (0-9), underscores, and hyphens. |
+| sdkAppID | Int32 | The unique identifier SDKAppID for the audio and video application created in [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 signature for user login to verify identity and prevent unauthorized access to cloud services. |
 
    > **Note:**
-   > 
+   >
 >   - **Development Environment**: During local development and debugging, use the local GenerateTestUserSig.genTestSig function to create a userSig. But be careful, the SDKSecretKey can be decompiled and reverse-engineered. If leaked, it could allow theft of your Tencent Cloud traffic.
->   - **Production Environment**:  For project launch, use the [Server-side Generation of UserSig](https://www.tencentcloud.com/zh/document/product/647/35166#.E6.AD.A3.E5.BC.8F.E8.BF.90.E8.A1.8C.E9.98.B6.E6.AE.B5.E5.A6.82.E4.BD.95.E8.AE.A1.E7.AE.97-usersig.EF.BC.9F) method. 
-
+>   - **Production Environment**:  For project launch, use the [Server-side Generation of UserSig](https://www.tencentcloud.com/zh/document/product/647/35166#.E6.AD.A3.E5.BC.8F.E8.BF.90.E8.A1.8C.E9.98.B6.E6.AE.B5.E5.A6.82.E4.BD.95.E8.AE.A1.E7.AE.97-usersig.EF.BC.9F) method.
 
 ## Step Five: Make your first call
 
 By calling the call function of TUICallKit and specifying the calls type and callee's userId, you can initiate an audio or video call.
 
-
-
-
 【Swift】
 ``` swift
 import TUICallKit_Swift
@@ -215,7 +147,6 @@ TUICallKit.createInstance().calls(userIdList: ["mike"], callMediaType: .audio, p
 }
 ```
 
-
 【Objective-C】
 ``` objectivec
 #import <TUICallKit_Swift/TUICallKit_Swift-Swift.h>
@@ -226,42 +157,30 @@ TUICallKit.createInstance().calls(userIdList: ["mike"], callMediaType: .audio, p
 } fail:^(int code, NSString * _Nullable errMsg) {
 }];
 ```
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027164818/4d737a62190011efa1975254005ac0ca.png)</td>
-
-<td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027164818/5146bd45190011ef87e352540019e87e.png)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >Caller</td>
-
-<td rowspan="1" colSpan="1" >Callee</td>
-</tr>
-</table>
-
+|  |  |
+| --- | --- |
+| Caller | Callee |
 
 ## Additional Features
-- [Setting Nickname, Avatar](https://write.woa.com/document/140283519901868032)
-
-- [Customize Interface](https://write.woa.com/document/95821338112184320)
+- Setting Nickname, Avatar
 
-- [Offline Push](https://write.woa.com/document/95821656031932416)
+- Customize Interface
 
-- [Multiplayer Call](https://write.woa.com/document/140196498678116352)
+- Offline Push
 
-- [Floating Window](https://write.woa.com/document/140196506800930816)
+- Multiplayer Call
 
-- [Custom Ringtone](https://write.woa.com/document/140196518087802880)
+- Floating Window
 
-- [Call Status Monitoring](https://write.woa.com/document/140196527978475520)
+- Custom Ringtone
 
-- [Cloud Recording](https://write.woa.com/document/95824491274473472)
+- Call Status Monitoring
 
+- Cloud Recording
 
 ## FAQs
 
-If you encounter any issues during integration and use, please refer to [Frequently Asked Questions](https://write.woa.com/document/145196720321933312).
+If you encounter any issues during integration and use, please refer to Frequently Asked Questions.
 
 ## Suggestions and Feedback