TRTCCalling

TRTCCalling

new TRTCCalling(options) → {Object}

腾讯云 Calling SDK 入口类。
接入前，您需要在 云通信控制台 中创建一个云通信应用，并取得 SDKAppID。

Example
let options = {
  SDKAppID: 0 // 接入时需要将0替换为您的云通信应用的 SDKAppID
};
let trtcCalling = TRTCCalling.create(options);
Parameters:
Name Type Description
options Object

配置

Properties
Name Type Description
SDKAppID Number

云通信应用的 SDKAppID
Returns:

SDK 实例

Type
Object

Methods

on(eventName, callback, context)

监听事件

Parameters:
Name Type Description
eventName

事件名
callback

事件响应回调
context

期望 callback 执行时的上下文

off(eventName, callback, context)

取消监听事件

Parameters:
Name Type Description
eventName

事件名
callback

事件响应回调
context

期望 callback 执行时的上下文

login(params)

登录IM接口，所有功能需要先进行登录后才能使用

Parameters:
Name Type Description
params Object

登录配置

Properties
Name Type Description
sdkAppID Number

您可以在实时音视频控制台 >【应用管理】> 应用信息中查看 SDKAppID
userID String

当前用户的 ID，字符串类型，只允许包含英文字母（a-z 和 A-Z）、数字（0-9）、连词符（-）和下划线（_）
userSig String

腾讯云设计的一种安全保护签名，获取方式请参考 如何计算 UserSig。
callback function

登录回调

logout(callback)

登出接口，登出后无法再进行拨打操作

Parameters:
Name Type Description
callback function

登出回调

call(params)

C2C邀请通话，被邀请方会收到 EVENT.INVITED 事件 如果当前处于通话中，可以调用该函数以邀请第三方进入通话

Parameters:
Name Type Description
params Object

拨打通话配置

Properties
Name Type Description
userID String

被邀请方 userID
type Number

0-未知， 1-语音通话，2-视频通话
timeout Number

0为不超时, 单位 s(秒)

groupCall(params)

IM群组邀请通话，被邀请方会收到 EVENT.INVITED 事件 如果当前处于通话中，可以继续调用该函数继续邀请他人进入通话，同时正在通话的用户会收到 EVENT.GROUP_CALL_INVITEE_LIST_UPDATE 事件

Parameters:
Name Type Description
params Object

群聊拨打通话配置

Properties
Name Type Description
userIDList Array

邀请列表
type Number

0-未知， 1-语音通话，2-视频通话
groupID String

IM群组ID

accept(params)

当您作为被邀请方收到 EVENT.INVITED 事件的回调时，可以调用该函数接听来电

Parameters:
Name Type Description
params Object

群聊拨打通话配置

Properties
Name Type Description
inviteID String

邀请id, 标识一次邀请
roomID Number

通话房间号id
callType Number

0-未知， 1-语音通话，2-视频通话

reject(params)

当您作为被邀请方收到 EVENT.INVITED 事件的回调时，可以调用该函数拒绝来电

Parameters:
Name Type Description
params Object

拒绝通话配置

Properties
Name Type Description
inviteID String

邀请id, 标识一次邀请
isBusy Boolean

是否是忙线中

  • @param {Boolean} params.callType 0-未知， 1-语音通话，2-视频通话

hangup(params)

挂断电话

  1. 当您处于通话中，可以调用该函数结束通话
  2. 当未拨通时, 可用来取消通话
Parameters:
Name Type Description
params Object

挂断通话配置

Properties
Name Type Description
status String

表示状态, calling(拨号中) 或者 connected(已接通)

startRemoteView(params)

当您收到 USER_VIDEO_AVAILABLE 事件回调时，可以调用该函数将远端用户的摄像头数据渲染到指定的dom id节点里

Parameters:
Name Type Description
params Object

渲染远端视频配置

Properties
Name Type Description
userID String

用户id
videoViewDomID String

该用户数据将渲染到该dom id节点里

startLocalView(params)

调用该函数将本地用户的摄像头数据渲染到指定的dom id节点里

Parameters:
Name Type Description
params Object

渲染本地视频配置

Properties
Name Type Description
userID String

用户id
videoViewDomID String

该用户数据将渲染到该dom id节点里

openCamera()

您可以调用该函数开启摄像头 处于通话中的用户会收到 USER_VIDEO_AVAILABLE 回调

closeCamera()

您可以调用该函数关闭摄像头 处于通话中的用户会收到 USER_VIDEO_AVAILABLE 回调

setMicMute(isMute)

是否静音mic 处于通话中的用户会收到 USER_AUDIO_AVAILABLE 回调

Parameters:
Name Type Description
isMute

true:麦克风关闭 false:麦克风打开