含 UI 集成方案

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

TUICallEngine API 简介

TUICallEngine API 是音视频通话组件的无 UI 接口,如果 TUICallKit 的交互并不满足您的需求,您可以使用这套接口自己封装交互。 由于小程序开发的限制,需要先给 live-pusher 绑定事件,具体请参见 TUICallkit

API 概览

创建实例和事件回调

API
描述
创建 TUICallEngine 实例(静态方法)
销毁 TUICallEngine 实例(静态方法)
on
增加事件监听
off
取消事件监听

通话操作相关接口函数

API
描述
call
发起 1v1 通话
groupCall
发起群组通话
accept
接听通话
reject
拒绝通话
hangup
结束通话
切换通话媒体类型,比如视频通话切音频通话

设备控制相关接口函数

API
描述
开启摄像头
关闭摄像头
切换前后摄像头
打开麦克风
关闭麦克风
选择音频播放设备(听筒/扬声器)

其他接口函数

API
描述
设置用户的头像、昵称

API 详情

createInstance

创建 TUICallEngine 的单例(class 上的 static 方法):
TUICallEngine.createInstance({
sdkAppID:'123456',
tim,
})
说明
参数
是否必传
说明
sdkAppID
必传
SDKAppId 是腾讯云用于区分客户的唯一标识
tim
非必传
TIM 是 IM Web SDK 的命名空间,提供了创建 SDK 实例的静态方法

destroyInstance

销毁 TUICallEngine 的单例(class 上的 static 方法):
TUICallEngine.destroyInstance()

on

添加回调接口,您可以通过这个接听,监听 TRTC 相关的事件回调。
on(EventCode, handler, context);
说明
参数
类型
说明
Eventlist
String
事件表
handler
Function
监听函数
context
Object
当前执行上下文

off

移除回调接口。
off(EventCode, handler);
说明
参数
类型
说明
EventCode
String
事件表
handler
Function
监听函数

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"

accept

当您作为被邀请方收到的回调时,可以调用该函数接听来电。
accept();

reject

当您作为被邀请方收到的回调时,可以调用该函数拒绝来电。
reject();

hangup

当您处于通话中,可以调用该函数挂断通话
当您发起通话时,可用去了取消通话
hangup();

switchCallMediaType

切换通话媒体类型,比如视频通话切音频通话。
switchCallMediaType(MEDIA_TYPE.VIDEO);
参数
类型
含义
type
通话的媒体类型,AUDIO-语音通话,VIDEO-视频通话

openCamera

您可以调用该函数开启摄像头。
openCamera();

closeCamera

您可以调用该函数关闭摄像头,处于通话中的用户会收到回调。
closeCamera();

switchCamera

切换前后摄像头。
switchCamera();

openMicrophone

您可以调用该函数打开麦克风,处于通话中的用户会收到回调。
openMicrophone();

closeMicrophone

您可以调用该函数关闭麦克风,处于通话中的用户会收到回调。
closeMicrophone();

selectAudioPlaybackDevice

选择音频播放设备,目前支持听筒、扬声器,在通话场景中,可以使用这个接口来开启/关闭免提模式
selectAudioPlaybackDevice(AUDIO_PLAYBACK_DEVICE.EAR);
参数如下表所示:
参数
类型
含义
type
speaker:扬声器,ear:听筒

setSelfInfo

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

目录