API 概览
TUICallKit (含 UI 接口)
TUICallKit API 是音视频通话组件的含 UI 接口,使用 TUICallKit API,您可以通过简单接口快速实现一个类微信的音视频通话场景。
API | 描述 |
创建 TUICallKit 实例(单例模式) | |
设置用户的头像、昵称 | |
发起 1v1 通话 | |
发起 1v1 通话,支持自定义房间号、通话邀请超时时间,离线推送内容等 | |
发起群组通话 | |
发起群组通话,支持自定义房间号、通话邀请超时时间,离线推送内容等 | |
主动加入当前的群组通话中 | |
设置自定义来电铃音 | |
开启/关闭静音模式 | |
开启/关闭悬浮窗功能 | |
开启/关闭来电横幅显示 |
TUICallEngine (无 UI 接口)
TUICallEngine API 是音视频通话组件的无 UI 接口,如果 TUICallKit 的交互并不满足您的需求,您可以使用这套 API 根据您的业务需求自定义封装。
API | 描述 |
创建 TUICallEngine 实例(单例模式) | |
销毁 TUICallEngine 实例(单例模式) | |
完成音视频通话基础能力的鉴权 | |
增加事件回调 | |
移除回调接口 | |
发起 1v1 通话 | |
发起群组通话 | |
接听通话 | |
拒绝通话 | |
结束通话 | |
忽略通话 | |
在群组通话中,邀请其他人加入 | |
主动加入当前的群组通话中 | |
切换通话媒体类型,比如视频通话切音频通话 | |
开始订阅远端用户视频流 | |
停止订阅远端用户视频流 | |
开启摄像头 | |
关闭摄像头 | |
切换前后摄像头 | |
打开麦克风 | |
关闭麦克风 | |
选择音频播放设备(听筒/免提) | |
设置用户的头像、昵称 | |
设置用户视频画面的渲染模式 | |
设置视频编码的编码参数 | |
高级接口,用于接入第三方美颜等 | |
设置美颜级别,支持关闭默认美颜 |
TUICallObserver
TUICallObserver 是 TUICallEngine 对应的回调事件类,您可以通过此回调,来监听自己感兴趣的回调事件。
API | 描述 |
通话过程中错误回调 | |
通话请求的回调 | |
通话取消的回调 | |
通话接通的回调 | |
通话结束的回调 | |
通话的媒体类型发生改变的回调 | |
xxxx 用户拒绝通话的回调 | |
xxxx 用户不响应的回调 | |
xxxx 用户忙线的回调 | |
xxxx 用户加入通话的回调 | |
xxxx 用户离开通话的回调 | |
xxxx 用户是否有视频流的回调 | |
xxxx 用户是否有音频流的回调 | |
所有用户音量大小的反馈回调 | |
所有用户网络质量的反馈回调 | |
当前用户被踢下线 | |
在线时票据过期 |
关键类型定义
API | 描述 |
通话的媒体类型,枚举类型:视频通话、语音通话 | |
通话的角色,枚举类型:主叫、被叫 | |
通话的状态,枚举类型:空闲、待接听、接听中 | |
通话扩展参数:离线推送消息显示内容 | |
音视频房间Id,支持数字、字符串两种类型 | |
摄像头Id参数,枚举类型:前摄、后摄 | |
声音的播放设备,枚举类型:扬声器、听筒 | |
当前的网络质量信息 |