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 |
Login | |
Log out | |
Sets the alias and profile photo. | |
Makes a one-to-one call. | |
Makes a group call. | |
Joins a group call. | |
Sets whether to turn on the mute mode. | |
Sets whether to enable floating windows. | |
Custom ringtone. |
Future<TUIResult> login(int sdkAppId, String userId, String userSig);
Parameter | Type | Description |
sdkAppId | int | You can view SDKAppID in Application Management of the IM console. |
userId | String | The ID of the current user, which is a string that can contain only letters (a-z and A-Z), digits (0-9), hyphens (-), and underscores (_). |
userSig | String | |
return value | Contains code and message information: If code is empty (""), the call is successful. If code is not empty ("") , the call fails. See message for the failure reason. |
Future<void> logout()
Future<TUIResult> setSelfInfo(String nickname, String avatar)
Parameter | Type | Description |
nickname | String | The alias. |
avatar | String | The profile photo. |
return value | Contains code and message information: If code is empty (""), the call is successful. If code is not empty ("") , the call fails. See message for the failure reason. |
Future<void> call(String userId, TUICallMediaType callMediaType, [TUICallParams? params])
Parameter | Type | Description |
userId | String | The target user ID. |
callMediaType | The call type, which can be video or audio. | |
params | Call extension parameters, such as roomID, call timeout, offline push info,etc |
Future<void> groupCall(String groupId, List<String> userIdList, TUICallMediaType callMediaType, [TUICallParams? params])
Parameter | Type | Description |
groupId | String | The group ID. |
userIdList | List<String> | The target user IDs. |
callMediaType | The call type, which can be video or audio. | |
params | Call extension parameters, such as roomID, call timeout, offline push info,etc |
Future<void> joinInGroupCall(TUIRoomId roomId, String groupId, TUICallMediaType callMediaType)
Parameter | Type | Description |
roomId | The room ID. | |
groupId | String | The group ID. |
callMediaType | The call type, which can be video or audio. |
Future<void> enableMuteMode(bool enable)
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)
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. |
Was this page helpful?