API 概览

最近更新时间:2025-02-18 19:10:03

我的收藏

TUICallKit (含 UI 接口)

TUICallKit API 是音视频通话组件的含 UI 接口,使用 TUICallKit API,您可以通过简单接口快速实现一个类微信的音视频通话场景。
API
描述
init
初始化 TUICallKit。
calls
发起单人或多人通话。
join
主动加入通话。
设置用户的头像、昵称。
设置自定义来电铃声。
设置日志级别。
开启/关闭悬浮窗功能。
开启/关闭来电铃声。
加入群组中已有的音视频通话。
隐藏按钮。
设置本地用户通话界面背景图。
设置远端用户通话界面背景图。
设置通话界面布局模式。
设置摄像头是否默认打开。
destroyed
销毁 TUICallKit。
获取 TUICallEngine 实例。

TUICallEngine (无 UI 接口)

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

TUICallEvent

TUICallEvent 是 TUICallEngine 对应的事件类,您可以通过监听如下事件,来监听自己感兴趣的事件。
事件名
说明
通话请求的事件
用户接听
用户进入通话
用户离开通话
用户更新
REJECT
用户拒绝通话
NO_RESP
用户无响应
LINE_BUSY
用户忙线
通话未建立时,通话的各端都会抛出该事件
通话接通时抛出的事件
CALL_END
通话结束
SDK_READY
SDK Ready 回调
被踢下线
CALL_MODE
切换通话模式
ERROR
错误信息
所有用户网络质量的事件

关键常量定义

CALL_STATUS

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

CallMediaType

参数
说明
CallMediaType.AUDIO
音频
CallMediaType.VIDEO
视频

CALL_MEDIA_TYPE

参数
说明
CALL_MEDIA_TYPE.AUDIO_CALL
音频
CALL_MEDIA_TYPE.VIDEO_CALL
视频

AUDIO_PLAYBACK_DEVICE

参数
说明
AUDIO_PLAYBACK_DEVICE.EAR
听筒
AUDIO_PLAYBACK_DEVICE.SPEAKER
扬声器

offlinePushInfo

参数
类型
是否必填
含义
offlinePushInfo.title
String
离线推送标题(选填)
offlinePushInfo.description
String
离线推送内容(选填)
offlinePushInfo.androidOPPOChannelID
String
离线推送设置 OPPO 手机 8.0 系统及以上的渠道 ID(选填)
offlinePushInfo.extension
String
离线推送透传内容(选填)(tsignaling 版本 ≥ 0.9.0)