含 UI 集成方案

有奖征文|投稿上云技术实践,赢取价值5000元大奖> HOT

TUICallKit API 简介

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

API 概览

API
描述
init
初始化 TUICallKit
call
发起 1v1 通话
groupCall
发起群组通话
设置用户的头像、昵称
destroyed
销毁 TUICallKit

API 详情

init

初始化 TUICallKit。
init()

call

C2C邀请通话,被邀请方会收到的回调,如果当前处于通话中,可以调用该函数以邀请第三方进入通话。
call({
userID:"jane",
type:MEDIA_TYPE.AUDIO
})
参数如下表所示:
参数
类型
含义
userId
String
目标用户的 UserID:"jane"
type
通话的媒体类型,AUDIO:语音通话,VIDEO:视频通话

groupCall

IM群组邀请通话,被邀请方会收到的回调,如果当前处于通话中,可以继续调用该函数继续邀请他人进入通话,同时正在通话的用户会收到的回调。
groupCall({
userIDList:["jane", "mike", "tommy"],
type: MEDIA_TYPE.VIDEO,
groupID: "12345678"
})
参数如下表所示:
参数
类型
含义
userIDList
Array
目标用户的 userId 列表,示例:["jane", "mike", "tommy"]
type
通话的媒体类型,AUDIO:语音通话,VIDEO:视频通话
groupID
String
此次群组通话的群 ID,示例:"12345678"

setSelfInfo

设置用户头像、昵称的接口。
setSelfInfo("昵称", "头像 URL") ;
参数如下表所示:
参数
类型
含义
nickName
String
设置昵称
avatar
String
头像地址

destroyed

销毁 TUICallKit。
destroyed()
目录