TUICallKit

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
userSig
String
用户签名 userSig(计算方法详见 生成 UserSig
返回值
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
params
通话扩展参数,例如:房间号、通话邀请超时时间,离线推送自定义内容等

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
params
通话扩展参数,例如:房间号、通话邀请超时时间,离线推送自定义内容等

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)

enableFloatWindow

开启/关闭悬浮窗功能,设置为false后,通话界面左上角的悬浮窗按钮会隐藏。
Future<void> enableFloatWindow(bool enable)

setCallingBell

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