音视频通话

API

API

房间外接口
基础函数
登录/注销
队列管理
呼叫
邀请
透明通道
房间管理
房间内接口
进出房间
房间内基础消息
房间和成员管理
房间、用户属性
音频管理
视频管理
屏幕共享/影音共享
云端录制/云端推流

基础函数

方式 接口 描述
引用
sdkver 获取SDK版本号
主调
Init 初始化
UnInit 反初始化
SetServerAddr 设置服务器地址
EnableLog2File 设置日志打印及上传

登录/注销

方式 接口 描述
主调
Login 登录
LoginByToken Token登录
UpdateToken 更新Token
Logout 注销
回调
LoginSuccess 登陆成功
LoginFail 登录失败
NotifyTokenWillExpire Token即将失效的通知,失效前30秒通知
LineOff 通知自己掉线

队列管理

方式 接口 描述
主调
InitQueueDat 初始化队列
GetAllQueueInfo 查询队列
GetQueueStatus 获取队列状态
GetClientStatus 获取自己的排队、呼叫状态
GetServingStatus 获取自己服务的队列、呼叫状态
StartQueuing 客户开始排队
StopQueuing 客户停止排队
StartService 坐席开始服务队列
StopService 坐席停止服务队列
ReqAssignUser 请求分配一个客户
AcceptAssignUser 接受分配的客户
RejectAssignUser 拒绝分配的客户
回调
InitQueueDatRslt 列初始化操作结果
GetQueueStatusRslt 获取队列状态通知
QueueStatusChanged 队列状态变化通知
QueuingInfoChanged 排队信息变化通知
GetClientStatusRslt 获取自己的排队、呼叫状态的结果
GetServingStatusRslt 获取自己服务的队列、呼叫状态的结果
StartQueuingRslt 开始排队通知
StopQueuingRslt 停止排队通知
StartServiceRslt 开始服务队列通知
StopServiceRslt 停止服务队列通知
ResponseAssignUserRslt 响应分配客户操作结果
AutoAssignUser 自动分配用户通知
ReqAssignUserRslt 请求分配用户结果
CancelAssignUser 系统取消之前分配的的客户

呼叫

方式 接口 描述
主调
Call 发起呼叫
AcceptCall 接受对方发起的呼叫
RejectCall 拒绝对方发起的呼叫
HungupCall 挂断呼叫
SetDNDStatus 设置免打扰状态
GetUserStatus 获取项目下所有用户在线状态
StartUserStatusNotify 开启用户的状态推送
StopUserStatusNotify 关闭用户的状态推送
回调
CallSuccess 发起呼叫操作成功
CallFail 发起呼叫操作失败
NotifyCallIn 通知有人呼入
AcceptCallSuccess 接受他人呼叫操作成功
AcceptCallFail 接受他人呼叫操作失败
RejectCallSuccess 拒绝他人的呼叫成功
RejectCallFail 拒绝他人的呼叫失败
HungupCallSuccess 挂断他人的呼叫成功
HungupCallFail 挂断他人的呼叫失败
NotifyCallAccepted 通知呼叫被对方接受
NotifyCallRejected 通知呼叫被对方拒绝
NotifyCallHungup 通知呼叫被对方挂断
SetDNDStatusSuccess 设置免打扰状态操作成功响应
SetDNDStatusFail 设置免打扰状态操作失败响应
GetUserStatusSuccess 获取所有用户在线状态成功响应
GetUserStatusFail 获取所有用户在线状态失败响应
StartUserStatusNotifyRslt 开启用户状态推送结果
StopUserStatusNotifyRslt 关闭用户状态推送结果
NotifyUserStatus 用户状态变化通知

邀请

方式 接口 描述
主调
Invite 发送邀请
AcceptInvite 接受对方发送的邀请
RejectInvite 拒绝对方发送的邀请
CancelInvite 取消自己发送的邀请
回调
InviteSuccess 发送邀请成功
InviteFail 发送邀请失败
CancelInviteSuccess 取消自己发送的邀请成功
CancelInviteFail 取消自己发送的邀请失败
AcceptInviteSuccess 接受对方发送的邀请成功
AcceptInviteFail 接受对方发送的邀请失败
RejectInviteSuccess 拒绝对方发送的邀请成功
RejectInviteFail 拒绝对方发送的邀请失败
NotifyInviteIn 通知有人邀请
NotifyInviteAccepted 通知邀请被对方接受
NotifyInviteRejected 通知邀请被对方拒绝
NotifyInviteCanceled 通知有邀请被取消

透明通道

方式 接口 描述
主调
SendCmd 发送小块数据
SendBuffer 发送大块数据
回调
SendCmdRlst 通知发送小块数据结果
SendBufferRslt 通知发送大块数据结果
SendProgress 通知发送数据进度
NotifyCmdData 通知收到小块数据
NotifyBufferData 通知收到大块数据

房间管理

方式 接口 描述
主调
CreateMeeting 创建房间
DestroyMeeting 销毁房间
回调
CreateMeetingSuccess 通知创建房间成功
CreateMeetingFail 通知创建房间失败
DestroyMeetingRslt 通知销毁房间的结果

进出房间

方式 接口 描述
主调
EnterMeeting3 进入房间
ExitMeeting 离开房间
Kickout 将房间内指定成员踢出房间
回调
EnterMeetingRslt 进入房间结果
UserEnterMeeting 有人进入房间通知
UserLeftMeeting 有人离开房间通知
MeetingDropped 通知从房间里掉线了
MeetingStopped 通知房间已被结束

房间内基础消息

方式 接口 描述
主调
SwitchToPage 功能区切换
GetCurrentMainPage 获取当前主功能区
GetCurrentSubPage 获取当前子页面
回调
NotifySwitchToPage 会话内主功能页切换通知

房间和成员管理

方式 接口 描述
主调
GetAllMembers 获取房间所有成员信息列表
GetMemberInfo 获取单个成员信息
SendMeetingCustomMsg 房间内发送广播消息
回调
NotifyNickNameChanged SDK通知某用户改变了昵称
SendMeetingCustomMsgRslt 通知发送房间内自定义广播消息结果
NotifyMeetingCustomMsg 通知接收到房间内用户自定义广播

房间、用户属性

方式 接口 描述
主调
GetMeetingAttrs 获取房间部份属性
GetMeetingAllAttrs 获取房间所有属性
SetMeetingAttrs 重置房间属性集
AddOrUpdateMeetingAttrs 增加或者更新房间属性
DelMeetingAttrs 删除房间属性
ClearMeetingAttrs 清除房间所有属性
GetUserAttrs 获取指定用户的指定属性
SetUserAttrs 重置用户属性
AddOrUpdateUserAttrs 增加或更新用户属性
DelUserAttrs 删除用户的特定属性
ClearUserAttrs 清除特定用户的所有属性
ClearAllUserAttrs 清除所有用户的所有属性
回调
GetMeetingAttrsSuccess 成功获取到房间属性
GetMeetingAttrsFail 获取房间指定属性失败
GetMeetingAllAttrsSuccess 成功获取到房间所有属性
GetMeetingAllAttrsFail 获取房间属性失败
SetMeetingAttrsRslt 设置用户属性结果
AddOrUpdateMeetingAttrsRslt 增加或更新房间属性结果
DelMeetingAttrsRslt 删除房间属性结果
ClearMeetingAttrsRslt 清除房间属性结果
GetUserAttrsSuccess 获取房间内用户属性结果
GetUserAttrsFail 获取房间内用户属性失败
SetUserAttrsRslt 设置用户属性结果
AddOrUpdateUserAttrsRslt 增加或者更新用户属性结果
DelUserAttrsRslt 删除特定用户属性结果
ClearUserAttrsRslt 清除特定用户属性结果
ClearAllUserAttrsRslt 清除所有用户属性结果
NotifyMeetingAttrsChanged 通知房间属性发生改变
NotifyUserAttrsChanged 通知用户属性发生改变

音频管理

方式 接口 描述
主调
OpenMic 打开麦克风
CloseMic 关闭麦克风
SetAllAudioClose 关闭所有人的麦克风
回调
AudioStatusChanged 通知用户音频状态变化
MicEnergyUpdate 通知成员麦克风声音能量变化
NotifyAllAudioClose 通知所有人的麦克风被关闭了
OpenMicFailRslt 通知麦克风打开失败

视频管理

方式 接口 描述
主调
OpenVideo 打开摄像头
CloseVideo 关闭摄像头
SetDefaultVideo 切换摄像头
GetDefaultVideo 获取默认摄像头信息
GetWatchableVideos 房间内可观看摄像头列表
GetAllVideoInfo 获取摄像头设备列表
回调
VideoStatusChanged 通知用户视频状态变化
OpenVideoFailRslt 通知摄像头打开失败
VideoDevChanged 通知用户的视频设备有变化

屏幕共享/影音共享

方式 接口 描述
主调
GetScreenInfo 查询当前屏幕共享状态
GetMediaInfo 查询当前影音共享状态
回调
GetMediaInfoRslt 通知查询影音共享状态的结果
NotifyScreenShareStarted 收到他人开启了屏幕共享的通知
NotifyScreenShareStopped 收到他人停止了屏幕共享的通知
NotifyMediaStart 收到他人开启了影音共享的通知
NotifyMediaPause 收到他人暂停了影音共享的通知
NotifyMediaStop 收到他人停止了影音共享的通知

云端录制/云端推流

方式 接口 描述
主调
CreateCloudMixer 创建云端混图器
UpdateCloudMixerContent 更新云端混图器
DestroyCloudMixer 销毁云端混图器
GetAllCloudMixerInfo 得到所有云端混图器信息
GetCloudMixerInfo 得到云端混图器信息
回调
CreateCloudMixerFailed 创建云端录制/推流失败
CloudMixerStateChanged 通知云端录制/推流状态变化
CloudMixerInfoChanged 通知云端录制/推流信息变化
CloudMixerEvent 云端录制/推流事件通知

接口详情

sdkver

  • 功能: 获取SDK版本号
  • 返回值: 版本号
console.log(RTCSDK.sdkver)

Init

  • 功能: SDK初始化
  • 返回值: 错误码(错误码为0表示没有错误)
RTCSDK.Init(CRVideo_InitObj)
参数 类型 说明
CRVideo_InitObj object 初始化参数,详见CRVideo_InitObj
  • 补充说明:

注意: 程序开始时init,程序结束时uninit,整个程序的生命周期中只进行一次初始化和反初始化。

UnInit

  • 功能: 反初始化
  • 返回值: 无
RTCSDK.UnInit()

SetServerAddr

  • 功能: 设置服务器地址
  • 返回值: 无
RTCSDK.SetServerAddr(addr)
参数 类型 说明
addr string 服务器地址,例如:sdk.cloudroom.com
  • 补充说明:

服务器地址默认使用https协议。开发可使用http协议,开发工具需要勾选不校验地址及在手机中打开调试模式。地址格式为http://sdk.cloudroom.com

EnableLog2File

  • 功能: 设置日志打印及上传
  • 返回值: 无
RTCSDK.EnableLog2File(uploading, logDebug)
参数 类型 说明
uploading Boolean 是否上报日志
logDebug Boolean 是否打印到控制台
  • 补充说明:

若缺省调用,默认打开日志上传和打印

Login

  • 功能: 登录
  • 返回值: 无
RTCSDK.Login(appID, md5_appSecret, nickName, UID, userAuthCode, cookie)
参数 类型 说明
appID string 鉴权帐号。用于区分不同的项目,每个项目都有属于自己的唯一的appID,不同appID的项目完全独立,无法相互通信。appID请联系销售获取,并开通相关套餐和功能权限。
md5_appSecret string appID对应的密码(md5加密传给sdk),可登录SDK管理后台修改。
nickName string 昵称
UID string 用户ID, 详细介绍见关键词
userAuthCode string 用户验证信息,可缺省。为空代表不需要sdk验证(一般由业务方先对userID认证完了,再来使用SDK)。如果不为空,SDK服务器将连接提前配好的业务方服务器进行实时验证。
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

登陆成功则回调 LoginSuccess ,登陆失败则回调 LoginFail

LoginByToken

  • 功能: Token登录
  • 返回值: 无
RTCSDK.LoginByToken(token, nickName, UID, userAuthCode, cookie)
参数 类型 说明
token string Token鉴权码,详细介绍见关键词
nickName string 昵称
UID string 用户ID, 详细介绍见关键词
userAuthCode string 用户验证信息,可缺省。为空代表不需要sdk验证(一般由业务方先对userID认证完了,再来使用SDK)。如果不为空,SDK服务器将连接提前配好的业务方服务器进行实时验证。
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

登陆成功则回调 LoginSuccess ,登陆失败则回调 LoginFail

UpdateToken

  • 功能: 更新Token
  • 返回值: 无
RTCSDK.UpdateToken(token)
参数 类型 说明
token string Token鉴权码,详细介绍见关键词

Logout

  • 功能: 注销登录
  • 返回值: 无
RTCSDK.Logout()
  • 补充说明:

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

LoginSuccess

  • 功能: 登陆成功
RTCSDK.LoginSuccess.callback = (UID, cookie) => {}
参数 类型 说明
UID string 用户ID, 详细介绍见关键词
cookie string 详细介绍见cookie

LoginFail

  • 功能: 登录失败
RTCSDK.LoginFail.callback = (sdkErr, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

NotifyTokenWillExpire

  • 功能: Token即将失效的通知,失效前30秒通知
RTCSDK.NotifyTokenWillExpire.callback = () => {}

LineOff

  • 功能: 通知自己掉线
RTCSDK.LineOff.callback = (sdkErr) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义

InitQueueDat

  • 功能: 初始化队列
  • 返回值: 无
RTCSDK.InitQueueDat()
  • 补充说明:

操作完成回调InitQueueDatRslt,队列初始化成功后才可获取队列队列相关信息

GetAllQueueInfo

  • 功能: 查询队列
  • 返回值: 所有队列信息(Array ----- CRVideo_QueueInfo)
RTCSDK.GetAllQueueInfo()

GetQueueStatus

  • 功能: 获取队列状态
  • 返回值: 无
RTCSDK.GetQueueStatus(queID, cookie)
参数 类型 说明
queID number 队列ID
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作完成回调GetQueueStatusRslt

GetClientStatus

  • 功能: 获取自己的排队、呼叫状态
  • 返回值: 无
RTCSDK.GetClientStatus(cookie)
参数 类型 说明
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作完成回调GetClientStatusRslt

GetServingStatus

  • 功能: 获取自己服务的队列、呼叫状态
  • 返回值: 无
RTCSDK.GetServingStatus(cookie)
参数 类型 说明
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作完成回调GetServingStatusRslt

StartQueuing

  • 功能: 客户开始排队
  • 返回值: 无
RTCSDK.StartQueuing(queID, usrExtDat, cookie)
参数 类型 说明
queID number 队列ID
usrExtDat string 自定义扩展参数
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作完成回调StartQueuingRslt

StopQueuing

  • 功能: 客户停止排队
  • 返回值: 无
RTCSDK.StopQueuing(queID, cookie)
参数 类型 说明
queID number 队列ID
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作完成回调StopQueuingRslt

StartService

  • 功能: 坐席开始服务队列
  • 返回值: 无
RTCSDK.StartService(queID, unedfined, cookie)
参数 类型 说明
queID number 队列ID
unedfined any 预留字段,传入undefined
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作完成回调StartServiceRslt

StopService

  • 功能: 坐席停止服务队列
  • 返回值: 无
RTCSDK.StopService(queID, cookie)
参数 类型 说明
queID number 队列ID
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作完成回调StopServiceRslt

ReqAssignUser

  • 功能: 请求分配一个客户
  • 返回值: 无
RTCSDK.ReqAssignUser()
  • 补充说明:

当关闭免打扰时,系统将自动分配客户,无需调用此函数; 当开启免打扰时,系统不再自动分配客户,座席如需服务客户可使用此函数分配。
接口调用回调函数参考ReqAssignUserRslt

AcceptAssignUser

  • 功能: 接受分配的客户
  • 返回值: 无
RTCSDK.AcceptAssignUser(queID, UID)
参数 类型 说明
queID number 队列ID
UID string 用户ID, 详细介绍见关键词

RejectAssignUser

  • 功能: 拒绝分配的客户
  • 返回值: 无
RTCSDK.RejectAssignUser(queID, UID)
参数 类型 说明
queID number 队列ID
UID string 用户ID, 详细介绍见关键词

InitQueueDatRslt

  • 功能: 列初始化操作结果
RTCSDK.InitQueueDatRslt.callback = (sdkErr) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义

GetQueueStatusRslt

  • 功能: 获取队列状态通知
RTCSDK.GetQueueStatusRslt.callback = (sdkErr, queStatus, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
queStatus object 队列状态, 详细介绍见类型定义
cookie string 详细介绍见cookie

QueueStatusChanged

  • 功能: 队列状态变化通知
RTCSDK.QueueStatusChanged.callback = (queStatus) => {}
参数 类型 说明
queStatus object 队列状态, 详细介绍见类型定义

QueuingInfoChanged

  • 功能: 排队信息变化通知
RTCSDK.QueuingInfoChanged.callback = (queuingInfo) => {}
参数 类型 说明
queuingInfo object 排队信息, 详细介绍见类型定义

GetClientStatusRslt

  • 功能: 获取自己的排队、呼叫状态的结果
RTCSDK.GetClientStatusRslt.callback = (sdkErr, statusObj, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
statusObj object 客户状态,详见CRVideo_ClientStatus
cookie string 详细介绍见cookie

GetServingStatusRslt

  • 功能: 获取自己服务的队列、呼叫状态的结果
RTCSDK.GetServingStatusRslt.callback = (sdkErr, statusObj, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
statusObj object 服务状态,详见CRVideo_ServingStatus
cookie string 详细介绍见cookie

StartQueuingRslt

  • 功能: 开始排队通知
RTCSDK.StartQueuingRslt.callback = (sdkErr, position, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
position number 当前排队的位置
cookie string 详细介绍见cookie

StopQueuingRslt

  • 功能: 停止排队通知
RTCSDK.StopQueuingRslt.callback = (sdkErr, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

StartServiceRslt

  • 功能: 开始服务队列通知
RTCSDK.StartServiceRslt.callback = (sdkErr, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

StopServiceRslt

  • 功能: 停止服务队列通知
RTCSDK.StopServiceRslt.callback = (sdkErr, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

ResponseAssignUserRslt

  • 功能: 响应分配客户操作结果
RTCSDK.ResponseAssignUserRslt.callback = (sdkErr, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

AutoAssignUser

  • 功能: 自动分配用户通知
RTCSDK.AutoAssignUser.callback = (queUser) => {}
参数 类型 说明
queUser object 队列用户信息, 详细介绍见类型定义

ReqAssignUserRslt

  • 功能: 请求分配用户结果
RTCSDK.ReqAssignUserRslt.callback = (sdkErr, queUser, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
queUser object 队列用户信息, 详细介绍见类型定义
cookie string 详细介绍见cookie

CancelAssignUser

  • 功能: 系统取消之前分配的的客户
RTCSDK.CancelAssignUser.callback = (queID, UID) => {}
参数 类型 说明
queID number 队列ID
UID string 用户ID, 详细介绍见关键词
  • 补充说明:

系统通过接口AutoAssignUser给队列服务者自动推送客户(或队列服务者通过ReqAssignUser请求分配客户),收到系统分配的客户后,如果队列服务者30秒之内不接受AcceptAssignUser也不拒绝RejectAssignUser推送的客户,系统将通过本接口取消分配,然后将客户分配给其他空闲的服务者。

Call

  • 功能: 发起呼叫
  • 返回值: 返回本次呼叫标识码(呼叫ID)
RTCSDK.Call(calledUserID, MeetInfoObj, usrExtDat, cookie)
参数 类型 说明
calledUserID string 被叫用户的UID
MeetInfoObj object 房间对象,详细介绍见类型定义
usrExtDat string 自定义扩展参数
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作成功则回调CallSuccess,失败则回调CallFail。 呼叫时,对方收到NotifyCallIn通知,如果对方迟迟不响应,30秒后系统自动结束呼叫

AcceptCall

  • 功能: 接受对方发起的呼叫
  • 返回值: 无
RTCSDK.AcceptCall(callID, MeetInfoObj, usrExtDat, cookie)
参数 类型 说明
callID string 呼叫全局标识
MeetInfoObj object 房间对象,详细介绍见类型定义
usrExtDat string 自定义扩展参数
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作成功则回调AcceptCallSuccess,失败则回调AcceptCallFail

RejectCall

  • 功能: 拒绝对方发起的呼叫
  • 返回值: 无
RTCSDK.RejectCall(callID, usrExtDat, cookie)
参数 类型 说明
callID string 呼叫全局标识
usrExtDat string 自定义扩展参数
cookie string 可缺省,详细介绍见关键词

HungupCall

  • 功能: 挂断呼叫
  • 返回值: 无
RTCSDK.HungupCall(callID, usrExtDat, cookie)
参数 类型 说明
callID string 呼叫全局标识
usrExtDat string 自定义扩展参数
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作成功则回调HungupCallSuccess,失败则回调HungupCallFail

SetDNDStatus

  • 功能: 设置免打扰状态
  • 返回值: 无
RTCSDK.SetDNDStatus(DNDStatus, cookie)
参数 类型 说明
DNDStatus number 0代表关闭免打扰, 其它值代表开启免打扰,含义自由定义
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作成功则回调SetDNDStatusSuccess,失败则回调SetDNDStatusFail。如果是使用到了SDK的队列功能,则进入房间后需调用此接口,设置自己的为免打扰状态,防止系统再次推送自己

GetUserStatus

  • 功能: 获取项目下所有用户在线状态
  • 返回值: 无
RTCSDK.GetUserStatus(cookie)
参数 类型 说明
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作成功则回调GetUserStatusSuccess,失败则回调GetUserStatusFail

StartUserStatusNotify

  • 功能: 开启用户的状态推送
  • 返回值: 无
RTCSDK.StartUserStatusNotify(cookie)
参数 类型 说明
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作完成则回调StartUserStatusNotifyRslt。项目下所有用户状态有变化时包括呼叫房间状态、免打扰状态),都会收到通知开启后,用户量越大消息量越大,所以请按需开启在StartUserStatusNotify前,应该先通过GetUserStatus获取所有用户状态

StopUserStatusNotify

  • 功能: 关闭用户的状态推送
  • 返回值: 无
RTCSDK.StopUserStatusNotify(cookie)
参数 类型 说明
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作完成则回调StopUserStatusNotifyRslt

CallSuccess

  • 功能: 发起呼叫操作成功
RTCSDK.CallSuccess.callback = (callID, cookie) => {}
参数 类型 说明
callID string 呼叫全局标识
cookie string 详细介绍见cookie

CallFail

  • 功能: 发起呼叫操作失败
RTCSDK.CallFail.callback = (callID, sdkErr, cookie) => {}
参数 类型 说明
callID string 呼叫全局标识
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

NotifyCallIn

  • 功能: 通知有人呼入
RTCSDK.NotifyCallIn.callback = (callID, MeetInfoObj, callerID, usrExtDat) => {}
参数 类型 说明
callID string 呼叫全局标识
MeetInfoObj object 房间对象,详细介绍见类型定义
callerID string 呼叫人员的UID
usrExtDat string 自定义扩展参数
  • 补充说明:

需要被呼叫者调用接收呼叫AcceptCall或者拒绝呼叫RejectCall。若30秒没有响应,系统自动拒绝当次响应

AcceptCallSuccess

  • 功能: 接受他人呼叫操作成功
RTCSDK.AcceptCallSuccess.callback = (callID, cookie) => {}
参数 类型 说明
callID string 呼叫全局标识
cookie string 详细介绍见cookie
  • 补充说明:

被呼叫者可以调用EnterMeeting3进进入房间议

AcceptCallFail

  • 功能: 接受他人呼叫操作失败
RTCSDK.AcceptCallFail.callback = (callID, sdkErr, cookie) => {}
参数 类型 说明
callID string 呼叫全局标识
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

RejectCallSuccess

  • 功能: 拒绝他人的呼叫成功
RTCSDK.RejectCallSuccess.callback = (callID, cookie) => {}
参数 类型 说明
callID string 呼叫全局标识
cookie string 详细介绍见cookie

RejectCallFail

  • 功能: 拒绝他人的呼叫失败
RTCSDK.RejectCallFail.callback = (callID, sdkErr, cookie) => {}
参数 类型 说明
callID string 呼叫全局标识
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

HungupCallSuccess

  • 功能: 挂断他人的呼叫成功
RTCSDK.HungupCallSuccess.callback = (callID, cookie) => {}
参数 类型 说明
callID string 呼叫全局标识
cookie string 详细介绍见cookie

HungupCallFail

  • 功能: 挂断他人的呼叫失败
RTCSDK.HungupCallFail.callback = (callID, sdkErr, cookie) => {}
参数 类型 说明
callID string 呼叫全局标识
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

NotifyCallAccepted

  • 功能: 通知呼叫被对方接受
RTCSDK.NotifyCallAccepted.callback = (callID, MeetInfoObj, usrExtDat) => {}
参数 类型 说明
callID string 呼叫全局标识
MeetInfoObj object 房间对象,详细介绍见类型定义
usrExtDat string 自定义扩展参数

NotifyCallRejected

  • 功能: 通知呼叫被对方拒绝
RTCSDK.NotifyCallRejected.callback = (callID, sdkErr, usrExtDat) => {}
参数 类型 说明
callID string 呼叫全局标识
sdkErr number 错误码,详细见错误码定义
usrExtDat string 自定义扩展参数

NotifyCallHungup

  • 功能: 通知呼叫被对方挂断
RTCSDK.NotifyCallHungup.callback = (callID, usrExtDat) => {}
参数 类型 说明
callID string 呼叫全局标识
usrExtDat string 自定义扩展参数

SetDNDStatusSuccess

  • 功能: 设置免打扰状态操作成功响应
RTCSDK.SetDNDStatusSuccess.callback = (cookie) => {}
参数 类型 说明
cookie string 详细介绍见cookie

SetDNDStatusFail

  • 功能: 设置免打扰状态操作失败响应
RTCSDK.SetDNDStatusFail.callback = (sdkErr, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

GetUserStatusSuccess

  • 功能: 获取所有用户在线状态成功响应
RTCSDK.GetUserStatusSuccess.callback = (userStatus, cookie) => {}
参数 类型 说明
userStatus Array---CRVideo_UserStatus 用户在线状态信息列表
cookie string 详细介绍见cookie

GetUserStatusFail

  • 功能: 获取所有用户在线状态失败响应
RTCSDK.GetUserStatusFail.callback = (sdkErr, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

StartUserStatusNotifyRslt

  • 功能: 开启用户状态推送结果
RTCSDK.StartUserStatusNotifyRslt.callback = (sdkErr, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

StopUserStatusNotifyRslt

  • 功能: 关闭用户状态推送结果
RTCSDK.StopUserStatusNotifyRslt.callback = (sdkErr, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

NotifyUserStatus

  • 功能: 用户状态变化通知
RTCSDK.NotifyUserStatus.callback = (userStatus, cookie) => {}
参数 类型 说明
userStatus CRVideo_UserStatus 用户状态信息
cookie string 详细介绍见cookie

Invite

  • 功能: 发送邀请
  • 返回值: 返回inviteID(每个邀请对应的唯一ID) (string)
RTCSDK.Invite(invitedUserID, usrExtDat, cookie)
参数 类型 说明
invitedUserID string 受邀者用户ID
usrExtDat string 自定义扩展参数
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作成功则回调InviteSuccess,失败则回调InviteFail。 邀请时,对方收到NotifyInviteIn通知,如果对方迟迟不响应,30秒后系统自动结束本次邀请
如果邀请监控设备进入房间, usrExtDat必须为:
{"meeting":{"ID":会议号}, "devInfo":{"userID":"会议中用户ID", "nickName":"会议中用户昵称"}};

AcceptInvite

  • 功能: 接受对方发送的邀请
  • 返回值: 无
RTCSDK.AcceptInvite(inviteID, usrExtDat, cookie)
参数 类型 说明
inviteID string 邀请ID
usrExtDat string 自定义扩展参数
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作成功则回调AcceptInviteSuccess,失败则回调AcceptInviteFail

RejectInvite

  • 功能: 拒绝对方发送的邀请
  • 返回值: 无
RTCSDK.RejectInvite(inviteID, usrExtDat, cookie)
参数 类型 说明
inviteID string 邀请ID
usrExtDat string 自定义扩展参数
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作成功则回调RejectInviteSuccess,失败则回调RejectInviteFail

CancelInvite

  • 功能: 取消自己发送的邀请
  • 返回值: 无
RTCSDK.CancelInvite(inviteID, usrExtDat, cookie)
参数 类型 说明
inviteID string 邀请ID
usrExtDat string 自定义扩展参数
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作成功则回调CancelInviteSuccess,失败则回调CancelInviteFail

InviteSuccess

  • 功能: 发送邀请成功
RTCSDK.InviteSuccess.callback = (inviteID, cookie) => {}
参数 类型 说明
inviteID string 邀请ID
cookie string 详细介绍见cookie

InviteFail

  • 功能: 发送邀请失败
RTCSDK.InviteFail.callback = (inviteID, sdkErr, cookie) => {}
参数 类型 说明
inviteID string 邀请ID
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

CancelInviteSuccess

  • 功能: 取消自己发送的邀请成功
RTCSDK.CancelInviteSuccess.callback = (inviteID, cookie) => {}
参数 类型 说明
inviteID string 邀请ID
cookie string 详细介绍见cookie

CancelInviteFail

  • 功能: 取消自己发送的邀请失败
RTCSDK.CancelInviteFail.callback = (inviteID, sdkErr, cookie) => {}
参数 类型 说明
inviteID string 邀请ID
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

AcceptInviteSuccess

  • 功能: 接受对方发送的邀请成功
RTCSDK.AcceptInviteSuccess.callback = (inviteID, cookie) => {}
参数 类型 说明
inviteID string 邀请ID
cookie string 详细介绍见cookie

AcceptInviteFail

  • 功能: 接受对方发送的邀请失败
RTCSDK.AcceptInviteFail.callback = (inviteID, sdkErr, cookie) => {}
参数 类型 说明
inviteID string 邀请ID
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

RejectInviteSuccess

  • 功能: 拒绝对方发送的邀请成功
RTCSDK.RejectInviteSuccess.callback = (inviteID, cookie) => {}
参数 类型 说明
inviteID string 邀请ID
cookie string 详细介绍见cookie

RejectInviteFail

  • 功能: 拒绝对方发送的邀请失败
RTCSDK.RejectInviteFail.callback = (inviteID, sdkErr, cookie) => {}
参数 类型 说明
inviteID string 邀请ID
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

NotifyInviteIn

  • 功能: 通知有人邀请
RTCSDK.NotifyInviteIn.callback = (inviteID, invitedUserID, usrExtDat) => {}
参数 类型 说明
inviteID string 邀请ID
invitedUserID string 邀请者用户ID
usrExtDat string 自定义扩展参数

NotifyInviteAccepted

  • 功能: 通知邀请被对方接受
RTCSDK.NotifyInviteAccepted.callback = (inviteID, usrExtDat) => {}
参数 类型 说明
inviteID string 邀请ID
usrExtDat string 自定义扩展参数

NotifyInviteRejected

  • 功能: 通知邀请被对方拒绝
RTCSDK.NotifyInviteRejected.callback = (inviteID, reason, usrExtDat) => {}
参数 类型 说明
inviteID string 邀请ID
reason number 邀请被拒绝原因,定义见错误码
usrExtDat string 自定义扩展参数

NotifyInviteCanceled

  • 功能: 通知有邀请被取消
RTCSDK.NotifyInviteCanceled.callback = (inviteID, reason, usrExtDat) => {}
参数 类型 说明
inviteID string 邀请ID
reason number 邀请被取消原因,定义见错误码
usrExtDat string 自定义扩展参数

SendCmd

  • 功能: 发送小块数据
  • 返回值: 分配的任务ID(string)
RTCSDK.SendCmd(targetUID, data)
参数 类型 说明
targetUID string 目标用户的UID
data string 发送的数据
  • 补充说明:

一次性发送不会有进度通知,发送结果事件SendCmdRlst

SendBuffer

  • 功能: 发送大块数据(分块发送)
  • 返回值: 分配的任务ID(string)
RTCSDK.SendBuffer(targetUID, data, cookie)
参数 类型 说明
targetUID string 目标用户的UID
data string 发送的数据
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

进度通知事件SendProgress,发送结果事件SendBufferRslt

SendCmdRlst

  • 功能: 通知发送小块数据结果
RTCSDK.SendCmdRlst.callback = (taskID, sdkErr) => {}
参数 类型 说明
taskID string 发送任务id
sdkErr number 错误码,详细见错误码定义

SendBufferRslt

  • 功能: 通知发送大块数据结果
RTCSDK.SendBufferRslt.callback = (taskID, sdkErr, cookie) => {}
参数 类型 说明
taskID string 发送任务id
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

SendProgress

  • 功能: 通知发送数据进度
RTCSDK.SendProgress.callback = (taskID, sendedLen, totalLen, cookie) => {}
参数 类型 说明
taskID string 发送任务id
sendedLen number 已发送的数据长度
totalLen number 需要发送的总长度
cookie string 详细介绍见cookie

NotifyCmdData

  • 功能: 通知收到小块数据
RTCSDK.NotifyCmdData.callback = (sourceUID, data) => {}
参数 类型 说明
sourceUID string 发送数据的用户UID
data string 数据的内容

NotifyBufferData

  • 功能: 通知收到大块数据
RTCSDK.NotifyBufferData.callback = (sourceUID, data) => {}
参数 类型 说明
sourceUID string 发送数据的用户UID
data string 数据的内容

CreateMeeting

  • 功能: 创建房间
  • 返回值: 无
RTCSDK.CreateMeeting(cookie)
参数 类型 说明
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作成功则回调CreateMeetingSuccess,失败则回调CreateMeetingFail

DestroyMeeting

  • 功能: 销毁房间
  • 返回值: 无
RTCSDK.DestroyMeeting(meetID, cookie)
参数 类型 说明
meetID number 房间号
cookie string 详细介绍见cookie
  • 补充说明:

回调函数DestroyMeetingRslt,调用此接口结束房间时,其他会话用户会收到MeetingStopped

CreateMeetingSuccess

  • 功能: 通知创建房间成功
RTCSDK.CreateMeetingSuccess.callback = (MeetInfoObj, cookie) => {}
参数 类型 说明
MeetInfoObj object 房间对象,详细介绍见类型定义
cookie string 详细介绍见cookie

CreateMeetingFail

  • 功能: 通知创建房间失败
RTCSDK.CreateMeetingFail.callback = (sdkErr, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

DestroyMeetingRslt

  • 功能: 通知销毁房间的结果
RTCSDK.DestroyMeetingRslt.callback = (sdkErr, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

EnterMeeting3

  • 功能: 进入房间
  • 返回值: 无
RTCSDK.EnterMeeting3(meetID, cookie)
参数 类型 说明
meetID number 房间号
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作完成则回调EnterMeetingRslt

ExitMeeting

  • 功能: 离开房间
  • 返回值: 无
RTCSDK.ExitMeeting()

Kickout

  • 功能: 将房间内指定成员踢出房间
  • 返回值: 无
RTCSDK.Kickout(UID)
参数 类型 说明
UID string 用户ID, 详细介绍见关键词

EnterMeetingRslt

  • 功能: 进入房间结果
RTCSDK.EnterMeetingRslt.callback = (sdkErr, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

UserEnterMeeting

  • 功能: 有人进入房间通知
RTCSDK.UserEnterMeeting.callback = (UID) => {}
参数 类型 说明
UID string 用户ID, 详细介绍见关键词

UserLeftMeeting

  • 功能: 有人离开房间通知
RTCSDK.UserLeftMeeting.callback = (UID) => {}
参数 类型 说明
UID string 用户ID, 详细介绍见关键词

MeetingDropped

  • 功能: 通知从房间里掉线了
RTCSDK.MeetingDropped.callback = () => {}

MeetingStopped

  • 功能: 通知房间已被结束
RTCSDK.MeetingStopped.callback = () => {}

SwitchToPage

  • 功能: 功能区切换
  • 返回值: 无
RTCSDK.SwitchToPage(mainPage, subPageID)
参数 类型 说明
mainPage number 功能页类型
subPageID string 子页面标识(如创建白板时返回的boardID)

GetCurrentMainPage

  • 功能: 获取当前主功能区
  • 返回值: 功能页(number)
RTCSDK.GetCurrentMainPage()

GetCurrentSubPage

  • 功能: 获取当前子页面
  • 返回值: 返回当前的子页面标识(string),如白板的boardID。没有子页面标识的功能区,则返回 0.0
RTCSDK.GetCurrentSubPage()

NotifySwitchToPage

  • 功能: 会话内主功能页切换通知
RTCSDK.NotifySwitchToPage.callback = (mainPage, subPageID) => {}
参数 类型 说明
mainPage number 功能类型
subPageID string 子页面标识

GetAllMembers

  • 功能: 获取房间所有成员信息列表
  • 返回值: 返回含多个成员信息(Array ------CRVideo_MemberInfo)
RTCSDK.GetAllMembers()

GetMemberInfo

RTCSDK.GetMemberInfo(UID)
参数 类型 说明
UID string 用户ID, 详细介绍见关键词

SendMeetingCustomMsg

  • 功能: 房间内发送广播消息
  • 返回值: 无
RTCSDK.SendMeetingCustomMsg(msg, unedfined, cookie)
参数 类型 说明
msg string 发送的文本
unedfined any 预留字段,传入undefined
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

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

NotifyNickNameChanged

  • 功能: SDK通知某用户改变了昵称
RTCSDK.NotifyNickNameChanged.callback = (UID, oldname, newname) => {}
参数 类型 说明
UID string 用户ID, 详细介绍见关键词
oldname string 改变之前的昵称
newname string 改变之后的昵称
  • 补充说明:

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

SendMeetingCustomMsgRslt

  • 功能: 通知发送房间内自定义广播消息结果
RTCSDK.SendMeetingCustomMsgRslt.callback = (sdkErr, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

NotifyMeetingCustomMsg

  • 功能: 通知接收到房间内用户自定义广播
RTCSDK.NotifyMeetingCustomMsg.callback = (UID, jsonDat) => {}
参数 类型 说明
UID string 用户ID, 详细介绍见关键词
jsonDat string 广播内容

GetMeetingAttrs

  • 功能: 获取房间部份属性
  • 返回值: 无
RTCSDK.GetMeetingAttrs(keys, cookie)
参数 类型 说明
keys array 需要查询的房间属性key,如:["key1", "key2"]
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

获取成功则回调 GetMeetingAttrsSuccess ,获取失败则回调 GetMeetingAttrsFail

GetMeetingAllAttrs

  • 功能: 获取房间所有属性
  • 返回值: 无
RTCSDK.GetMeetingAllAttrs(cookie)
参数 类型 说明
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

获取成功则回调 GetMeetingAllAttrsSuccess ,获取失败则回调 GetMeetingAllAttrsFail

SetMeetingAttrs

  • 功能: 重置房间属性集
  • 返回值: 无
RTCSDK.SetMeetingAttrs(attrs, options, cookie)
参数 类型 说明
attrs string 房间属性集,json格式,如:{"key1":"value1", "key2":"value2"} (key最大长度为64B,value最大长度为8KB)
options string 操作选项,json格式参见CRVideo_MeetingAttrOptions
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作完成则回调SetMeetingAttrsRslt

AddOrUpdateMeetingAttrs

  • 功能: 增加或者更新房间属性
  • 返回值: 无
RTCSDK.AddOrUpdateMeetingAttrs(attrs, options, cookie)
参数 类型 说明
attrs string 房间属性集,json格式,如:{"key1":"value1", "key2":"value2"} (key最大长度为64B,value最大长度为8KB)
options string 操作选项,json格式参见CRVideo_MeetingAttrOptions
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作完成则回调AddOrUpdateMeetingAttrsRslt

DelMeetingAttrs

  • 功能: 删除房间属性
  • 返回值: 无
RTCSDK.DelMeetingAttrs(keys, options, cookie)
参数 类型 说明
keys array 需要删除的房间属性key,如:["key1", "key2"]
options string 操作选项,json格式参见CRVideo_MeetingAttrOptions
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作完成则回调DelMeetingAttrsRslt

ClearMeetingAttrs

  • 功能: 清除房间所有属性
  • 返回值: 无
RTCSDK.ClearMeetingAttrs(options, cookie)
参数 类型 说明
options string 操作选项,json格式参见CRVideo_MeetingAttrOptions
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作完成则回调ClearMeetingAttrsRslt

GetUserAttrs

  • 功能: 获取指定用户的指定属性
  • 返回值: 无
RTCSDK.GetUserAttrs(uids, keys, cookie)
参数 类型 说明
uids array 目标用户id列表,一次最多包含50个用, 如:["uid1","uid2"]
keys array 将要获取的用户属性key列表(空串代表获取全部),如:["key1","key2"]
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

获取成功则回调 GetUserAttrsSuccess ,获取失败则回调 GetUserAttrsFail

SetUserAttrs

  • 功能: 重置用户属性
  • 返回值: 无
RTCSDK.SetUserAttrs(UID, attrs, options, cookie)
参数 类型 说明
UID string 用户ID, 详细介绍见关键词
attrs string 用户属性集, json格式,如:{"key1":"value1", "key2":"value2"} (key最大长度为64B,value最大长度为8KB)
options string 操作选项,json格式参见CRVideo_MeetingAttrOptions
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作完成则回调SetUserAttrsRslt

AddOrUpdateUserAttrs

  • 功能: 增加或更新用户属性
  • 返回值: 无
RTCSDK.AddOrUpdateUserAttrs(UID, attrs, options, cookie)
参数 类型 说明
UID string 用户ID, 详细介绍见关键词
attrs string 用户属性集, json格式,如:{"key1":"value1", "key2":"value2"} (key最大长度为64B,value最大长度为8KB)
options string 操作选项,json格式参见CRVideo_MeetingAttrOptions
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作完成则回调AddOrUpdateUserAttrsRslt

DelUserAttrs

  • 功能: 删除用户的特定属性
  • 返回值: 无
RTCSDK.DelUserAttrs(UID, keys, options, cookie)
参数 类型 说明
UID string 用户ID, 详细介绍见关键词
keys array 需要删除的用户属性key列表,json格式,如:["key1","key2"]
options string 操作选项,json格式参见CRVideo_MeetingAttrOptions
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作完成则回调DelUserAttrsRslt

ClearUserAttrs

  • 功能: 清除特定用户的所有属性
  • 返回值: 无
RTCSDK.ClearUserAttrs(uids, options, cookie)
参数 类型 说明
uids string array
options string 操作选项,json格式参见CRVideo_MeetingAttrOptions
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作完成则回调ClearUserAttrsRslt

ClearAllUserAttrs

  • 功能: 清除所有用户的所有属性
  • 返回值: 无
RTCSDK.ClearAllUserAttrs(options, cookie)
参数 类型 说明
options string 操作选项,json格式参见CRVideo_MeetingAttrOptions
cookie string 可缺省,详细介绍见关键词
  • 补充说明:

操作完成则回调ClearAllUserAttrsRslt

GetMeetingAttrsSuccess

  • 功能: 成功获取到房间属性
RTCSDK.GetMeetingAttrsSuccess.callback = (attrs, cookie) => {}
参数 类型 说明
attrs object 房间属性,结构体请参见CRVideo_MeetingAttrObjs
cookie string 详细介绍见cookie

GetMeetingAttrsFail

  • 功能: 获取房间指定属性失败
RTCSDK.GetMeetingAttrsFail.callback = (sdkErr, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

GetMeetingAllAttrsSuccess

  • 功能: 成功获取到房间所有属性
RTCSDK.GetMeetingAllAttrsSuccess.callback = (attrs, cookie) => {}
参数 类型 说明
attrs object 房间属性,结构体请参见CRVideo_MeetingAttrObjs
cookie string 详细介绍见cookie

GetMeetingAllAttrsFail

  • 功能: 获取房间属性失败
RTCSDK.GetMeetingAllAttrsFail.callback = (sdkErr, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

SetMeetingAttrsRslt

  • 功能: 设置用户属性结果
RTCSDK.SetMeetingAttrsRslt.callback = (sdkErr, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

AddOrUpdateMeetingAttrsRslt

  • 功能: 增加或更新房间属性结果
RTCSDK.AddOrUpdateMeetingAttrsRslt.callback = (sdkErr, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

DelMeetingAttrsRslt

  • 功能: 删除房间属性结果
RTCSDK.DelMeetingAttrsRslt.callback = (sdkErr, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

ClearMeetingAttrsRslt

  • 功能: 清除房间属性结果
RTCSDK.ClearMeetingAttrsRslt.callback = (sdkErr, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

GetUserAttrsSuccess

  • 功能: 获取房间内用户属性结果
RTCSDK.GetUserAttrsSuccess.callback = (attrsMap, cookie) => {}
参数 类型 说明
attrsMap object 用户属性,结构体请参见CRVideo_UsrMeetingAttrObjs
cookie string 详细介绍见cookie

GetUserAttrsFail

  • 功能: 获取房间内用户属性失败
RTCSDK.GetUserAttrsFail.callback = (sdkErr, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

SetUserAttrsRslt

  • 功能: 设置用户属性结果
RTCSDK.SetUserAttrsRslt.callback = (sdkErr, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

AddOrUpdateUserAttrsRslt

  • 功能: 增加或者更新用户属性结果
RTCSDK.AddOrUpdateUserAttrsRslt.callback = (sdkErr, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

DelUserAttrsRslt

  • 功能: 删除特定用户属性结果
RTCSDK.DelUserAttrsRslt.callback = (sdkErr, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

ClearUserAttrsRslt

  • 功能: 清除特定用户属性结果
RTCSDK.ClearUserAttrsRslt.callback = (sdkErr, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

ClearAllUserAttrsRslt

  • 功能: 清除所有用户属性结果
RTCSDK.ClearAllUserAttrsRslt.callback = (sdkErr, cookie) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
cookie string 详细介绍见cookie

NotifyMeetingAttrsChanged

  • 功能: 通知房间属性发生改变
RTCSDK.NotifyMeetingAttrsChanged.callback = (adds, updates, delKeys) => {}
参数 类型 说明
adds object 增加房间属性集,结构体请参见CRVideo_MeetingAttrOptions
updates object 变化的房间属性集,结构体请参见CRVideo_MeetingAttrOptions
delKeys array 被删除的房间属性的数组列表,如:["key1", "key2"]

NotifyUserAttrsChanged

  • 功能: 通知用户属性发生改变
RTCSDK.NotifyUserAttrsChanged.callback = (UID, adds, updates, delKeys) => {}
参数 类型 说明
UID string 用户ID, 详细介绍见关键词
adds object 增加用户属性集,json结构体请参见CRVideo_MeetingAttrOptions
updates object 变化的用户属性集,json结构体请参见CRVideo_MeetingAttrOptions
delKeys array 被删除的用户属性列表,json格式,如:["key1", "key2"]

OpenMic

  • 功能: 打开麦克风
  • 返回值: 无
RTCSDK.OpenMic(UID)
参数 类型 说明
UID string 用户ID, 详细介绍见关键词
  • 补充说明:

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

CloseMic

  • 功能: 关闭麦克风
  • 返回值: 无
RTCSDK.CloseMic(UID)
参数 类型 说明
UID string 用户ID, 详细介绍见关键词
  • 补充说明:

关麦操作是立即生效的,本地会立即停止采集

SetAllAudioClose

  • 功能: 关闭所有人的麦克风
  • 返回值: 无
RTCSDK.SetAllAudioClose()

AudioStatusChanged

  • 功能: 通知用户音频状态变化
RTCSDK.AudioStatusChanged.callback = (UID, oldStatus, newStatus) => {}
参数 类型 说明
UID string 用户ID, 详细介绍见关键词
oldStatus number 旧状态,参考麦克风状态
newStatus number 新状态,参考麦克风状态

MicEnergyUpdate

  • 功能: 通知成员麦克风声音能量变化
RTCSDK.MicEnergyUpdate.callback = (UID, oldLevel, newLevel) => {}
参数 类型 说明
UID string 用户ID, 详细介绍见关键词
oldLevel number 原来的说话声音强度等级,0-10
newLevel number 现在的说话声音强度等级,0-10

NotifyAllAudioClose

  • 功能: 通知所有人的麦克风被关闭了
RTCSDK.NotifyAllAudioClose.callback = (UID) => {}
参数 类型 说明
UID string 用户ID, 详细介绍见关键词

OpenMicFailRslt

  • 功能: 通知麦克风打开失败
RTCSDK.OpenMicFailRslt.callback = (sdkErr) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
  • 补充说明:

权限不足触发,用户可以跳转到权限设置手动打开

OpenVideo

  • 功能: 打开摄像头
  • 返回值: 无
RTCSDK.OpenVideo(UID)
参数 类型 说明
UID string 用户ID, 详细介绍见关键词

CloseVideo

  • 功能: 关闭摄像头
  • 返回值: 无
RTCSDK.CloseVideo(UID)
参数 类型 说明
UID string 用户ID, 详细介绍见关键词

SetDefaultVideo

  • 功能: 切换摄像头
  • 返回值: 无
RTCSDK.SetDefaultVideo(UID)
参数 类型 说明
UID string 用户ID, 详细介绍见关键词

GetDefaultVideo

  • 功能: 获取默认摄像头信息
  • 返回值: 返回摄像头Id(number)
RTCSDK.GetDefaultVideo(UID)
参数 类型 说明
UID string 用户ID, 详细介绍见关键词

GetWatchableVideos

  • 功能: 房间内可观看摄像头列表
  • 返回值: 对象VideoIDArray(Array ------ CRVideo_VideoIDsObj)
RTCSDK.GetWatchableVideos(UID)
参数 类型 说明
UID string 用户的UID,非必传。不传则返回会议内所有成员的可观看摄像头列表

GetAllVideoInfo

  • 功能: 获取用户的所有摄像头信息(包含未开启的摄像头)
  • 返回值: 用户的所有摄像头信息列表,数据类型为: CRVideo_VideoInfosObj
RTCSDK.GetAllVideoInfo(UID)
参数 类型 说明
UID string 用户的UID

VideoStatusChanged

  • 功能: 通知用户视频状态变化
RTCSDK.VideoStatusChanged.callback = (UID, oldStatus, newStatus) => {}
参数 类型 说明
UID string 用户ID, 详细介绍见关键词
oldStatus number 旧状态,参考摄像头状态
newStatus number 新状态,参考摄像头状态

OpenVideoFailRslt

  • 功能: 通知摄像头打开失败
RTCSDK.OpenVideoFailRslt.callback = (sdkErr) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
  • 补充说明:

权限不足触发,用户可以跳转到权限设置手动打开

VideoDevChanged

  • 功能: 通知用户的视频设备有变化
RTCSDK.VideoDevChanged.callback = (UID, openCamIds) => {}
参数 类型 说明
UID string 用户ID, 详细介绍见关键词
openCamIds array 该用户现在可观看的摄像头列表

GetScreenInfo

  • 功能: 查询当前屏幕共享状态
  • 返回值: 如果会议内存在屏幕共享则返回共享端的UID,如果没有则返回null
RTCSDK.GetScreenInfo()

GetMediaInfo

  • 功能: 查询当前影音共享状态
  • 返回值: 无
RTCSDK.GetMediaInfo()
  • 补充说明:

查询结果在回调事件GetMediaInfoRslt

GetMediaInfoRslt

  • 功能: 通知查询影音共享状态的结果
RTCSDK.GetMediaInfoRslt.callback = (sdkErr, CRVideo_MediaInfoObj) => {}
参数 类型 说明
sdkErr number 错误码,详细见错误码定义
CRVideo_MediaInfoObj object 影音文件信息(CRVideo_MediaInfoObj)

NotifyScreenShareStarted

  • 功能: 收到他人开启了屏幕共享的通知
RTCSDK.NotifyScreenShareStarted.callback = (UID) => {}
参数 类型 说明
UID string 开启屏幕共享用户的UID
  • 补充说明:

收到该通知即可渲染媒体拉流组件

NotifyScreenShareStopped

  • 功能: 收到他人停止了屏幕共享的通知
RTCSDK.NotifyScreenShareStopped.callback = (UID) => {}
参数 类型 说明
UID string 关闭屏幕共享用户的UID
  • 补充说明:

收到该通知即可销毁媒体拉流组件

NotifyMediaStart

  • 功能: 收到他人开启了影音共享的通知
RTCSDK.NotifyMediaStart.callback = (UID) => {}
参数 类型 说明
UID string 开启屏幕共享用户的UID
  • 补充说明:

收到该通知即可渲染媒体拉流组件

NotifyMediaPause

  • 功能: 收到他人暂停了影音共享的通知
RTCSDK.NotifyMediaPause.callback = (UID, pause) => {}
参数 类型 说明
UID string 开启屏幕共享用户的UID
pause number 是否暂停 1暂停 0播放

NotifyMediaStop

  • 功能: 收到他人停止了影音共享的通知
RTCSDK.NotifyMediaStop.callback = (UID) => {}
参数 类型 说明
UID string 开启屏幕共享用户的UID
  • 补充说明:

收到该通知即可销毁媒体拉流组件

CreateCloudMixer

  • 功能: 创建云端混图器
  • 返回值: 云端混图器ID
RTCSDK.CreateCloudMixer(cfg)
参数 类型 说明
cfg object 云端混图器配置,参见CloudMixerCfgObj
  • 补充说明:

可以开启多个云端混图器,具体个数和企业购买的授权相关;
开启云端混图器后,房间内所有人都将收到CloudMixerStateChanged通知状态值为1;
云端混图器部署有少量耗时,如果在部署过程遇到异常,将收到CreateCloudMixerFailed回调;
云端混图器启动完成并进入录制或推流状态时,将收到CloudMixerStateChanged通知状态值为2;
开启云端混图器在进入工作中的状态后,可以通过UpdateCloudMixerContent更新内容;
混图器如果在工作中遇到异常而停止时,将收到CloudMixerStateChanged通知,状态值为0,并携带错误原因;

UpdateCloudMixerContent

  • 功能: 更新云端混图器
  • 返回值: 错误码
RTCSDK.UpdateCloudMixerContent(mixerID, cfg)
参数 类型 说明
mixerID string 混图器ID, 参见CreateCloudMixer
cfg object 云端混图器配置,参见CloudMixerCfgObj
  • 补充说明:

更新混图器内容时,只能更新内容和布局,不能更改混图器规格、输出目标;
更新混图器内容时,房间内所有人都将收到CloudMixerInfoChanged通知;

DestroyCloudMixer

  • 功能: 销毁云端混图器
  • 返回值: 无
RTCSDK.DestroyCloudMixer(mixerID)
参数 类型 说明
mixerID string 混图器ID, 参见CreateCloudMixer

GetAllCloudMixerInfo

  • 功能: 得到所有云端混图器信息
  • 返回值: CloudMixerInfo[]
RTCSDK.GetAllCloudMixerInfo()

GetCloudMixerInfo

RTCSDK.GetCloudMixerInfo(mixerID)
参数 类型 说明
mixerID string 混图器ID, 参见CreateCloudMixer

CreateCloudMixerFailed

  • 功能: 创建云端录制/推流失败
RTCSDK.CreateCloudMixerFailed.callback = (mixerID, sdkErr) => {}
参数 类型 说明
mixerID string 混图器ID, 参见CreateCloudMixer
sdkErr number 错误码,详细见错误码定义

CloudMixerStateChanged

  • 功能: 通知云端录制/推流状态变化
RTCSDK.CloudMixerStateChanged.callback = (mixerID, state, exParam, operUserID) => {}
参数 类型 说明
mixerID string 混图器ID, 参见CreateCloudMixer
state number 录制状态。 0:未启动或已结束, 1:正在开启, 2:正在录制
exParam object state为0时,包含err字段(取值为ERR_DEF), errDesc字段;state为2时,内容参见CloudMixerCfgObj
operUserID string 操作者用户ID

CloudMixerInfoChanged

  • 功能: 通知云端录制/推流信息变化
RTCSDK.CloudMixerInfoChanged.callback = (mixerID) => {}
参数 类型 说明
mixerID string 混图器ID, 参见CreateCloudMixer
  • 补充说明:

可调用:GetCloudMixerInfo获取相关信息

CloudMixerEvent

  • 功能: 云端录制/推流事件通知
RTCSDK.CloudMixerEvent.callback = (mixerID, eventType, eventInfoObj) => {}
参数 类型 说明
mixerID string 混图器ID, 参见CreateCloudMixer
eventType number 事件类型,参见CLOUDMIXER_EVENT_TYPE
eventInfoObj CloudMixerEventInfoObj 云端混图器事件信息
  • 补充说明:

请根据eventType不同的取值,cloudMixerEventInfoObj将收到不同的数据格式。

  CRVSDK_EVT_OUTPUT_START(1):输出开始:
参数 类型 含义
outputName string 文件名/推流地址
  CRVSDK_EVT_OUTPUT_END(2):输出结束:
参数 类型 含义
outputName string 文件名/推流地址
startTime number 创建时间(从1970年1月1日00:00:00起的毫秒数)
duration number 录像时长(ms)
size number 文件大小(Byte)
  CRVSDK_EVT_OUTPUT_FAILED(3):输出错误:
参数 类型 含义
outputName string 文件名/推流地址
errCode number 错误码,详细见错误码定义
errDesc string 错误描述
  CRVSDK_EVT_FILE_UPLOADING(4):文件上传中:
参数 类型 含义
outputName string 文件名/推流地址
progress number 上传进度(0~100.0)
  CRVSDK_EVT_FILE_UPLOADED(5):文件上传完成:
参数 类型 含义
outputName string 文件名/推流地址
startTime number 创建时间(从1970年1月1日00:00:00起的毫秒数)
duration number 录像时长(ms)
size number 文件大小(Byte)
  CRVSDK_EVT_FILE_UPLOADFAILED(6):文件上传失败:
参数 类型 含义
outputName string 文件名/推流地址
errCode number 错误码,详细见错误码定义
errDesc string 错误描述
  CRVSDK_EVT_ALLFILE_FINISHED(8):所有文件完成:
参数 类型 含义
allFileState number 录制文件上传整体状态, 0:全部未上传,1:全部上传成功,2:部分上传成功
allFileInfo CloudRecordFileInfo[] 录制文件上传信息列表
  CRVSDK_EVT_NOT_RECV_STREAM(100):未接收到流数据:
参数 类型 含义
eventDesc string 事件描述
outputName string 文件名/推流地址
streamID string 视频设备ID
  CRVSDK_EVT_PUSH_STREAM_FAILED(101):推流失败:
参数 类型 含义
eventDesc string 事件描述
outputName string 文件名/推流地址
  CRVSDK_EVT_MAKE_COVER_FAILED(102):生成封面失败:
参数 类型 含义
eventDesc string 事件描述
  CRVSDK_EVT_NETDISK_FILEALREADYEXISTS(103):录像文件已经上传:
参数 类型 含义
eventDesc string 事件描述
outputName string 文件名/推流地址
  CRVSDK_EVT_MCU_RUN_TIMEOUT(200):录制服务运行超时:
参数 类型 含义
eventDesc string 事件描述
  CRVSDK_EVT_MCU_SHAKEHAND_TIMEOUT(201):录制服务握手超时:
参数 类型 含义
eventDesc string 事件描述