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 |
Creates a TUICallKit instance (singleton mode). | |
Sets the alias and profile photo. | |
Makes a one-to-one call. | |
Makes a one-to-one call, Support for custom room ID, call timeout, offline push content, etc | |
Makes a group call. | |
Makes a group call, Support for custom room ID, call timeout, offline push content, etc | |
Joins a group call. | |
Sets the ringtone. | |
Sets whether to turn on the mute mode. | |
Sets whether to enable floating windows. | |
Sets whether to enable the incoming banner. |
TUICallKit
singleton.fun createInstance(context: Context): TUICallKit
TUICallKit createInstance(Context context)
fun setSelfInfo(nickname: String?, avatar: String?, callback: TUICommonDefine.Callback?)
void setSelfInfo(String nickname, String avatar, TUICommonDefine.Callback callback)
Parameter | Type | Description |
nickname | String | The alias. |
avatar | String | The profile photo. |
fun call(userId: String, callMediaType: TUICallDefine.MediaType)
void call(String userId, TUICallDefine.MediaType callMediaType)
Parameter | Type | Description |
userId | String | The target user ID. |
callMediaType | The call type, which can be video or audio. |
fun call(userId: String, callMediaType: TUICallDefine.MediaType,params: CallParams?, callback: TUICommonDefine.Callback?)
void call(String userId, TUICallDefine.MediaType callMediaType,TUICallDefine.CallParams params, TUICommonDefine.Callback callback)
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 |
fun groupCall(groupId: String, userIdList: List<String?>?, callMediaType: TUICallDefine.MediaType)
void groupCall(String groupId, List<String> userIdList, TUICallDefine.MediaType callMediaType);
Parameter | Type | Description |
groupId | String | The group ID. |
userIdList | List | The target user IDs. |
callMediaType | The call type, which can be video or audio. |
fun groupCall(groupId: String, userIdList: List<String?>?,callMediaType: TUICallDefine.MediaType, params: CallParams?,callback: TUICommonDefine.Callback?)
void groupCall(String groupId, List<String> userIdList, TUICallDefine.MediaType callMediaType,TUICallDefine.CallParams params, TUICommonDefine.Callback callback);
Parameter | Type | Description |
groupId | String | The group ID. |
userIdList | List | 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 |
fun joinInGroupCall(roomId: RoomId?, groupId: String?, callMediaType: TUICallDefine.MediaType?)
void joinInGroupCall(TUICommonDefine.RoomId roomId, String groupId, TUICallDefine.MediaType callMediaType);
Parameter | Type | Description |
roomId | The room ID. | |
groupId | String | The group ID. |
callMediaType | The call type, which can be video or audio. |
filePath
must be an accessible local file URL.filePath
.fun setCallingBell(filePath: String?)
void setCallingBell(String filePath);
fun enableMuteMode(enable: Boolean)
void enableMuteMode(boolean 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.fun enableFloatWindow(enable: Boolean)
void enableFloatWindow(boolean enable);
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.fun enableIncomingBanner(enable: Boolean)
Was this page helpful?