API

模块

基础函数

登录/注销

透明通道

队列管理

呼叫

邀请

房间管理

进出房间

房间和成员管理

房间属性

用户属性

音频管理

视频管理

影音共享

屏幕共享

本地录制/本地直播

云端录制/互动直播

接口详情

getSDKVersion

• 功能: 获取原生SDK版本号
• 返回值: SDK版本号

RTCSDK.getSDKVersion()

init

• 功能: SDK初始化
• 返回值: 无

RTCSDK.init(initObj, initCallback)

uninit

• 功能: SDK反初始化
• 返回值: 无

RTCSDK.uninit()

setServerAddr

• 功能: 设置服务器地址
• 返回值: 无

RTCSDK.setServerAddr(addr)

login

• 功能: 登录
• 返回值: 无

RTCSDK.login(LoginObj, cookie)

• 补充说明:

登陆成功则回调 loginSuccess ,登陆失败则回调 loginFail

updateToken

• 功能: 更新Token
• 返回值: 无

RTCSDK.updateToken(token)

logout

• 功能: 注销登录
• 返回值: 无

RTCSDK.logout()

• 补充说明:

退出程序时，必须注销本次登录，然后再进行SDK反初始化操作

getUserAuthErrCode

• 功能: 获取第三方鉴权失败码（只有在登录失败原因为17时有效）
• 返回值: 第三方返回的失败码(number)

RTCSDK.getUserAuthErrCode()

getUserAuthErrDesc

• 功能: 获取第三方鉴权失败原因描述（只有在登录失败原因为17时有效）
• 返回值: 第三方返回的描述串(string)

RTCSDK.getUserAuthErrDesc()

setDNDStatus

• 功能: 设置免打扰
• 返回值: 无

RTCSDK.setDNDStatus(DNDStatus, cookie)

• 补充说明:

设置结果请参见setDNDStatusSuccess/setDNDStatusFail;
开启免打扰后，他人呼叫本人时，系统自动回绝呼叫，错误码为602;
开启免打扰后，系统将不再自动为座席分配客户autoAssignUser，座席可以调用reqAssignUser来手动分配客户（叫号模式）;

getUserStatus

• 功能: 获取本AppID下的登录用户的状态信息
• 返回值: 无

RTCSDK.getUserStatus(userID, cookie)

• 补充说明:

结果请参见getUserStatusRslt
只返回在线用户状态信息，获取不到的代表未登录

startUserStatusNotify

• 功能: 开启AppID下的用户登录状态消息推送
• 返回值: 无

RTCSDK.startUserStatusNotify(cookie)

• 补充说明:

开启后他人状态变化将收到notifyUserStatus通知
开启结果请参见startStatusPushRslt
如果在线用户量很大时，将带来很大的开销请谨慎开启;

stopUserStatusNotify

• 功能: 关闭appID下的用户在线状态消息推送
• 返回值: 无

RTCSDK.stopUserStatusNotify(cookie)

• 补充说明:

结果请参见stopStatusPushRslt

loginSuccess

• 功能: 登陆成功的通知

RTCSDK.on("loginSuccess", ({ userID, cookie }) => {})

loginFail

• 功能: 登录失败的通知

RTCSDK.on("loginFail", ({ sdkErr, cookie }) => {})

notifyTokenWillExpire

• 功能: Token即将失效的通知

RTCSDK.on("notifyTokenWillExpire", () => {})

• 补充说明:

采用Token模式登录，才会收到此回调；
Token到期前30秒左右回调，应尽快调用updateToken将授权更久的Token设置给SDK；

lineOff

• 功能: 通知自己掉线

RTCSDK.on("lineOff", ({ sdkErr }) => {})

setDNDStatusSuccess

• 功能: 设置免打扰成功的通知

RTCSDK.on("setDNDStatusSuccess", ({ cookie }) => {})

setDNDStatusFail

• 功能: 设置免打扰失败的通知

RTCSDK.on("setDNDStatusFail", ({ sdkErr, cookie }) => {})

getUserStatusRslt

• 功能: 获取用户登录状态信息的结果

RTCSDK.on("getUserStatusRslt", ({ sdkErr, userStatus, cookie }) => {})

startStatusPushRslt

• 功能: 开启用户状态通知结果

RTCSDK.on("startStatusPushRslt", ({ sdkErr, cookie }) => {})

stopStatusPushRslt

• 功能: 关闭用户状态通知结果

RTCSDK.on("stopStatusPushRslt", ({ sdkErr, cookie }) => {})

notifyUserStatus

• 功能: 通知某用户登录状态变化

RTCSDK.on("notifyUserStatus", ({ uStatus }) => {})

sendCmd

• 功能: 发送小块数据（50K以内），此接口不能被cancelSend, 一次性发送，不会有进度通知
• 返回值: 任务ID(string)

RTCSDK.sendCmd(targetUserId, data)

• 补充说明:

发送结果请参见sendCmdRslt
目标用户将收到通知notifyCmdData
房间内群发消息参见sendMeetingCustomMsg

sendBuffer

• 功能: 发送点对点大数据
• 返回值: 任务ID(string)

RTCSDK.sendBuffer(targetUserId, data)

• 补充说明:

数据将被分块发送，发送进度参见notifySendProgress
取消发送参见cancelSend
结果请参见sendBufferRslt
目标用户将收到通知notifyBufferData

sendFile

• 功能: 发送点对点文件
• 返回值: 任务ID(string)

RTCSDK.sendFile(targetUserId, fileName)

• 补充说明:

数据将被分块发送，发送进度参见notifySendProgress
取消发送参见cancelSend
结果请参见sendFileRslt
目标用户将收到通知notifyFileData

cancelSend

• 功能: 取消大数据、文件的发送
• 返回值: 无

RTCSDK.cancelSend(sendId)

• 补充说明:

只能取消sendBuffer、sendFile的任务
只有任务还未发送完成的才能被取消
是否成功取消，可关注cancelSendRslt回调

sendCmdRslt

• 功能: 发送点对点消息结果

RTCSDK.on("sendCmdRslt", ({ sendId, sdkErr }) => {})

sendBufferRslt

• 功能: 发送点对点大数据结果

RTCSDK.on("sendBufferRslt", ({ sendId, sdkErr }) => {})

sendFileRslt

• 功能: 发送点对点文件结果

RTCSDK.on("sendFileRslt", ({ sendId, fileName, sdkErr }) => {})

cancelSendRslt

• 功能: 取消发送结果

RTCSDK.on("cancelSendRslt", ({ sendId, sdkErr }) => {})

notifySendProgress

• 功能: 通知大数据、文件的发送进度

RTCSDK.on("notifySendProgress", ({ sendId, sendedLen, totalLen }) => {})

notifyCmdData

• 功能: 通知收到点对点透明通道消息

RTCSDK.on("notifyCmdData", ({ sourceUserId, data }) => {})

notifyBufferData

• 功能: 通知收到点对点大数据

RTCSDK.on("notifyBufferData", ({ sourceUserId, data }) => {})

notifyFileData

• 功能: 通知收到点对点文件

RTCSDK.on("notifyFileData", ({ sourceUserId, tmpFile, orgFileName }) => {})

initQueue

• 功能: 初始化用户队列功能数据
• 返回值: 无

RTCSDK.initQueue(cookie)

• 补充说明:

初始化队列结果请参见initQueueDatRslt；
队列初始化成功后才可进行其它队列操作；

getAllQueueInfo

• 功能: 获取AppID下的所有队列基础信息
• 返回值: 队列基础信息列表(Array<QueueInfo>)

RTCSDK.getAllQueueInfo()

getQueueStatus

• 功能: 获取指定队列的排队状况
• 返回值: 队列状态(QueueStatus)

RTCSDK.getQueueStatus(queID)

getQueuingInfo

• 功能: 获取我的排队信息
• 返回值: 我的排队信息(QueuingInfo)

RTCSDK.getQueuingInfo()

getServiceQueues

• 功能: 获取我服务的所有队列
• 返回值: 队列Id列表(Array<number>)

RTCSDK.getServiceQueues()

getSessionInfo

• 功能: 获取我的会话信息
• 返回值: 会话信息(VideoSessionInfo)

RTCSDK.getSessionInfo()

startQueuing

• 功能: 客户开始排队
• 返回值: 无

RTCSDK.startQueuing(queID, usrExtDat, cookie)

• 补充说明:

客户同一时间，只能排一个队列；
排队结果请参见startQueuingRslt；

stopQueuing

• 功能: 客户停止排队
• 返回值: 无

RTCSDK.stopQueuing(cookie)

• 补充说明:

排队结果请参见stopQueuingRslt；

startService

• 功能: 座席开始服务某队列
• 返回值: 无

RTCSDK.startService(queID, priority, cookie)

• 补充说明:

可以多次调用，开启对多个队列的服务；
开启服务结果请参见startServiceRslt；
开启成功后：
a. 如果没有开启免打扰setDNDStatus，那么系统会自动分配客户：autoAssignUser；
b. 如果开启免打挽，系统就不会分配客户，如需服务客户可调用：reqAssignUser；
座席优先级描述：
a. 客户优先分配给服务此队列优先级最高的，且空闲的座席；
b. 优先级相同时，则分配给最先空闲的座席；
c. 优先级高的座席变空闲时，不抢夺已分配的客户；

stopService

• 功能: 座席停止服务某队列
• 返回值: 无

RTCSDK.stopService(queID, cookie)

• 补充说明:

停止服务结果请参见stopServiceRslt；

reqAssignUser

• 功能: 座席手动分配客户
• 返回值: 无

RTCSDK.reqAssignUser(cookie)

• 补充说明:

开启免打扰后手动分配客户接口；（当关闭免打扰时，系统将自动分配客户，无需调用此接口）
分配结果请参见reqAssignUserRslt；

acceptAssignUser

• 功能: 接受系统自动分配的客户
• 返回值: 无

RTCSDK.acceptAssignUser(queID, userID, cookie)

• 补充说明:

结果请参见responseAssignUserRslt；

rejectAssignUser

• 功能: 拒绝系统自动分配的客户
• 返回值: 无

RTCSDK.rejectAssignUser(queID, userID, cookie)

• 补充说明:

结果请参见responseAssignUserRslt；

initQueueDatRslt

• 功能: 初始化队列功能结果

RTCSDK.on("initQueueDatRslt", ({ sdkErr, cookie }) => {})

queueStatusChanged

• 功能: 队列排队状态更新

RTCSDK.on("queueStatusChanged", ({ queStatus }) => {})

queuingInfoChanged

• 功能: 我的排队信息更新

RTCSDK.on("queuingInfoChanged", ({ queuingInfo }) => {})

startQueuingRslt

• 功能: 客户开始排队结果

RTCSDK.on("startQueuingRslt", ({ sdkErr, cookie }) => {})

stopQueuingRslt

• 功能: 客户停止排队结果

RTCSDK.on("stopQueuingRslt", ({ sdkErr, cookie }) => {})

startServiceRslt

• 功能: 座席开始服务结果

RTCSDK.on("startServiceRslt", ({ queID, sdkErr, cookie }) => {})

stopServiceRslt

• 功能: 座席停止服务结果

RTCSDK.on("stopServiceRslt", ({ queID, sdkErr, cookie }) => {})

responseAssignUserRslt

• 功能: 响应分配客户操作结果

RTCSDK.on("responseAssignUserRslt", ({ sdkErr, cookie }) => {})

autoAssignUser

• 功能: 座席自动分配客户通知

RTCSDK.on("autoAssignUser", ({ usr }) => {})

• 补充说明:

如果不需要系统的自动分配，请通setDNDStatus开启免打扰功能；
acceptAssignUser后，还需要调用call去呼叫对方进入目标房间；
收到系统分配的客户后，如果座席不acceptAssignUser也不rejectAssignUser，系统将在30秒后取消本次分配cancelAssignUser，然后将客户放回到队首

reqAssignUserRslt

• 功能: 座席手动分配客户结果

RTCSDK.on("reqAssignUserRslt", ({ sdkErr, usr, cookie }) => {})

cancelAssignUser

• 功能: 通知分配的客户取消了

RTCSDK.on("cancelAssignUser", ({ queID, userID }) => {})

• 补充说明:

被取消的原因，可能是用户取消排队了，或者用户掉线了，或者收到autoAssignUser后没有及时acceptAssignUser / rejectAssignUser

call

• 功能: 发起呼叫
• 返回值: 呼叫ID(string)

RTCSDK.call(calledUserID, ID, usrExtDat, cookie)

• 补充说明:

发起的呼叫结果参见callRslt；
呼叫时，对方迟迟不acceptCall / rejectCall，30秒后将超时而自动结束呼叫；
如果呼叫SIP/H.323设备, usrExtDat可以指定为：
{"devInfo":{"autoOpenMic":0}};
其中 devInfo 可参考 CRDevJoinCfg

acceptCall

• 功能: 接受他人的呼叫
• 返回值: 无

RTCSDK.acceptCall(callID, ID, usrExtDat, cookie)

• 补充说明:

接受结果参见acceptCallRslt

rejectCall

• 功能: 拒接他人的呼叫
• 返回值: 无

RTCSDK.rejectCall(callID, usrExtDat, cookie)

• 补充说明:

接受结果参见rejectCallRslt

hangupCall

• 功能: 挂断通话
• 返回值: 无

RTCSDK.hangupCall(callID, usrExtDat, cookie)

• 补充说明:

挂断结果参见hangupCallRslt

callMoreParty

• 功能: 发起多方呼叫（或呼转）
• 返回值: 呼叫ID(string)

RTCSDK.callMoreParty(calledUserID, ID, usrExtDat, cookie)

• 补充说明:

呼叫结果参见callMorePartyRslt；
呼转实现思路： A、B通话已建立（假设callID为IdAB)，B想由C来服务A，B callMoreParty C（假设callID为IdBC)， 在C接受进入通话后，A便可挂断IdAB通话并离开房间。

cancelCallMoreParty

• 功能: 取消多方呼叫
• 返回值: 无

RTCSDK.cancelCallMoreParty(callID, usrExtDat, cookie)

• 补充说明:

取消结果参见cancelCallMorePartyRslt；

callRslt

• 功能: 发起的呼叫结果

RTCSDK.on("callRslt", ({ callID, sdkErr, cookie }) => {})

acceptCallRslt

• 功能: 接受他人呼叫的结果

RTCSDK.on("acceptCallRslt", ({ callID, sdkErr, cookie }) => {})

rejectCallRslt

• 功能: 拒绝他人呼叫的结果

RTCSDK.on("rejectCallRslt", ({ callID, sdkErr, cookie }) => {})

hangupCallRslt

• 功能: 挂断通话结果

RTCSDK.on("hangupCallRslt", ({ callID, sdkErr, cookie }) => {})

notifyCallIn

• 功能: 通知呼入

RTCSDK.on("notifyCallIn", ({ callID, ID, callerID, usrExtDat }) => {})

notifyCallAccepted

• 功能: 通知呼叫被接受

RTCSDK.on("notifyCallAccepted", ({ callID, ID, usrExtDat }) => {})

notifyCallRejected

• 功能: 通知呼叫被拒接

RTCSDK.on("notifyCallRejected", ({ callID, sdkErr, usrExtDat }) => {})

notifyCallHungup

• 功能: 通知呼叫被挂断

RTCSDK.on("notifyCallHungup", ({ callID, usrExtDat }) => {})

callMorePartyRslt

• 功能: 发起多方呼叫结果

RTCSDK.on("callMorePartyRslt", ({ callID, sdkErr, cookie }) => {})

cancelCallMorePartyRslt

• 功能: 取消多方呼叫结果

RTCSDK.on("cancelCallMorePartyRslt", ({ callID, sdkErr, cookie }) => {})

notifyCallMorePartyStatus

• 功能: 通知多方呼叫状态

RTCSDK.on("notifyCallMorePartyStatus", ({ callID, sdkErr, status }) => {})

invite

• 功能: 发送邀请
• 返回值: 邀请ID(string)

RTCSDK.invite(invitedUserID, usrExtDat, cookie)

• 补充说明:

邀请结果参见inviteRslt；

acceptInvite

• 功能: 接受邀请
• 返回值: 无

RTCSDK.acceptInvite(inviteID, usrExtDat, cookie)

• 补充说明:

接受结果参见acceptInviteRslt；

rejectInvite

• 功能: 拒接邀请
• 返回值: 无

RTCSDK.rejectInvite(inviteID, usrExtDat, cookie)

• 补充说明:

拒接结果参见rejectInviteRslt；

cancelInvite

• 功能: 取消邀请
• 返回值: 无

RTCSDK.cancelInvite(inviteID, usrExtDat, cookie)

• 补充说明:

取消结果参见cancelInviteRslt；

inviteRslt

• 功能: 邀请他人结果

RTCSDK.on("inviteRslt", ({ inviteID, sdkErr, cookie }) => {})

acceptInviteRslt

• 功能: 接受邀请结果

RTCSDK.on("acceptInviteRslt", ({ inviteID, sdkErr, cookie }) => {})

rejectInviteRslt

• 功能: 拒接邀请结果

RTCSDK.on("rejectInviteRslt", ({ inviteID, sdkErr, cookie }) => {})

cancelInviteRslt

• 功能: 取消邀请结果

RTCSDK.on("cancelInviteRslt", ({ inviteID, sdkErr, cookie }) => {})

notifyInviteIn

• 功能: 通知收到邀请

RTCSDK.on("notifyInviteIn", ({ inviteID, inviterUsrID, usrExtDat }) => {})

notifyInviteAccepted

• 功能: 通知邀请被接受

RTCSDK.on("notifyInviteAccepted", ({ inviteID, usrExtDat }) => {})

notifyInviteRejected

• 功能: 通知邀请被拒接

RTCSDK.on("notifyInviteRejected", ({ inviteID, sdkErr, usrExtDat }) => {})

notifyInviteCanceled

• 功能: 通知邀请被取消

RTCSDK.on("notifyInviteCanceled", ({ inviteID, sdkErr, usrExtDat }) => {})

createMeeting

• 功能: 创建房间
• 返回值: 无

RTCSDK.createMeeting(cookie)

• 补充说明:

操作成功则回调createMeetingSuccess，失败则回调createMeetingFail

destroyMeeting

• 功能: 销毁房间
• 返回值: 无

RTCSDK.destroyMeeting(ID, cookie)

• 补充说明:

回调函数destroyMeetingRslt

createMeetingSuccess

• 功能: 通知创建房间成功

RTCSDK.on("createMeetingSuccess", ({ ID, cookie }) => {})

createMeetingFail

• 功能: 通知创建房间失败

RTCSDK.on("createMeetingFail", ({ sdkErr, cookie }) => {})

destroyMeetingRslt

• 功能: 销毁房间响应

RTCSDK.on("destroyMeetingRslt", ({ sdkErr, cookie }) => {})

enterMeeting

• 功能: 进入房间
• 返回值: 无

RTCSDK.enterMeeting(ID, nickname)

• 补充说明:

操作完成则回调enterMeetingRslt

exitMeeting

• 功能: 离开房间
• 返回值: 无

RTCSDK.exitMeeting()

kickout

• 功能: 将房间内指定成员踢出房间
• 返回值: 无

RTCSDK.kickout(userID)

enterMeetingRslt

• 功能: 进入房间结果

RTCSDK.on("enterMeetingRslt", ({ sdkErr }) => {})

userEnterMeeting

• 功能: 有人进入房间通知

RTCSDK.on("userEnterMeeting", ({ userID }) => {})

userLeftMeeting

• 功能: 有人离开房间通知

RTCSDK.on("userLeftMeeting", ({ userID }) => {})

kickoutRslt

• 功能: 踢人的结果通知

RTCSDK.on("kickoutRslt", ({ sdkErr, userID }) => {})

meetingDropped

• 功能: 通知从房间里掉线了，收到该通知后可以调用enterMeeting尝试重新进入房间

RTCSDK.on("meetingDropped", ({ reason }) => {})

meetingStopped

• 功能: 通知房间已被结束

RTCSDK.on("meetingStopped", () => {})

getAllMembers

• 功能: 获取房间所有成员信息列表
• 返回值: 返回含多个成员信息（Array ------MemberInfo）

RTCSDK.getAllMembers()

getMemberInfo

• 功能: 获取单个成员信息
• 返回值: 返回成员信息（MemberInfo）

RTCSDK.getMemberInfo(userID)

sendMeetingCustomMsg

• 功能: 房间内发送广播消息
• 返回值: 无

RTCSDK.sendMeetingCustomMsg(msg, cookie)

• 补充说明:

需要进进入房间议后才能调用

notifyNickNameChanged

• 功能: SDK通知某用户改变了昵称

RTCSDK.on("notifyNickNameChanged", ({ userID, oldName, newName }) => {})

• 补充说明:

改昵称的用户自身不会接收到此通知

sendMeetingCustomMsgRslt

• 功能: 通知发送房间内自定义广播消息结果

RTCSDK.on("sendMeetingCustomMsgRslt", ({ sdkErr, cookie }) => {})

notifyMeetingCustomMsg

• 功能: 通知接收到房间内用户自定义广播

RTCSDK.on("notifyMeetingCustomMsg", ({ fromUserID, text }) => {})

netStateChanged

• 功能: 通知我的网络变化

RTCSDK.on("netStateChanged", ({ level }) => {})

getMeetingAllAttrs

• 功能: 获取所有房间属性
• 返回值: 无

RTCSDK.getMeetingAllAttrs(cookie)

• 补充说明:

获取结果请参见：getMeetingAllAttrsSuccess 或 getMeetingAllAttrsFail

getMeetingAttrs

• 功能: 获取部份房间属性
• 返回值: 无

RTCSDK.getMeetingAttrs(keys, cookie)

• 补充说明:

获取结果请参见：getMeetingAttrsSuccess 或 getMeetingAttrsFail

setMeetingAttrs

• 功能: 重置所有房间属性
• 返回值: 无

RTCSDK.setMeetingAttrs(attrs, options, cookie)

• 补充说明:

设置结果请参见：setMeetingAttrsRslt

addOrUpdateMeetingAttrs

• 功能: 添加或更新房间属性
• 返回值: 无

RTCSDK.addOrUpdateMeetingAttrs(attrs, options, cookie)

• 补充说明:

结果请参见：addOrUpdateMeetingAttrsRslt

delMeetingAttrs

• 功能: 删除房间属性
• 返回值: 无

RTCSDK.delMeetingAttrs(keys, options, cookie)

• 补充说明:

结果请参见：delMeetingAttrsRslt

clearMeetingAttrs

• 功能: 清空所有房间属性
• 返回值: 无

RTCSDK.clearMeetingAttrs(options, cookie)

• 补充说明:

结果请参见：clearMeetingAttrsRslt

getMeetingAllAttrsSuccess

• 功能: 获取所有房间属性成功

RTCSDK.on("getMeetingAllAttrsSuccess", ({ attrSeq, cookie }) => {})

getMeetingAllAttrsFail

• 功能: 获取所有房间属性失败

RTCSDK.on("getMeetingAllAttrsFail", ({ sdkErr, cookie }) => {})

getMeetingAttrsSuccess

• 功能: 获取部份房间属性成功

RTCSDK.on("getMeetingAttrsSuccess", ({ attrSeq, cookie }) => {})

getMeetingAttrsFail

• 功能: 获取部份房间属性失败

RTCSDK.on("getMeetingAttrsFail", ({ sdkErr, cookie }) => {})

setMeetingAttrsRslt

• 功能: 重置所有房间属性结果

RTCSDK.on("setMeetingAttrsRslt", ({ sdkErr, cookie }) => {})

addOrUpdateMeetingAttrsRslt

• 功能: 添加或更新房间属性结果

RTCSDK.on("addOrUpdateMeetingAttrsRslt", ({ sdkErr, cookie }) => {})

delMeetingAttrsRslt

• 功能: 删除房间属性结果

RTCSDK.on("delMeetingAttrsRslt", ({ sdkErr, cookie }) => {})

clearMeetingAttrsRslt

• 功能: 清空所有房间属性结果

RTCSDK.on("clearMeetingAttrsRslt", ({ sdkErr, cookie }) => {})

notifyMeetingAttrsChanged

• 功能: 通知房间属性改变

RTCSDK.on("notifyMeetingAttrsChanged", ({ add, updates, delKeys }) => {})

getUserAttrs

• 功能: 获取指定用户的属性
• 返回值: 无

RTCSDK.getUserAttrs(userIDs, keys, cookie)

• 补充说明:

结果请参见：getUserAttrsSuccess 或 getUserAttrsFail

setUserAttrs

• 功能: 重置指定用户的属性
• 返回值: 无

RTCSDK.setUserAttrs(userID, attrs, options, cookie)

• 补充说明:

结果请参见：setUserAttrsRslt

addOrUpdateUserAttrs

• 功能: 添加或更新指定用户的属性
• 返回值: 无

RTCSDK.addOrUpdateUserAttrs(userID, attrs, options, cookie)

• 补充说明:

结果请参见：addOrUpdateUserAttrsRslt

delUserAttrs

• 功能: 删除指定用户的属性
• 返回值: 无

RTCSDK.delUserAttrs(userID, keys, options, cookie)

• 补充说明:

结果请参见：delUserAttrsRslt

clearUserAttrs

• 功能: 清空指定用户的属性
• 返回值: 无

RTCSDK.clearUserAttrs(userID, options, cookie)

• 补充说明:

结果请参见：clearUserAttrsRslt

clearAllUserAttrs

• 功能: 清空所有用户的属性
• 返回值: 无

RTCSDK.clearAllUserAttrs(options, cookie)

• 补充说明:

结果请参见：clearAllUserAttrsRslt

getUserAttrsSuccess

• 功能: 获取指定用户的所有属性成功

RTCSDK.on("getUserAttrsSuccess", ({ attrMap, cookie }) => {})

getUserAttrsFail

• 功能: 获取指定用户的所有属性失败

RTCSDK.on("getUserAttrsFail", ({ sdkErr, cookie }) => {})

setUserAttrsRslt

• 功能: 重置指定用户的属性结果

RTCSDK.on("setUserAttrsRslt", ({ sdkErr, cookie }) => {})

addOrUpdateUserAttrsRslt

• 功能: 添加或更新指定用户的属性结果

RTCSDK.on("addOrUpdateUserAttrsRslt", ({ sdkErr, cookie }) => {})

delUserAttrsRslt

• 功能: 删除指定用户的属性结果

RTCSDK.on("delUserAttrsRslt", ({ sdkErr, cookie }) => {})

clearUserAttrsRslt

• 功能: 清空指定用户的属性结果

RTCSDK.on("clearUserAttrsRslt", ({ sdkErr, cookie }) => {})

clearAllUserAttrsRslt

• 功能: 清空所有用户的属性结果

RTCSDK.on("clearAllUserAttrsRslt", ({ sdkErr, cookie }) => {})

notifyUserAttrsChanged

• 功能: 通知用户属性改变

RTCSDK.on("notifyUserAttrsChanged", ({ userID, add, updates, delKeys }) => {})

openMic

• 功能: 打开麦克风
• 返回值: 无

RTCSDK.openMic(userID)

• 补充说明:

打开自已的麦克风时，先会进入到AOPENING状态，等服务器处理后才会进入AOPEN状态，此时说话才能被采集到。回调函数audioStatusChanged

closeMic

• 功能: 关闭麦克风
• 返回值: 无

RTCSDK.closeMic(userID)

• 补充说明:

关麦操作是立即生效的，本地会立即停止采集。回调函数audioStatusChanged

setAllAudioClose

• 功能: 关闭所有人的麦克风
• 返回值: 无

RTCSDK.setAllAudioClose()

• 补充说明:

关闭所有用户的麦克风(自己除外) ， 调用此接口后会话内其他人的麦克风会关闭，同时收到消息audioStatusChanged

getAudioCfg

• 功能: 获取音频参数
• 返回值: 音频配置,参见AudioCfg

RTCSDK.getAudioCfg()

setAudioCfg

• 功能: 设置音频参数
• 返回值: 无

RTCSDK.setAudioCfg(AudioCfg)

• 补充说明:

注意：成功进入房间后，才可以设置音频属性。

getSpeakerVolume

• 功能: 获取本地扬声器音量
• 返回值: 本地扬声器音量(number),音量等级类型 0-255

RTCSDK.getSpeakerVolume()

setSpeakerVolume

• 功能: 设置本地扬声器音量
• 返回值: 无

RTCSDK.setSpeakerVolume(level)

getSpeakerOut

• 功能: 获取当前是否外放
• 返回值: Boolean

RTCSDK.getSpeakerOut()

setSpeakerOut

• 功能: 设置是否外放
• 返回值: 无

RTCSDK.setSpeakerOut(speakerOut)

startGetAudioPCM

• 功能: 开始获取语音pcm数据
• 返回值: 无

RTCSDK.startGetAudioPCM(aSide, getType, jsonParam)

stopGetAudioPCM

• 功能: 停止获取语音pcm数据
• 返回值: 无

RTCSDK.stopGetAudioPCM(aSide)

audioStatusChanged

• 功能: 通知用户音频状态变化

RTCSDK.on("audioStatusChanged", ({ userID, oldStatus, newStatus }) => {})

micEnergyUpdate

• 功能: 通知成员麦克风声音能量变化

RTCSDK.on("micEnergyUpdate", ({ userID, oldLevel, newLevel }) => {})

notifyAudioPCMData

• 功能: 通知语音PCM数据

RTCSDK.on("notifyAudioPCMData", ({ aSide, audioDat }) => {})

openVideo

• 功能: 打开摄像头
• 返回值: 无

RTCSDK.openVideo(userID)

closeVideo

• 功能: 关闭摄像头
• 返回值: 无

RTCSDK.closeVideo(userID)

getMyVideoPosition

• 功能: 获取前后置摄像头ID
• 返回值: 参见前后置摄像头配置

RTCSDK.getMyVideoPosition()

getVideoCfg

• 功能: 获取设置的摄像头参数
• 返回值: 摄像头参数,参见VideoCfg

RTCSDK.getVideoCfg()

setVideoCfg

• 功能: 设置摄像头参数
• 返回值: 无

RTCSDK.setVideoCfg(VideoCfg)

getVideoEffects

• 功能: 获取视频效果配置
• 返回值: 视频效果配置,参见VideoEffects

RTCSDK.getVideoEffects()

• 补充说明:

该接口仅安卓可用

setVideoEffects

• 功能: 设置视频效果配置
• 返回值: 无

RTCSDK.setVideoEffects(VideoEffects)

• 补充说明:

该接口仅安卓可用

getDefaultVideo

• 功能: 获取指定用户的默认摄像头
• 返回值: 摄像头ID

RTCSDK.getDefaultVideo(userID)

setDefaultVideo

• 功能: 设置默认的摄像头
• 返回值: 无

RTCSDK.setDefaultVideo(userID, videoID)

getLocVideoAttributes

• 功能: 获取某个摄像头私有属性
• 返回值: VideoAttributes，摄像头私有属性

RTCSDK.getLocVideoAttributes(videoID)

setLocVideoAttributes

• 功能: 设置某个摄像头私有属性
• 返回值: 无

RTCSDK.setLocVideoAttributes(videoID, attributes)

getWatchableVideos

• 功能: 获取房间内所有可观看的摄像头
• 返回值: 房间内所有可观看的摄像头列表，数据类型为: <UsrVideoId>[]

RTCSDK.getWatchableVideos()

getAllVideoInfo

• 功能: 获取用户的所有摄像头信息(包含未开启的摄像头)
• 返回值: 用户的所有摄像头信息列表，数据类型为: VideoInfosObj

RTCSDK.getAllVideoInfo(userID)

videoStatusChanged

• 功能: 通知用户视频状态变化

RTCSDK.on("videoStatusChanged", ({ userID, oldStatus, newStatus }) => {})

openVideoRslt

• 功能: 打开摄像头设备操作结果

RTCSDK.on("openVideoRslt", ({ deviceID, success }) => {})

videoDevChanged

• 功能: 通知用户的视频设备有变化

RTCSDK.on("videoDevChanged", ({ userID }) => {})

getMediaCfg

• 功能: 获取影音共享配置参数
• 返回值: 影音共享配置参数,参见VideoCfg

RTCSDK.getMediaCfg()

setMediaCfg

• 功能: 配置影音共享图像质量参数
• 返回值: 无

RTCSDK.setMediaCfg(VideoCfg)

startPlayMedia

• 功能: 播放影音文件
• 返回值: 无

RTCSDK.startPlayMedia(filename, bLocPlay)

pausePlayMedia

• 功能: 暂停或恢复播放影音
• 返回值: 无

RTCSDK.pausePlayMedia(isPause)

stopPlayMedia

• 功能: 停止影音播放
• 返回值: 无

RTCSDK.stopPlayMedia()

• 补充说明:

回调函数notifyMediaStop

setMediaPlayPos

• 功能: 设置播放进度
• 返回值: 无

RTCSDK.setMediaPlayPos(pos)

getMediaInfo

• 功能: 查询当前影音共享状态
• 返回值: 影音文件信息MediaInfoObj

RTCSDK.getMediaInfo()

notifyMediaOpened

• 功能: 通知影音文件打开

RTCSDK.on("notifyMediaOpened", ({ totalTime, width, height }) => {})

• 补充说明:

收到该通知即可渲染媒体共享组件

notifyMediaStart

• 功能: 收到他人开启了影音共享的通知

RTCSDK.on("notifyMediaStart", ({ userID }) => {})

• 补充说明:

收到该通知即可渲染媒体共享组件

notifyMediaPause

• 功能: 收到他人暂停了影音共享的通知

RTCSDK.on("notifyMediaPause", ({ userID, pause }) => {})

notifyMediaStop

• 功能: 收到他人停止了影音共享的通知

RTCSDK.on("notifyMediaStop", ({ userID, reason }) => {})

• 补充说明:

收到该通知即可销毁媒体共享组件

getScreenShareCfg

• 功能: 获取屏幕共享配置
• 返回值: 屏幕共享配置,参见ScreenShareCfg

RTCSDK.getScreenShareCfg()

setScreenShareCfg

• 功能: 设置本地屏幕共享配置
• 返回值: 无

RTCSDK.setScreenShareCfg(ScreenShareCfg)

startScreenShare

• 功能: 开启屏幕共享
• 返回值: 无

RTCSDK.startScreenShare(ScreenMessageCfg)

• 补充说明:

回调函数startScreenShareRslt
屏幕共享需要相应授权，否则无法进行屏幕共享。参考配置

stopScreenShare

• 功能: 停止屏幕共享
• 返回值: 无

RTCSDK.stopScreenShare()

• 补充说明:

回调函数stopScreenShareRslt

startScreenShareRslt

• 功能: 开启屏幕共享的响应事件

RTCSDK.on("startScreenShareRslt", ({ sdkErr }) => {})

stopScreenShareRslt

• 功能: 停止屏幕共享的响应事件

RTCSDK.on("stopScreenShareRslt", ({ sdkErr }) => {})

notifyScreenShareStarted

• 功能: 通知他人开启了屏幕共享

RTCSDK.on("notifyScreenShareStarted", ({ sharerID }) => {})

• 补充说明:

收到该通知即可渲染屏幕共享组件

notifyScreenShareStopped

• 功能: 通知他人停止了屏幕共享

RTCSDK.on("notifyScreenShareStopped", ({ oprUserID }) => {})

notifyScreenMarkStarted

• 功能: 通知屏幕标注开始

RTCSDK.on("notifyScreenMarkStarted", () => {})

notifyScreenMarkStopped

• 功能: 通知屏幕标注停止

RTCSDK.on("notifyScreenMarkStopped", () => {})

createLocMixer

• 功能: 创建本地混图器
• 返回值: 错误码

RTCSDK.createLocMixer(mixerID, mixerCfg, mixerContents)

• 补充说明:

创建本地混图器（用于本地录制、本地推流），当需要多个不同内容的录制、或直播时，就要创建多个混图器 。混图器开消比较大，多个同样图像的输出应该有一个混图器加上多个输出实现；

updateLocMixerContent

• 功能: 更新本地混图器内容
• 返回值: 错误码

RTCSDK.updateLocMixerContent(mixerID, mixerContents)

destroyLocMixer

• 功能: 消毁本地混图器
• 返回值: 无

RTCSDK.destroyLocMixer(mixerID)

• 补充说明:

消毁本地混图器后， 基于此混图器的录制输出、直播推流输出将自动结束

getLocMixerState

• 功能: 获取本地混图器状态
• 返回值: 混图器状态

RTCSDK.getLocMixerState(mixerID)