API 概览

最近更新时间:2024-08-02 15:06:31

我的收藏

TUICallKit (含 UI 接口)

TUICallKit API 是音视频通话组件的含 UI 接口,使用 TUICallKit API,您可以通过简单接口快速实现一个类微信的音视频通话场景。
API
描述
init
初始化 TUICallKit
call
发起 1v1 通话
groupCall
发起群组通话
设置用户的头像、昵称
设置自定义来电铃声
设置日志级别
开启/关闭悬浮窗功能
开启/关闭来电铃声
加入群组中已有的音视频通话
destroyed
销毁 TUICallKit
获取 TUICallEngine 实例,v2.4.3+ 支持

TUICallEngine (无 UI 接口)

TUICallEngine API 是音视频通话组件的无 UI 接口,如果 TUICallKit 的交互并不满足您的需求,您可以使用这套 API 根据您的业务需求自定义封装。
API
描述
创建 TUICallEngine 实例(静态方法)
销毁 TUICallEngine 实例(静态方法)
on
增加事件监听
off
取消事件监听
call
发起 1v1 通话
groupCall
发起群组通话
accept
接听通话
reject
拒绝通话
hangup
结束通话
切换通话媒体类型,比如视频通话切音频通话
开启摄像头
关闭摄像头
切换前后摄像头
打开麦克风
关闭麦克风
选择音频播放设备(听筒/扬声器)
设置用户的头像、昵称

关键常量定义

常量
描述
EVENT
通话的事件表
通话的状态 默认、呼叫中/被呼叫中 接通中
通话的类型 音频 视频
声音的播放设备 扬声器、听筒

通话的事件表

事件名
说明
INVITED
被邀请通话
用户接听
用户进入通话
用户离开通话
用户更新
REJECT
用户拒绝通话
NO_RESP
用户无响应
LINE_BUSY
用户忙线
通话被取消
CALL_END
通话结束
SDK_READY
SDK Ready 回调
被踢下线
CALL_MODE
切换通话模式

通话的状态

CALL_STATUS
说明
IDLE
默认
CALLING
呼叫中/被呼叫中
CONNECTED
接通中

通话的类型

MEDIA_TYPE
说明
AUDIO
音频
VIDEO
视频

声音的播放设备

AUDIO_PLAYBACK_DEVICE
说明
EAR
听筒
SPEAKER
扬声器