tencent cloud

文档反馈

TUICallKit

最后更新时间:2024-05-23 16:24:18

    TUICallKit API 简介

    TUICallKit API 是音视频通话组件的含 UI 接口,使用TUICallKit API,您可以通过简单接口快速实现一个类微信的音视频通话场景,更详细的接入步骤,详情请参见 快速接入(TUICallKit)。

    API 概览

    API
    描述
    login
    登录
    logout
    登出
    设置用户的昵称、头像
    call
    发起 1v1 通话
    groupCall
    发起群组通话
    主动加入当前的群组通话中
    开启/关闭静音模式
    开启/关闭悬浮窗功能
    自定义来电铃声
    开启/关闭虚拟背景功能

    API 详情

    login

    登录。
    Future<TUIResult> login(int sdkAppId, String userId, String userSig);
    参数
    类型
    含义
    sdkAppId
    int
    用户 SDKAppID。
    userId
    String
    用户 ID,字符串类型,只允许包含英文字母(a-z 和 A-Z)、数字(0-9)、连词符(-)和下划线(_)。
    userSig
    String
    用户签名 userSig。
    userSig 通过使用 SDKSecretKey 对 sdkAppId、userId 等信息进行加密得到(计算方法详见),它是一个鉴权用的票据,用于腾讯云识别当前用户是否能够使用 TRTC 的服务。
    返回值
    TUIResult
    包含 code 和 message 信息:code 为空 ("") 表示调用成功;code 不为空 ("") 表示调用失败,失败原因见 message。

    logout

    登出。
    Future<void> logout()

    setSelfInfo

    设置用户昵称、头像。用户昵称不能超过500字节,用户头像必须是 URL 格式。
    Future<TUIResult> setSelfInfo(String nickname, String avatar)
    参数
    类型
    含义
    nickName
    String
    目标用户的昵称,非必填
    avatar
    String
    目标用户的头像,非必填
    返回值
    TUIResult
    包含 code 和 message 信息:code 为空 ("") 表示调用成功;code 不为空 ("") 表示调用失败,失败原因见 message

    call

    拨打电话(1v1通话)。
    Future<void> call(String userId, TUICallMediaType callMediaType, [TUICallParams? params])
    参数如下表所示:
    参数
    类型
    含义
    userId
    String
    目标用户的 userID
    callMediaType
    通话的媒体类型,比如:TUICallMediaType.video TUICallMediaType.audio

    groupCall

    发起群组通话,注意:使用群组通话前需要创建IM 群组,如果已经创建,请忽略。
    Future<void> groupCall(String groupId, List<String> userIdList, TUICallMediaType callMediaType, [TUICallParams? params])
    参数
    类型
    含义
    groupId
    String
    此次群组通话的群 ID
    userIdList
    List<String>
    目标用户的userId 列表
    callMediaType
    通话的媒体类型,比如:TUICallMediaType.video TUICallMediaType.audio

    joinInGroupCall

    加入群组中已有的音视频通话。
    Future<void> joinInGroupCall(TUIRoomId roomId, String groupId, TUICallMediaType callMediaType)
    参数
    类型
    含义
    roomId
    TUIRoomID
    此次通话的音视频房间 ID
    groupId
    String
    此次群组通话的群 ID
    callMediaType
    通话的媒体类型,比如:TUICallMediaType.video TUICallMediaType.audio

    enableMuteMode

    开启/关闭静音模式。
    Future<void> enableMuteMode(bool enable)
    参数
    类型
    含义
    enable
    bool
    开启、关闭静音;true 表示开启静音

    enableFloatWindow

    开启/关闭悬浮窗功能,设置为 false 后,通话界面左上角的悬浮窗按钮会隐藏。
    Future<void> enableFloatWindow(bool enable)
    参数
    类型
    含义
    enable
    bool
    开启、关闭悬浮窗功能;true 表示开启浮窗

    setCallingBell

    自定义来电铃声。
    Future<void> setCallingBell(String assetName)
    参数
    类型
    含义
    assetName
    String
    铃声的路径,需要将铃声文件添加至主工程的 assets 资源中。

    enableVirtualBackground

    开启/关闭虚拟背景功能,开启虚拟背景功能后,您可以在 UI 上显示模糊背景的功能按钮,点击按钮可直接启用模糊背景功能。
    Future<void> enableVirtualBackground(bool enable)
    参数
    类型
    含义
    enable
    bool
    开启、关闭静音;true 表示开启静音
    
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持