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 | Description |
Log in. | |
Sign out. | |
Set the user nickname and profile photo. | |
Start a call. | |
Join the call. | |
Set whether to turn on the mute mode. | |
Set whether to enable floating windows. | |
Enable/Disable Call Banner. |
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.
UserSig is obtained by encrypting information such as sdkAppId and userId using the SDKSecretKey(Signature calculation method). It serves as a ticket for authentication, enabling Tencent Cloud to determine if the current user is authorized to use TRTC services. |
return value | Contains errorCode and errorMessage information: When the errorCode is "0", it means the call is successful; When errorCode is not "0", it means the call failed; see errorMessage for the reason of failure. |
Future<void> logout()
Future<TUIResult> setSelfInfo(String nickname, String avatar)
Parameter | Type | Description |
nickName | String | The nick name. |
avatar | String | The profile photo. |
return value | Contains errorCode and errorMessage information: When the errorCode is "0", it means the call is successful; When errorCode is not "0", it means the call failed; see errorMessage for the reason of failure. |
Future<TUIResult> calls(List<String> userIdList, CallMediaType mediaType, CallParams params)
Parameter | Type | Description |
userIdList | List<String> | The target user IDs. |
callMediaType | The call type, which can be video or audio. | |
params | Optional Extended call parameters, such as room number, call invitation timeout, offline push of custom content, etc. | |
return value | Contains errorCode and errorMessage information: When the errorCode is "0", it means the call is successful; When errorCode is not "0", it means the call failed; see errorMessage for the reason of failure. |
Future<void> join(String callId)
Parameter | Type | Description |
callId | String | Unique ID for this call. |
Future<void> enableMuteMode(bool enable)
Parameter | Type | Description |
enable | bool | true means enable mute mode, false means disable mute mode. |
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.Future<void> enableFloatWindow(bool enable)
Parameter | Type | Description |
enable | bool | true means enable the floating window feature, false means disable the floating window feature. |
Future<void> enableIncomingBanner(bool enable)
Parameter | Type | Description |
enable | bool | true means enable the call banner feature, false means disable the call banner feature. |
フィードバック