tencent cloud

Feedback

TUICallKit

Last updated: 2024-05-27 17:41:07

    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
    Creates a TUICallKit instance (singleton mode).
    Sets the alias and profile photo.
    call
    Makes a one-to-one call.
    call
    Makes a one-to-one call, Support for custom room ID, call timeout, offline push content, etc
    groupCall
    Makes a group call.
    groupCall
    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.

    Details

    createInstance

    This API is used to create a TUICallKit singleton.
    Kotlin
    Java
    fun createInstance(context: Context): TUICallKit
    TUICallKit createInstance(Context context)

    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.
    Kotlin
    Java
    fun setSelfInfo(nickname: String?, avatar: String?, callback: TUICommonDefine.Callback?)
    void setSelfInfo(String nickname, String avatar, TUICommonDefine.Callback callback)
    The parameters are described below:
    Parameter
    Type
    Description
    nickname
    String
    The alias.
    avatar
    String
    The profile photo.

    call

    This API is used to make a (one-to-one) call.
    Kotlin
    Java
    fun call(userId: String, callMediaType: TUICallDefine.MediaType)
    void call(String userId, TUICallDefine.MediaType callMediaType)
    The parameters are described below:
    Parameter
    Type
    Description
    userId
    String
    The target user ID.
    callMediaType
    The call type, which can be video or audio.

    call

    This API is used to make a (one-to-one) call, Support for custom room ID, call timeout, offline push content, etc.
    Kotlin
    Java
    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)
    The parameters are described below:
    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

    groupCall

    This API is used to make a group call.
    Notice:
    Before making a group call, you need to create an IM group first.
    Kotlin
    Java
    fun groupCall(groupId: String, userIdList: List<String?>?, callMediaType: TUICallDefine.MediaType)
    void groupCall(String groupId, List<String> userIdList, TUICallDefine.MediaType callMediaType);
    The parameters are described below:
    Parameter
    Type
    Description
    groupId
    String
    The group ID.
    userIdList
    List
    The target user IDs.
    callMediaType
    The call type, which can be video or audio.

    groupCall

    This API is used to make a group call, Support for custom room ID, call timeout, offline push content, etc.
    Notice:
    Before making a group call, you need to create an IM group first.
    Kotlin
    Java
    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);
    The parameters are described below:
    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

    joinInGroupCall

    This API is used to join a group call.
    Notice:
    Before joining a group call, you need to create or join an IM group in advance, and there are already users in the group who are in the call.
    Kotlin
    Java
    fun joinInGroupCall(roomId: RoomId?, groupId: String?, callMediaType: TUICallDefine.MediaType?)
    void joinInGroupCall(TUICommonDefine.RoomId roomId, String groupId, TUICallDefine.MediaType callMediaType);
    The parameters are described below:
    Parameter
    Type
    Description
    roomId
    The room ID.
    groupId
    String
    The group ID.
    callMediaType
    The call type, which can be video or audio.

    setCallingBell

    This API is used to set the ringtone. filePath must be an accessible local file URL.
    The ringtone set is associated with the device and does not change with user.
    To reset the ringtone, pass in an empty string for filePath.
    Kotlin
    Java
    fun setCallingBell(filePath: String?)
    void setCallingBell(String filePath);

    enableMuteMode

    This API is used to set whether to turn on the mute mode.
    Kotlin
    Java
    fun enableMuteMode(enable: Boolean)
    void enableMuteMode(boolean enable);

    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.
    Kotlin
    Java
    fun enableFloatWindow(enable: Boolean)
    void enableFloatWindow(boolean enable);

    enableIncomingBanner

    The API is used to set whether to enable the incoming banner.
    The default value is 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)
    
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support