音视频通话

API

模块

实例模式
获取实例
房间外接口
基础函数
登录/注销
透明通道
队列管理
呼叫
邀请
房间管理
房间内接口
进出房间
房间成员管理
房间属性
用户属性
音频管理
视频管理
视频自定义采集
虚拟视频设备
影音共享
屏幕共享
本地录制/本地直播
云端录制/互动直播

获取实例

方式 接口 描述
主调
create 获取实例

基础函数

方式 接口 描述
主调
getVersion 获取SDK版本号
on 注册SDK回调函数
off 销毁SDK回调函数
destroy 销毁SDK实例

登录/注销

方式 接口 描述
主调
setNetworkProxy 设置网络代理
login 登录
logout 登出
updateToken 更新token
getUserAuthErrCode 第三方鉴权错误码获取
getUserAuthErrDesc 第三方鉴权错误原因获取
setDNDStatus 设置免打扰
getUserStatus 获取本AppID下的所有登录用户的状态信息
getOneUserStatus 获取本AppID下指定用户的在线状态
startUserStatusNotify 开启AppID下的用户登录状态消息推送
stopUserStatusNotify 关闭appID下的用户在线状态消息推送
回调
loginRslt 登录结果回调
notifyTokenWillExpire Token即将失效的通知,失效前30秒通知
notifyLineOff 通知本端SDK掉线
setDNDStatusRslt 设置免打扰结果
getUserStatusSuccess 获取用户登录状态信息成功
getUserStatusFail 获取用户登录状态信息失败
notifyUserStatus 通知某用户登录状态变化
startUserStatusNotifyRslt 开启用户状态通知结果
stopUserStatusNotifyRslt 关闭用户状态通知结果

透明通道

方式 接口 描述
主调
sendCmd 发送点对点消息
sendBuffer 发送点对点大数据
sendFile 发送文件
cancelSend 取消大数据、文件的发送
回调
sendCmdRslt 发送点对点消息结果
sendBufferRslt 发送点对点大数据结果
sendFileRslt 发送点对点文件结果
cancelSendRslt 取消发送结果
notifySendProgress 通知大数据、文件的发送进度
notifyCmdData 通知收到点对点透明通道消息
notifyBufferData 通知收到点对点大数据
notifyFileData 通知收到点对点文件

队列管理

方式 接口 描述
主调
initQueueDat 初始化队列功能
getAllQueueInfo 获取AppID下的所有队列基础信息
getQueueStatus 获取指定队列的排队状况
getQueuingInfo 获取我的排队信息
getServingQueues 获取我服务的所有队列
startQueuing 客户开始排队
stopQueuing 客户停止排队
startService 座席开始服务某队列
stopService 座席停止服务某队列
reqAssignUser 座席手动分配下一位客户(开启免打扰后使用)
reqAssignUser2 座席手动分配指定客户(开启免打扰后使用)
acceptAssignUser 接受系统分配的客户
rejectAssignUser 拒绝系统分配的客户
回调
initQueueDatRslt 初始化队列功能结果
notifyQueueStatusChanged 队列排队状态更新
notifyQueuingInfoChanged 我的排队信息更新
startQueuingRslt 客户开始排队结果
stopQueuingRslt 客户停止排队结果
startServiceRslt 座席开始服务结果
stopServiceRslt 座席开始服务结果
acceptAssignUserRslt 接受系统分配的客户结果
rejectAssignUserRslt 拒绝系统分配的客户结果
reqAssignUserRslt 座席手动分配客户结果
notifyAutoAssignUser 座席自动分配客户结果
notifyAssignUserCanceled 通知分配的客户取消了
notifyUserEnterQueue 通知客户进入了某队列
notifyUserLeaveQueue 通知客户离开了某队列

呼叫

方式 接口 描述
主调
call 发起呼叫
acceptCall 接受他人的呼叫
rejectCall 拒接他人的呼叫
hungupCall 挂断通话
callMoreParty 发起多方呼叫(或呼转)
cancelCallMoreParty 取消多方呼叫
回调
callRslt 发起的呼叫结果
acceptCallRslt 接受他人呼叫的结果
rejectCallRslt 拒绝他人呼叫的结果
hangupCallRslt 挂断通话结果
notifyCallIn 通知呼入
notifyCallAccepted 通知呼叫被接受
notifyCallRejected 通知呼叫被拒接
notifyCallHungup 通知呼叫被挂断
callMorePartyRslt 发起多方呼叫结果
cancelCallMorePartyRslt 取消多方呼叫结果
notifyCallMorePartyStatus 通知多方呼叫状态

邀请

方式 接口 描述
主调
invite 邀请他人
acceptInvite 接受邀请
rejectInvite 拒接邀请
cancelInvite 取消邀请
回调
inviteRslt 邀请他人结果
cancelInviteRslt 取消邀请结果
acceptInviteRslt 接受邀请结果
rejectInviteRslt 拒接邀请结果
notifyInviteIn 通知收到邀请
notifyInviteAccepted 通知邀请被接受
notifyInviteRejected 通知邀请被拒接
notifyInviteCanceled 通知邀请被取消

房间管理

方式 接口 描述
主调
createMeeting 创建房间
destroyMeeting 销毁房间
回调
createMeetingSuccess 通知创建房间成功
createMeetingFail 通知创建房间失败
destroyMeetingRslt 销毁房间结果

进出房间

方式 接口 描述
主调
enterMeeting 进入房间
exitMeeting 离开房间
getNetState 获取当前网络状态评分
getNetState2 获取网络状态详细信息
回调
enterMeetingRslt 进入房间结果
notifyMeetingStopped 通知房间已结束
notifyMeetingDropped 与房间断开
notifyNetStateChanged 通知本端与房间服务器的网络状态变化

房间成员管理

方式 接口 描述
主调
isUserInMeeting 检查用户是否在房间中
getAllMembers 获取房间中所有成员信息
getMemberInfo 获取房间中指定成员信息
setNickName 修改房间中成员昵称
kickout 将他人请出房间
sendMeetingCustomMsg 房间内发送广播消息
回调
notifyUserEnterMeeting 通知有人进入房间
notifyUserLeftMeeting 通知有人离会
setNickNameRslt 修改昵称结果
notifyNickNameChanged 通知昵称变化
kickoutRslt 请出房间结果
sendMeetingCustomMsgRslt 发送房间内广播消息结果
notifyMeetingCustomMsg 通知房间内广播消息

房间属性

方式 接口 描述
主调
getMeetingAllAttrs 获取所有房间属性
getMeetingAttrs 获取部份房间属性
setMeetingAttrs 重置所有房间属性
addOrUpdateMeetingAttrs 添加或更新房间属性
delMeetingAttrs 删除房间属性
clearMeetingAttrs 清空所有房间属性
回调
getMeetingAllAttrsSuccess 获取所有房间属性成功
getMeetingAllAttrsFail 获取所有房间属性失败
getMeetingAttrsSuccess 获取部份房间属性成功
getMeetingAttrsFail 获取部份房间属性失败
setMeetingAttrsRslt 重置所有房间属性结果
addOrUpdateMeetingAttrsRslt 添加或更新房间属性结果
delMeetingAttrsRslt 删除房间属性结果
clearMeetingAttrsRslt 清空所有房间属性结果
notifyMeetingAttrsChanged 通知房间属性改变

用户属性

方式 接口 描述
主调
getUserAttrs 获取指定用户的所有属性
setUserAttrs 重置指定用户的属性
addOrUpdateUserAttrs 添加或更新指定用户的属性
delUserAttrs 删除指定用户的属性
clearUserAttrs 清空指定用户的属性
clearAllUserAttrs 清空所有用户的属性
回调
getUserAttrsSuccess 获取指定用户的所有属性成功
getUserAttrsFail 获取指定用户的所有属性失败
setUserAttrsRslt 重置指定用户的属性结果
addOrUpdateUserAttrsRslt 添加或更新指定用户的属性结果
delUserAttrsRslt 删除指定用户的属性结果
clearUserAttrsRslt 清空指定用户的属性结果
clearAllUserAttrsRslt 清空所有用户的属性结果
notifyUserAttrsChanged 通知用户属性改变

音频管理

方式 接口 描述
主调
getAudioMics 获取系统麦克风设备列表
getAudioSpks 获取系统扬声器设备列表
getAudioCfg 获取当前音频配置
setAudioCfg 设置音频参数
getMicVolume 获取麦克风音量
setMicVolume 配置麦克风音量
getSpkVolume 获取扬声器音量
setSpkVolume 配置扬声器音量
getSpeakerMute 获取扬声器静音状态
setSpeakerMute 配置扬声器静音
startEchoTest 开始本地语音环回测试
stopEchoTest 停止本地语音环回测试
isEchoTesting 检查是否在本地语音环回测试
openMic 打开麦克风
closeMic 关闭麦克风
closeAllMic 全体关麦
getMicStatus 获取指定人员的麦克风状态
getLocMicDevEnergy 获取本地麦克风设备能量等级
getUserMicEnergy 获取房间中指定人员麦克风能量等级
getVoiceChangeType 获取目标用户变声类型
setVoiceChange 设置目标用户变声
setAudioSubscribeMode 设置语音订阅模式
setAudioSubscribeListForSeparateMode 设置独立音频订阅名单
回调
notifyAudioDevChanged 通知本地音频设备变化
notifyAudioErr 通知本地音频相关错误
notifyMicStatusChanged 通知房间中有人麦克风状态变化
notifyMicEnergy 通知房间有人麦克风能量变化
notifySetVoiceChange 通知房间中有人变声状态变化
notifyCloseAllMic 通知有人发起了全体关麦操作

视频管理

方式 接口 描述
主调
addCanvas 订阅绘制视图画面
rmCanvas 取消订阅绘制视图画面
getAllVideoInfo 获取指定成员的所有摄像头信息
getVideoCfg 获取本地视频全局配置
setVideoCfg 设置本地视频全局配置
openVideo 打开指定人的摄像头
closeVideo 关闭指定人的摄像头
getVideoStatus 获取房间中指定成员的视频状态
setDefaultVideo 配置默认摄像头
getDefaultVideo 获取默认摄像头
setMutiVideos 配置本地多摄像头
getMutiVideos 获取本地的或他人的多摄像头列表
setLocVideoAttributes 设置本地指定设备私有配置
getLocVideoAttributes 获取本地指定设备私有配置
setVideoEffects 配置视频效果参数
getVideoEffects 获取视频效果参数
回调
notifyVideoDevChanged 通知房间中用户视频设备变化
notifyDefaultVideoChanged 通知用户默认视频设备变化
openVideoDevRslt 本地视频设备打开结果
notifyVideoStatusChanged 通知用户视频状态变化

视频自定义采集

方式 接口 描述
主调
createCustomVideoDev 创建自定义摄像头
destroyCustomVideoDev 销毁自定义摄像头
inputCustomVideoDat 送入自定义摄像头数据

虚拟视频设备

方式 接口 描述
主调
addIPCam 添加网络摄像头
delIPCam 删除网络摄像头

影音共享

方式 接口 描述
主调
setMediaCfg 设置影音共享配置
getMediaCfg 获取影音共享配置
startPlayMedia 开始影音共享
pausePlayMedia 暂停影音共享
stopPlayMedia 停止影音共享
setMediaPlayPos 设置播放位置
getMediaInfo 获取当前影音共享信息
getMediaStreamInfo 获取当前影音共享流信息
setMediaVolume 配置影音播放音量
getMediaVolume 获取影音播放音量
回调
startPlayMediaFail 影音共享开启失败
notifyMediaStart 通知影音共享开启
notifyMediaOpened 本地影音共享文件打开成功通知
notifyMediaStop 通知影音共享停止
notifyMediaPause 通知影音共享暂停

屏幕共享

方式 接口 描述
主调
setScreenShareCfg 设置屏幕共享配置
getScreenShareCfg 获取屏幕共享配置
getScreenShareInfo 获取屏幕共享信息
startScreenShare 开始屏幕共享
stopScreenShare 停止屏幕共享
pauseScreenShare 暂停共享
回调
startScreenShareRslt 开启屏幕共享结果
stopScreenShareRslt 停止屏幕共享结果
notifyScreenShareStarted 通知屏幕共享开始
notifyScreenShareStopped 通知屏幕共享停止

本地录制/本地直播

方式 接口 描述
主调
createLocMixer 创建本地混图器
updateLocMixerContent 更新本地混图器内容
destroyLocMixer 销毁本地混图器
getLocMixerState 获取本地混图器状态
addLocMixerOutput 开启本地录制、开启直播推流
rmLocMixerOutput 停止本地录制、直播推流
setPicResource 配置图片资源(设置空的帧代表移除)
回调
notifyLocMixerStateChanged 本地混图器状态变化通知
notifyLocMixerOutputInfo 本地录制文件、本地直播信息通知

云端录制/互动直播

方式 接口 描述
主调
createCloudMixer 创建云端混图器
updateCloudMixerContent 更新云端混图器
destroyCloudMixer 销毁云端混图器
getCloudMixerInfo 获取云端混图器信息
getAllCloudMixerInfo 获取所有云端混图器
回调
createCloudMixerFailed 通知创建云端录制/推流失败
notifyCloudMixerInfoChanged 通知云端录制/推流信息变化
notifyCloudMixerStateChanged 通知云端录制/推流状态变化
notifyCloudMixerEvent 通知云端录制/推流事件

接口详情

create

  • 功能: 获取实例
  • 返回值: SDK实例
CRVideoSDKEx.create(sdkDatSavePath, jsonParam)
参数 类型 说明
sdkDatSavePath string SDK工作目录,用于存储配置文件、临时文件、日志等文件;
jsonParam string 扩展参数,JSON格式,参见CRSDKCreateParams
  • 补充说明:

参见示例代码

getVersion

  • 功能: 获取SDK版本号
  • 返回值: SDK版本号(String)
sdk_engine.getVersion()

on

  • 功能: 注册SDK回调函数
  • 返回值: 无
sdk_engine.on(event, fn)
参数 类型 说明
event string 事件名称,例如:loginRslt
fn function 回调函数,参数见各回调函数说明
  • 补充说明:

示例参见初始化SDK

off

  • 功能: 销毁SDK回调函数
  • 返回值: 无
sdk_engine.off(event, fn)
参数 类型 说明
event string 事件名称,例如:loginRslt
fn function 注销时必须传入函数的引用地址
  • 补充说明:

示例参见初始化SDK

destroy

  • 功能: 销毁SDK实例
  • 返回值: 无
sdk_engine.destroy()

setNetworkProxy

  • 功能: 设置网络代理
  • 返回值: 无
sdk_engine.setNetworkProxy(proxy)
参数 类型 说明
proxy string 网络代理,json格式,参见CRNetworkProxy

login

  • 功能: 登录
  • 返回值: 无
sdk_engine.login(CRLoginDat, cookie)
参数 类型 说明
CRLoginDat object 登录配置
cookie string 详细介绍见cookie
  • 补充说明:

登录结果参见loginRslt

logout

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

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

updateToken

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

更新Token, 防止token因过期而掉线。
Token即将到期前30秒左右,将收到通知:notifyTokenWillExpire
Token过期后,将引发掉线notifyLineOff,码值为18

getUserAuthErrCode

  • 功能: 第三方鉴权错误码获取
  • 返回值: 错误码,值含义第三方鉴权方提供
sdk_engine.getUserAuthErrCode()

getUserAuthErrDesc

  • 功能: 第三方鉴权错误原因获取
  • 返回值: string,值由第三方鉴权方自由定义。
sdk_engine.getUserAuthErrDesc()

setDNDStatus

  • 功能: 开关免打扰
  • 返回值: 无
sdk_engine.setDNDStatus(DNDStatus, cookie)
参数 类型 说明
DNDStatus number 0代表关闭免打扰, 其它值代表开启免打扰,含义自由定义
cookie string 详细介绍见cookie
  • 补充说明:

设置结果请参见setDNDStatusRslt;
开启免打扰后,他人呼叫本人时,系统自动回绝呼叫,错误码原因为602;
开启免打扰后,系统将不再自动为座席分配客户notifyAutoAssignUser,座席可以调用reqAssignUser来手动分配客户(叫号模式);

getUserStatus

  • 功能: 获取本AppID下的所有登录用户的状态信息
  • 返回值: 无
sdk_engine.getUserStatus(cookie)
参数 类型 说明
cookie string 详细介绍见cookie
  • 补充说明:

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

getOneUserStatus

  • 功能: 获取本AppID下指定用户的在线状态
  • 返回值: 无
sdk_engine.getOneUserStatus(userID, cookie)
参数 类型 说明
userID string 用户ID, 详细介绍见关键词
cookie string 详细介绍见cookie
  • 补充说明:

结果请参见getUserStatusSuccess / getUserStatusFail

startUserStatusNotify

  • 功能: 开启AppID下的用户登录状态消息推送
  • 返回值: 无
sdk_engine.startUserStatusNotify(cookie)
参数 类型 说明
cookie string 详细介绍见cookie
  • 补充说明:

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

stopUserStatusNotify

  • 功能: 关闭appID下的用户在线状态消息推送
  • 返回值: 无
sdk_engine.stopUserStatusNotify(cookie)
参数 类型 说明
cookie string 详细介绍见cookie
  • 补充说明:

结果请参见stopUserStatusNotifyRslt

loginRslt

  • 功能: 登录结果回调
sdk_engine.on("loginRslt", (sdkErr, cookie) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

notifyTokenWillExpire

  • 功能: Token即将失效的通知,失效前30秒通知
sdk_engine.on("notifyTokenWillExpire", () => {})
  • 补充说明:

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

notifyLineOff

  • 功能: 通知本端SDK掉线
sdk_engine.on("notifyLineOff", (sdkErr) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
  • 补充说明:

掉线的原因参见错误码;
掉线时,如果正在房间中也将自动离开房间;
掉线时,之前的所有未完成的请求都将失败;
掉线之后,可以按业务需求稍后重新登录;

setDNDStatusRslt

  • 功能: 设置免打扰结果
sdk_engine.on("setDNDStatusRslt", (sdkErr, cookie) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

getUserStatusSuccess

  • 功能: 获取用户登录状态信息成功
sdk_engine.on("getUserStatusSuccess", (ustArray, cookie) => {})
参数 类型 说明
ustArray Array<CRUserStatus> 用户登录状态信息的数组形式
cookie string 详细介绍见cookie

getUserStatusFail

  • 功能: 获取用户登录状态信息失败
sdk_engine.on("getUserStatusFail", (sdkErr, cookie) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

notifyUserStatus

  • 功能: 通知某用户登录状态变化
sdk_engine.on("notifyUserStatus", (userStatus) => {})
参数 类型 说明
userStatus CRUserStatus 用户登录状态信息
  • 补充说明:

只在startUserStatusNotify后,才会收到变化通知;

startUserStatusNotifyRslt

  • 功能: 开启用户状态通知结果
sdk_engine.on("startUserStatusNotifyRslt", (sdkErr, cookie) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

stopUserStatusNotifyRslt

  • 功能: 关闭用户状态通知结果
sdk_engine.on("stopUserStatusNotifyRslt", (sdkErr, cookie) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

sendCmd

  • 功能: 发送点对点消息
  • 返回值: 任务ID(String)
sdk_engine.sendCmd(targetUserId, data, cookie)
参数 类型 说明
targetUserId string 目标用户ID, 参见CRLoginDat的userID字段
data string 发送的数据(最大64KB)
cookie string 详细介绍见cookie
  • 补充说明:

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

sendBuffer

  • 功能: 发送点对点大数据
  • 返回值: 任务ID(String)
sdk_engine.sendBuffer(targetUserId, data, cookie)
参数 类型 说明
targetUserId string 目标用户ID, 参见CRLoginDat的userID字段
data Uint8Array 发送的数据(最大100MB)
cookie string 详细介绍见cookie
  • 补充说明:

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

sendFile

  • 功能: 发送文件
  • 返回值: 任务ID(String)
sdk_engine.sendFile(targetUserId, fileName, cookie)
参数 类型 说明
targetUserId string 目标用户ID, 参见CRLoginDat的userID字段
fileName string 本地完整路径的文件名(文件内容最大100MB)
cookie string 详细介绍见cookie
  • 补充说明:

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

cancelSend

  • 功能: 取消大数据、文件的发送
  • 返回值: 无
sdk_engine.cancelSend(taskId, cookie)
参数 类型 说明
taskId string 任务ID,sendBuffer、sendFile的返回值
cookie string 详细介绍见cookie

sendCmdRslt

  • 功能: 发送点对点消息结果
sdk_engine.on("sendCmdRslt", (taskId, sdkErr, cookie) => {})
参数 类型 说明
taskId string 任务ID,sendCmd的返回值
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

sendBufferRslt

  • 功能: 发送点对点大数据结果
sdk_engine.on("sendBufferRslt", (taskId, sdkErr, cookie) => {})
参数 类型 说明
taskId string 任务ID,sendBuffer的返回值
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

sendFileRslt

  • 功能: 发送点对点文件结果
sdk_engine.on("sendFileRslt", (taskId, fileName, sdkErr, cookie) => {})
参数 类型 说明
taskId string 任务ID,sendFile的返回值
fileName string 本地完整路径的文件名(文件内容最大100MB)
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

cancelSendRslt

  • 功能: 取消发送结果
sdk_engine.on("cancelSendRslt", (taskId, sdkErr, cookie) => {})
参数 类型 说明
taskId string 任务ID,sendBuffer、sendFile的返回值
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

notifySendProgress

  • 功能: 通知大数据、文件的发送进度
sdk_engine.on("notifySendProgress", (taskId, sendedLen, totalLen, cookie) => {})
参数 类型 说明
taskId string 任务ID,sendBuffer、sendFile的返回值
sendedLen number 已发送大小
totalLen number 总大小
cookie string 详细介绍见cookie

notifyCmdData

  • 功能: 通知收到点对点透明通道消息
sdk_engine.on("notifyCmdData", (sourceUserId, data) => {})
参数 类型 说明
sourceUserId string 发送者UserID, 参见CRLoginDat的userID字段
data string 消息内容

notifyBufferData

  • 功能: 通知收到点对点大数据
sdk_engine.on("notifyBufferData", (sourceUserId, data) => {})
参数 类型 说明
sourceUserId string 发送者UserID, 参见CRLoginDat的userID字段
data string 消息内容

notifyFileData

  • 功能: 通知收到点对点文件
sdk_engine.on("notifyFileData", (sourceUserId, tmpFile, orgFileName) => {})
参数 类型 说明
sourceUserId string 发送者UserID, 参见CRLoginDat的userID字段
tmpFile string 本地完整路径文件名(接收到的文件存放在系统Tmp目录下)
orgFileName string 原始文件名(不包含路径)

initQueueDat

  • 功能: 初始化队列功能
  • 返回值: 无
sdk_engine.initQueueDat(cookie)
参数 类型 说明
cookie string 详细介绍见cookie
  • 补充说明:

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

getAllQueueInfo

  • 功能: 获取AppID下的所有队列基础信息
  • 返回值: Array<CRQueInfo>,队列基础信息数组
sdk_engine.getAllQueueInfo()

getQueueStatus

  • 功能: 获取指定队列的排队状况
  • 返回值: CRQueStatus,队列状态
sdk_engine.getQueueStatus(queID)
参数 类型 说明
queID number 队列ID

getQueuingInfo

  • 功能: 获取我的排队信息
  • 返回值: CRQueuingInfo,我的排队信息
sdk_engine.getQueuingInfo()

getServingQueues

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

startQueuing

  • 功能: 客户开始排队
  • 返回值: 无
sdk_engine.startQueuing(queID, usrExtDat, cookie)
参数 类型 说明
queID number 队列ID
usrExtDat string 自定义扩展参数,对端将收到此参数
cookie string 详细介绍见cookie
  • 补充说明:

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

stopQueuing

  • 功能: 客户停止排队
  • 返回值: 无
sdk_engine.stopQueuing(cookie)
参数 类型 说明
cookie string 详细介绍见cookie
  • 补充说明:

排队结果请参见stopQueuingRslt;

startService

  • 功能: 座席开始服务某队列
  • 返回值: 无
sdk_engine.startService(queID, priority, cookie)
参数 类型 说明
queID number 队列ID
priority number 坐席优先级 (缺省为0,取值为0~1000内整数。值越小优先级越高。0为最高优先级)
cookie string 详细介绍见cookie
  • 补充说明:

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

stopService

  • 功能: 座席停止服务某队列
  • 返回值: 无
sdk_engine.stopService(queID, cookie)
参数 类型 说明
queID number 队列ID
cookie string 详细介绍见cookie
  • 补充说明:

停止服务结果请参见stopServiceRslt;

reqAssignUser

  • 功能: 座席手动分配下一位客户(开启免打扰后使用)
  • 返回值: 无
sdk_engine.reqAssignUser(cookie)
参数 类型 说明
cookie string 详细介绍见cookie
  • 补充说明:

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

reqAssignUser2

  • 功能: 座席手动分配指定客户(开启免打扰后使用)
  • 返回值: 无
sdk_engine.reqAssignUser2(queID, userID, cookie)
参数 类型 说明
queID number 队列ID
userID string 请求分配指定用户
cookie string 详细介绍见cookie
  • 补充说明:

开启免打扰后手动分配客户接口;(当关闭免打扰时,系统将自动分配客户)
可以要求分配指定队列、指定客户,满足客户分配给历史座席类的需求;
分配结果请参见reqAssignUserRslt ;

acceptAssignUser

  • 功能: 接受系统分配的客户
  • 返回值: 无
sdk_engine.acceptAssignUser(queID, userID, cookie)
参数 类型 说明
queID number 队列ID
userID string 用户ID, 详细介绍见关键词
cookie string 详细介绍见cookie
  • 补充说明:

结果请参见acceptAssignUserRslt

rejectAssignUser

  • 功能: 拒绝系统分配的客户
  • 返回值: 无
sdk_engine.rejectAssignUser(queID, userID, cookie)
参数 类型 说明
queID number 队列ID
userID string 用户ID, 详细介绍见关键词
cookie string 详细介绍见cookie
  • 补充说明:

结果请参见rejectAssignUserRslt

initQueueDatRslt

  • 功能: 初始化队列功能结果
sdk_engine.on("initQueueDatRslt", (sdkErr, cookie) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

notifyQueueStatusChanged

  • 功能: 队列排队状态更新
sdk_engine.on("notifyQueueStatusChanged", (queStatus) => {})
参数 类型 说明
queStatus CRQueStatus 队列排队状态信息

notifyQueuingInfoChanged

  • 功能: 我的排队信息更新
sdk_engine.on("notifyQueuingInfoChanged", (queuingInfo) => {})
参数 类型 说明
queuingInfo CRQueuingInfo 我的排队信息

startQueuingRslt

  • 功能: 客户开始排队结果
sdk_engine.on("startQueuingRslt", (sdkErr, cookie) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

stopQueuingRslt

  • 功能: 客户停止排队结果
sdk_engine.on("stopQueuingRslt", (sdkErr, cookie) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

startServiceRslt

  • 功能: 座席开始服务结果
sdk_engine.on("startServiceRslt", (queID, sdkErr, cookie) => {})
参数 类型 说明
queID number 队列ID
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

stopServiceRslt

  • 功能: 座席开始服务结果
sdk_engine.on("stopServiceRslt", (queID, sdkErr, cookie) => {})
参数 类型 说明
queID number 队列ID
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

acceptAssignUserRslt

  • 功能: 接受系统分配的客户结果
sdk_engine.on("acceptAssignUserRslt", (sdkErr, cookie) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

rejectAssignUserRslt

  • 功能: 拒绝系统分配的客户结果
sdk_engine.on("rejectAssignUserRslt", (sdkErr, cookie) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

reqAssignUserRslt

  • 功能: 座席手动分配客户结果
sdk_engine.on("reqAssignUserRslt", (sdkErr, queUserInfo, cookie) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
queUserInfo CRQueUserInfo 队列用户信息
cookie string 详细介绍见cookie

notifyAutoAssignUser

  • 功能: 座席自动分配客户结果
sdk_engine.on("notifyAutoAssignUser", (queUserInfo) => {})
参数 类型 说明
queUserInfo CRQueUserInfo 队列用户信息
  • 补充说明:

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

notifyAssignUserCanceled

  • 功能: 通知分配的客户取消了
sdk_engine.on("notifyAssignUserCanceled", (queID, userID) => {})
参数 类型 说明
queID number 队列ID
userID string 用户ID, 详细介绍见关键词
  • 补充说明:

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

notifyUserEnterQueue

  • 功能: 通知客户进入了某队列
sdk_engine.on("notifyUserEnterQueue", (queID, queUserInfo) => {})
参数 类型 说明
queID number 队列ID
queUserInfo CRQueUserInfo 队列用户信息
  • 补充说明:

只有座席服务的队列,才会收到此通知。

notifyUserLeaveQueue

  • 功能: 通知客户离开了某队列
sdk_engine.on("notifyUserLeaveQueue", (queID, queUserInfo, reason) => {})
参数 类型 说明
queID number 队列ID
queUserInfo CRQueUserInfo 队列用户信息
reason CRVSDK_LEFT_QUEUE_REASON 原因值
  • 补充说明:

只有座席服务的队列,才会收到此通知。

call

  • 功能: 发起呼叫
  • 返回值: 呼叫ID(String)
sdk_engine.call(calledUserID, meetID, usrExtDat, cookie)
参数 类型 说明
calledUserID string 被叫用户ID
meetID number 房间号
usrExtDat string 自定义扩展参数,对端将收到此参数
cookie string 详细介绍见cookie
  • 补充说明:

发起的呼叫结果参见callRslt;
呼叫时,对方迟迟不acceptCall / rejectCall,30秒后将超时而自动结束呼叫;

acceptCall

  • 功能: 接受他人的呼叫
  • 返回值: 无
sdk_engine.acceptCall(callID, meetID, usrExtDat, cookie)
参数 类型 说明
callID string 呼叫ID, 参见call / callMoreParty / notifyCallIn接口
meetID number 房间号
usrExtDat string 自定义扩展参数,对端将收到此参数
cookie string 详细介绍见cookie
  • 补充说明:

接受结果参见acceptCallRslt;

rejectCall

  • 功能: 拒接他人的呼叫
  • 返回值: 无
sdk_engine.rejectCall(callID, usrExtDat, cookie)
参数 类型 说明
callID string 呼叫ID, 参见call / callMoreParty / notifyCallIn接口
usrExtDat string 自定义扩展参数,对端将收到此参数
cookie string 详细介绍见cookie
  • 补充说明:

拒绝结果参见rejectCallRslt;

hungupCall

  • 功能: 挂断通话
  • 返回值: 无
sdk_engine.hungupCall(callID, usrExtDat, cookie)
参数 类型 说明
callID string 呼叫ID, 参见call / callMoreParty / notifyCallIn接口
usrExtDat string 自定义扩展参数,对端将收到此参数
cookie string 详细介绍见cookie
  • 补充说明:

挂断结果参见hangupCallRslt;

callMoreParty

  • 功能: 发起多方呼叫(或呼转)
  • 返回值: 呼叫ID(String)
sdk_engine.callMoreParty(calledUserID, meetID, usrExtDat, cookie)
参数 类型 说明
calledUserID string 被叫用户ID
meetID number 房间号
usrExtDat string 自定义扩展参数,对端将收到此参数
cookie string 详细介绍见cookie
  • 补充说明:

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

cancelCallMoreParty

  • 功能: 取消多方呼叫
  • 返回值: 无
sdk_engine.cancelCallMoreParty(callID, usrExtDat, cookie)
参数 类型 说明
callID string 呼叫ID, 参见call / callMoreParty / notifyCallIn接口
usrExtDat string 自定义扩展参数,对端将收到此参数
cookie string 详细介绍见cookie
  • 补充说明:

取消结果参见cancelCallMorePartyRslt;

callRslt

  • 功能: 发起的呼叫结果
sdk_engine.on("callRslt", (callID, sdkErr, cookie) => {})
参数 类型 说明
callID string 呼叫ID, 参见call / callMoreParty / notifyCallIn接口
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

acceptCallRslt

  • 功能: 接受他人呼叫的结果
sdk_engine.on("acceptCallRslt", (callID, sdkErr, cookie) => {})
参数 类型 说明
callID string 呼叫ID, 参见call / callMoreParty / notifyCallIn接口
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

rejectCallRslt

  • 功能: 拒绝他人呼叫的结果
sdk_engine.on("rejectCallRslt", (callID, sdkErr, cookie) => {})
参数 类型 说明
callID string 呼叫ID, 参见call / callMoreParty / notifyCallIn接口
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

hangupCallRslt

  • 功能: 挂断通话结果
sdk_engine.on("hangupCallRslt", (callID, sdkErr, cookie) => {})
参数 类型 说明
callID string 呼叫ID, 参见call / callMoreParty / notifyCallIn接口
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

notifyCallIn

  • 功能: 通知呼入
sdk_engine.on("notifyCallIn", (callID, meetID, callerID, usrExtDat) => {})
参数 类型 说明
callID string 呼叫ID, 参见call / callMoreParty / notifyCallIn接口
meetID number 房间号
callerID string 主叫用户ID
usrExtDat string 自定义扩展参数,对端将收到此参数

notifyCallAccepted

  • 功能: 通知呼叫被接受
sdk_engine.on("notifyCallAccepted", (callID, meetID, usrExtDat) => {})
参数 类型 说明
callID string 呼叫ID, 参见call / callMoreParty / notifyCallIn接口
meetID number 房间号
usrExtDat string 自定义扩展参数,对端将收到此参数

notifyCallRejected

  • 功能: 通知呼叫被拒接
sdk_engine.on("notifyCallRejected", (callID, sdkErr, usrExtDat) => {})
参数 类型 说明
callID string 呼叫ID, 参见call / callMoreParty / notifyCallIn接口
sdkErr CRVSDK_ERR_DEF 错误码
usrExtDat string 自定义扩展参数,对端将收到此参数

notifyCallHungup

  • 功能: 通知呼叫被挂断
sdk_engine.on("notifyCallHungup", (callID, usrExtDat) => {})
参数 类型 说明
callID string 呼叫ID, 参见call / callMoreParty / notifyCallIn接口
usrExtDat string 自定义扩展参数,对端将收到此参数

callMorePartyRslt

  • 功能: 发起多方呼叫结果
sdk_engine.on("callMorePartyRslt", (callID, sdkErr, cookie) => {})
参数 类型 说明
callID string 呼叫ID, 参见call / callMoreParty / notifyCallIn接口
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

cancelCallMorePartyRslt

  • 功能: 取消多方呼叫结果
sdk_engine.on("cancelCallMorePartyRslt", (callID, sdkErr, cookie) => {})
参数 类型 说明
callID string 呼叫ID, 参见call / callMoreParty / notifyCallIn接口
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

notifyCallMorePartyStatus

  • 功能: 通知多方呼叫状态
sdk_engine.on("notifyCallMorePartyStatus", (callID, status) => {})
参数 类型 说明
callID string 呼叫ID, 参见call / callMoreParty / notifyCallIn接口
status number 多方呼叫状态,参见CRVSDK_CALLMORE_STATE

invite

  • 功能: 邀请他人
  • 返回值: 邀请ID(String)
sdk_engine.invite(invitedUserID, usrExtDat, cookie)
参数 类型 说明
invitedUserID string 受邀者用户ID
usrExtDat string 自定义扩展参数,对端将收到此参数
cookie string 详细介绍见cookie
  • 补充说明:

邀请结果参见inviteRslt;
如果邀请监控设备进入房间, usrExtDat必须为:
{"meeting":{"ID":会议号}, "devInfo":{"userID":"会议中用户ID", "nickName":"会议中用户昵称"}};

acceptInvite

  • 功能: 接受邀请
  • 返回值: 无
sdk_engine.acceptInvite(inviteID, usrExtDat, cookie)
参数 类型 说明
inviteID string 邀请ID
usrExtDat string 自定义扩展参数,对端将收到此参数
cookie string 详细介绍见cookie
  • 补充说明:

接受结果参见acceptInviteRslt;

rejectInvite

  • 功能: 拒接邀请
  • 返回值: 无
sdk_engine.rejectInvite(inviteID, usrExtDat, cookie)
参数 类型 说明
inviteID string 邀请ID
usrExtDat string 自定义扩展参数,对端将收到此参数
cookie string 详细介绍见cookie
  • 补充说明:

接受结果参见rejectInviteRslt;

cancelInvite

  • 功能: 取消邀请
  • 返回值: 无
sdk_engine.cancelInvite(inviteID, usrExtDat, cookie)
参数 类型 说明
inviteID string 邀请ID
usrExtDat string 自定义扩展参数,对端将收到此参数
cookie string 详细介绍见cookie
  • 补充说明:

取消结果参见cancelInviteRslt;

inviteRslt

  • 功能: 邀请他人结果
sdk_engine.on("inviteRslt", (inviteID, sdkErr, cookie) => {})
参数 类型 说明
inviteID string 邀请ID
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

cancelInviteRslt

  • 功能: 取消邀请结果
sdk_engine.on("cancelInviteRslt", (inviteID, sdkErr, cookie) => {})
参数 类型 说明
inviteID string 邀请ID
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

acceptInviteRslt

  • 功能: 接受邀请结果
sdk_engine.on("acceptInviteRslt", (inviteID, sdkErr, cookie) => {})
参数 类型 说明
inviteID string 邀请ID
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

rejectInviteRslt

  • 功能: 拒接邀请结果
sdk_engine.on("rejectInviteRslt", (inviteID, sdkErr, cookie) => {})
参数 类型 说明
inviteID string 邀请ID
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

notifyInviteIn

  • 功能: 通知收到邀请
sdk_engine.on("notifyInviteIn", (inviteID, invitedUserID, usrExtDat) => {})
参数 类型 说明
inviteID string 邀请ID
invitedUserID string 邀请人ID
usrExtDat string 自定义扩展参数,对端将收到此参数

notifyInviteAccepted

  • 功能: 通知邀请被接受
sdk_engine.on("notifyInviteAccepted", (inviteID, usrExtDat) => {})
参数 类型 说明
inviteID string 邀请ID
usrExtDat string 自定义扩展参数,对端将收到此参数

notifyInviteRejected

  • 功能: 通知邀请被拒接
sdk_engine.on("notifyInviteRejected", (inviteID, sdkErr, usrExtDat) => {})
参数 类型 说明
inviteID string 邀请ID
sdkErr CRVSDK_ERR_DEF 错误码
usrExtDat string 自定义扩展参数,对端将收到此参数

notifyInviteCanceled

  • 功能: 通知邀请被取消
sdk_engine.on("notifyInviteCanceled", (inviteID, sdkErr, usrExtDat) => {})
参数 类型 说明
inviteID string 邀请ID
sdkErr CRVSDK_ERR_DEF 错误码
usrExtDat string 自定义扩展参数,对端将收到此参数

createMeeting

  • 功能: 创建房间
  • 返回值: 无
sdk_engine.createMeeting(undefined, cookie)
参数 类型 说明
undefined undefined 保留参数,参入undefined即可,非必填
cookie string 详细介绍见cookie
  • 补充说明:

创建结果参见createMeetingSuccess / createMeetingFail;
房间创建后,此房间ID将一直存在,直到调用destroyMeeting销毁它;
没有人使用房间时,系统会在一定时间后释放资源,并在下次使用是再临时分配,房间ID是保持不变的;

destroyMeeting

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

创建结果参见destroyMeetingRslt
房间被销毁后,房间中的其他人将收到notifyMeetingStopped

createMeetingSuccess

  • 功能: 通知创建房间成功
sdk_engine.on("createMeetingSuccess", (meetID, cookie) => {})
参数 类型 说明
meetID number 房间号
cookie string 详细介绍见cookie

createMeetingFail

  • 功能: 通知创建房间失败
sdk_engine.on("createMeetingFail", (sdkErr, cookie) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

destroyMeetingRslt

  • 功能: 销毁房间结果
sdk_engine.on("destroyMeetingRslt", (sdkErr, cookie) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

enterMeeting

  • 功能: 进入房间
  • 返回值: 无
sdk_engine.enterMeeting(meetID)
参数 类型 说明
meetID number 房间号
  • 补充说明:

进入房间结果:enterMeetingRslt
进入房间成功时,房间中其他人员将收到通知:notifyUserEnterMeeting

exitMeeting

  • 功能: 离开房间
  • 返回值: 无
sdk_engine.exitMeeting()
  • 补充说明:

离开房间不需要等待服务器响应(网络不好,或网络断开时不会影响离开房间),调用之后即代表离开房间了;
离开房间后,不会再收房间中任何消息;
离开房间时,如果网络正常,房间中其他人会立即收到notifyUserLeftMeeting通知,如果网络不正常,服务器会在sdk内部握手超时后发出notifyUserLeftMeeting通知;
需要销毁房间,请参见destroyMeeting;

getNetState

  • 功能: 获取当前网络状态评分
  • 返回值: number,当前网络状态(0~10,10为最佳网络)
sdk_engine.getNetState()

getNetState2

sdk_engine.getNetState2()

enterMeetingRslt

  • 功能: 进入房间结果
sdk_engine.on("enterMeetingRslt", (sdkErr) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码

notifyMeetingStopped

  • 功能: 通知房间已结束
sdk_engine.on("notifyMeetingStopped", () => {})

notifyMeetingDropped

  • 功能: 与房间断开
sdk_engine.on("notifyMeetingDropped", (reason) => {})
参数 类型 说明
reason CRVSDK_MEETING_DROPPED_REASON 断开原因。

notifyNetStateChanged

  • 功能: 通知本端与房间服务器的网络状态变化
sdk_engine.on("notifyNetStateChanged", (level) => {})
参数 类型 说明
level number 网络评分0~10(10分为最佳网络)

isUserInMeeting

  • 功能: 检查用户是否在房间中
  • 返回值: true:在房间中, false:不在房间中
sdk_engine.isUserInMeeting(userID)
参数 类型 说明
userID string 用户ID, 详细介绍见关键词

getAllMembers

  • 功能: 获取房间中所有成员信息
  • 返回值: 成员信息数组(Array<CRMeetingMember>)
sdk_engine.getAllMembers()

getMemberInfo

  • 功能: 获取房间中指定成员信息
  • 返回值: 成员信息(CRMeetingMember)
sdk_engine.getMemberInfo(userID)
参数 类型 说明
userID string 用户ID, 详细介绍见关键词

setNickName

  • 功能: 修改房间中成员昵称
  • 返回值: 无
sdk_engine.setNickName(userID, nickName)
参数 类型 说明
userID string 用户ID, 详细介绍见关键词
nickName string 用户新的昵称
  • 补充说明:

设置结果请参见setNickNameRslt
调用此接口如果设置成功,其他房间内用户会收到notifyNickNameChanged通知

kickout

  • 功能: 将他人请出房间
  • 返回值: 无
sdk_engine.kickout(userID)
参数 类型 说明
userID string 用户ID, 详细介绍见关键词
  • 补充说明:

请出结果请参见kickoutRslt;
被请出人将收到notifyMeetingDropped通知,原因值是:CRVSDK_DROPPED_KICKOUT;
房间中剩余人员(包括操作者)将收到notifyUserLeftMeeting通知;

sendMeetingCustomMsg

  • 功能: 房间内发送广播消息
  • 返回值: 无
sdk_engine.sendMeetingCustomMsg(msg, cookie)
参数 类型 说明
msg string 自定义消息内容,最大8KB字节
cookie string 详细介绍见cookie
  • 补充说明:

发送结果请参见sendMeetingCustomMsgRslt;
只有当前在房间内的人员才能收到此消息;

notifyUserEnterMeeting

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

notifyUserLeftMeeting

  • 功能: 通知有人离会
sdk_engine.on("notifyUserLeftMeeting", (userID) => {})
参数 类型 说明
userID string 用户ID, 详细介绍见关键词

setNickNameRslt

  • 功能: 修改昵称结果
sdk_engine.on("setNickNameRslt", (userID, sdkErr) => {})
参数 类型 说明
userID string 用户ID, 详细介绍见关键词
sdkErr CRVSDK_ERR_DEF 错误码

notifyNickNameChanged

  • 功能: 通知昵称变化
sdk_engine.on("notifyNickNameChanged", (userID, oldName, newName, operatorID) => {})
参数 类型 说明
userID string 用户ID, 详细介绍见关键词
oldName string 旧昵称
newName string 新昵称
operatorID string 操作者的用户ID

kickoutRslt

  • 功能: 请出房间结果
sdk_engine.on("kickoutRslt", (userID, sdkErr) => {})
参数 类型 说明
userID string 用户ID, 详细介绍见关键词
sdkErr CRVSDK_ERR_DEF 错误码

sendMeetingCustomMsgRslt

  • 功能: 发送房间内广播消息结果
sdk_engine.on("sendMeetingCustomMsgRslt", (sdkErr, cookie) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

notifyMeetingCustomMsg

  • 功能: 通知房间内广播消息
sdk_engine.on("notifyMeetingCustomMsg", (fromUserID, msg) => {})
参数 类型 说明
fromUserID string 发送者用户ID
msg string 自定义消息内容

getMeetingAllAttrs

  • 功能: 获取所有房间属性
  • 返回值: 无
sdk_engine.getMeetingAllAttrs(cookie)
参数 类型 说明
cookie string 详细介绍见cookie
  • 补充说明:

获取结果请参见:getMeetingAllAttrsSuccess 或 getMeetingAllAttrsFail

getMeetingAttrs

  • 功能: 获取部份房间属性
  • 返回值: 无
sdk_engine.getMeetingAttrs(jsonKeys, cookie)
参数 类型 说明
jsonKeys string 需要查询的房间属性key,json格式,如:["key1", "key2"]
cookie string 详细介绍见cookie
  • 补充说明:

获取结果请参见:getMeetingAttrsSuccess 或 getMeetingAttrsFail

setMeetingAttrs

  • 功能: 重置所有房间属性
  • 返回值: 无
sdk_engine.setMeetingAttrs(jsonAttrs, options, cookie)
参数 类型 说明
jsonAttrs string 房间属性集,json格式,如:{"key1":"value1", "key2":"value2"} (key最大长度为64B,value最大长度为8KB)
options string 操作选项,json格式,参见CRMeetingAttrOptions
cookie string 详细介绍见cookie
  • 补充说明:

设置结果请参见:setMeetingAttrsRslt

addOrUpdateMeetingAttrs

  • 功能: 添加或更新房间属性
  • 返回值: 无
sdk_engine.addOrUpdateMeetingAttrs(jsonAttrs, options, cookie)
参数 类型 说明
jsonAttrs string 房间属性集,json格式,如:{"key1":"value1", "key2":"value2"} (key最大长度为64B,value最大长度为8KB)
options string 操作选项,json格式,参见CRMeetingAttrOptions
cookie string 详细介绍见cookie
  • 补充说明:

结果请参见:addOrUpdateMeetingAttrsRslt

delMeetingAttrs

  • 功能: 删除房间属性
  • 返回值: 无
sdk_engine.delMeetingAttrs(jsonKeys, options, cookie)
参数 类型 说明
jsonKeys string 需要删除的房间属性key,json格式,如:["key1", "key2"]
options string 操作选项,json格式,参见CRMeetingAttrOptions
cookie string 详细介绍见cookie
  • 补充说明:

结果请参见:delMeetingAttrsRslt

clearMeetingAttrs

  • 功能: 清空所有房间属性
  • 返回值: 无
sdk_engine.clearMeetingAttrs(options, cookie)
参数 类型 说明
options string 操作选项,json格式,参见CRMeetingAttrOptions
cookie string 详细介绍见cookie
  • 补充说明:

结果请参见:clearMeetingAttrsRslt

getMeetingAllAttrsSuccess

  • 功能: 获取所有房间属性成功
sdk_engine.on("getMeetingAllAttrsSuccess", (attrs, cookie) => {})
参数 类型 说明
attrs string 房间属性集,json结构体请参见CRAttrObjs
cookie string 详细介绍见cookie

getMeetingAllAttrsFail

  • 功能: 获取所有房间属性失败
sdk_engine.on("getMeetingAllAttrsFail", (sdkErr, cookie) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

getMeetingAttrsSuccess

  • 功能: 获取部份房间属性成功
sdk_engine.on("getMeetingAttrsSuccess", (attrs, cookie) => {})
参数 类型 说明
attrs string 房间属性集,json结构体请参见CRAttrObjs
cookie string 详细介绍见cookie

getMeetingAttrsFail

  • 功能: 获取部份房间属性失败
sdk_engine.on("getMeetingAttrsFail", (sdkErr, cookie) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

setMeetingAttrsRslt

  • 功能: 重置所有房间属性结果
sdk_engine.on("setMeetingAttrsRslt", (sdkErr, cookie) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

addOrUpdateMeetingAttrsRslt

  • 功能: 添加或更新房间属性结果
sdk_engine.on("addOrUpdateMeetingAttrsRslt", (sdkErr, cookie) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

delMeetingAttrsRslt

  • 功能: 删除房间属性结果
sdk_engine.on("delMeetingAttrsRslt", (sdkErr, cookie) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

clearMeetingAttrsRslt

  • 功能: 清空所有房间属性结果
sdk_engine.on("clearMeetingAttrsRslt", (sdkErr, cookie) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

notifyMeetingAttrsChanged

  • 功能: 通知房间属性改变
sdk_engine.on("notifyMeetingAttrsChanged", (adds, updates, delKeys) => {})
参数 类型 说明
adds string 增加房间属性集,json结构体请参见CRAttrObjs
updates string 变化的用户属性集,json结构体请参见CRAttrObjs
delKeys string 被删除的用户属性列表,json格式,如:["key1", "key2"]

getUserAttrs

  • 功能: 获取指定用户的所有属性
  • 返回值: 无
sdk_engine.getUserAttrs(jsonUIds, jsonKeys, cookie)
参数 类型 说明
jsonUIds string 目标用户id列表,一次最多包含50个用户,json格式, 如:["uid1","uid2"]
jsonKeys string 将要获取的用户属性key列表(空串代表获取全部),json格式,如:["key1","key2"]
cookie string 详细介绍见cookie
  • 补充说明:

结果请参见:getUserAttrsSuccess 或 getUserAttrsFail

setUserAttrs

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

结果请参见:setUserAttrsRslt

addOrUpdateUserAttrs

  • 功能: 添加或更新指定用户的属性
  • 返回值: 无
sdk_engine.addOrUpdateUserAttrs(userID, jsonAttrs, options, cookie)
参数 类型 说明
userID string 用户ID, 详细介绍见关键词
jsonAttrs string 用户属性集, json格式,如:{"key1":"value1", "key2":"value2"} (key最大长度为64B,value最大长度为8KB)
options string 操作选项,json格式,参见CRMeetingAttrOptions
cookie string 详细介绍见cookie
  • 补充说明:

结果请参见:addOrUpdateUserAttrsRslt

delUserAttrs

  • 功能: 删除指定用户的属性
  • 返回值: 无
sdk_engine.delUserAttrs(userID, jsonKeys, options, cookie)
参数 类型 说明
userID string 用户ID, 详细介绍见关键词
jsonKeys string 需要删除的用户属性key列表,json格式,如:["key1","key2"]
options string 操作选项,json格式,参见CRMeetingAttrOptions
cookie string 详细介绍见cookie
  • 补充说明:

结果请参见:delUserAttrsRslt

clearUserAttrs

  • 功能: 清空指定用户的属性
  • 返回值: 无
sdk_engine.clearUserAttrs(userID, options, cookie)
参数 类型 说明
userID string 用户ID, 详细介绍见关键词
options string 操作选项,json格式,参见CRMeetingAttrOptions
cookie string 详细介绍见cookie
  • 补充说明:

结果请参见:clearUserAttrsRslt

clearAllUserAttrs

  • 功能: 清空所有用户的属性
  • 返回值: 无
sdk_engine.clearAllUserAttrs(options, cookie)
参数 类型 说明
options string 操作选项,json格式,参见CRMeetingAttrOptions
cookie string 详细介绍见cookie
  • 补充说明:

结果请参见:clearAllUserAttrsRslt

getUserAttrsSuccess

  • 功能: 获取指定用户的所有属性成功
sdk_engine.on("getUserAttrsSuccess", (attrs, cookie) => {})
参数 类型 说明
attrs string 用户属性集,json结构体请,参见CRUsrAttrObjs
cookie string 详细介绍见cookie

getUserAttrsFail

  • 功能: 获取指定用户的所有属性失败
sdk_engine.on("getUserAttrsFail", (sdkErr, cookie) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

setUserAttrsRslt

  • 功能: 重置指定用户的属性结果
sdk_engine.on("setUserAttrsRslt", (sdkErr, cookie) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

addOrUpdateUserAttrsRslt

  • 功能: 添加或更新指定用户的属性结果
sdk_engine.on("addOrUpdateUserAttrsRslt", (sdkErr, cookie) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

delUserAttrsRslt

  • 功能: 删除指定用户的属性结果
sdk_engine.on("delUserAttrsRslt", (sdkErr, cookie) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

clearUserAttrsRslt

  • 功能: 清空指定用户的属性结果
sdk_engine.on("clearUserAttrsRslt", (sdkErr, cookie) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

clearAllUserAttrsRslt

  • 功能: 清空所有用户的属性结果
sdk_engine.on("clearAllUserAttrsRslt", (sdkErr, cookie) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码
cookie string 详细介绍见cookie

notifyUserAttrsChanged

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

getAudioMics

  • 功能: 获取系统麦克风设备列表
  • 返回值: Array<CRAudioDevInfo>,麦克风设备列表
sdk_engine.getAudioMics()

getAudioSpks

  • 功能: 获取系统扬声器设备列表
  • 返回值: Array<CRAudioDevInfo>,麦克风设备列表
sdk_engine.getAudioSpks()

getAudioCfg

  • 功能: 获取当前音频配置
  • 返回值: CRAudioCfg
sdk_engine.getAudioCfg()

setAudioCfg

  • 功能: 设置音频参数
  • 返回值: 无
sdk_engine.setAudioCfg(cfg)
参数 类型 说明
cfg CRAudioCfg 音频配置

getMicVolume

  • 功能: 获取麦克风音量
  • 返回值: number,音量,0~255
sdk_engine.getMicVolume()

setMicVolume

  • 功能: 配置麦克风音量
  • 返回值: 无
sdk_engine.setMicVolume(volume)
参数 类型 说明
volume number 音量,0~255

getSpkVolume

  • 功能: 获取扬声器音量
  • 返回值: number,音量,0~255
sdk_engine.getSpkVolume()

setSpkVolume

  • 功能: 配置扬声器音量
  • 返回值: 无
sdk_engine.setSpkVolume(volume)
参数 类型 说明
volume number 音量,0~255

getSpeakerMute

  • 功能: 获取扬声器静音状态
  • 返回值: true:静音、false:不静音
sdk_engine.getSpeakerMute()

setSpeakerMute

  • 功能: 配置扬声器静音
  • 返回值: 无
sdk_engine.setSpeakerMute(bMute)
参数 类型 说明
bMute boolean true:静音、false:不静音

startEchoTest

  • 功能: 开始本地语音环回测试
  • 返回值: 错误码,详细见错误码定义
sdk_engine.startEchoTest()

stopEchoTest

  • 功能: 停止本地语音环回测试
  • 返回值: 无
sdk_engine.stopEchoTest()

isEchoTesting

  • 功能: 检查是否在本地语音环回测试
  • 返回值: 是否在测试中(boolean)
sdk_engine.isEchoTesting()

openMic

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

打开自已的麦克风时,先会进入到CRVSDK_AST_OPENING状态,等服务器处理后才会进入CRVSDK_AST_OPEN状态;
当用户的麦克风状态变为CRVSDK_AST_OPEN状态时,说话才能被采集到;
一个房间最大开麦数为8,超出的开麦人将保持在CRVSDK_AST_OPENING状态;
CRVSDK_AST_OPENING状态的麦不会在有人关麦时自动打开,需要按需再次执行openMic;
麦克风状态改变时,房间中所有人将收到notifyMicStatusChanged通知;

closeMic

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

关麦操作是立即生效的,本地会立即停止采集;
房间中所有人将收到notifyMicStatusChanged通知;

closeAllMic

  • 功能: 全体关麦
  • 返回值: 无
sdk_engine.closeAllMic()
  • 补充说明:

全体关麦时,不关闭操作者自已的麦;

getMicStatus

  • 功能: 获取指定人员的麦克风状态
  • 返回值: CRVSDK_ASTATUS
sdk_engine.getMicStatus(userID)
参数 类型 说明
userID string 用户ID, 详细介绍见关键词

getLocMicDevEnergy

  • 功能: 获取本地麦克风设备能量等级
  • 返回值: 能量等级0~9 ,9为最大能量等级(number)
sdk_engine.getLocMicDevEnergy()
  • 补充说明:

房间中关麦仍能获取当前麦设备的能量值;
如果想获取在房间中的能量值,请使用getUserMicEnergy;

getUserMicEnergy

  • 功能: 获取房间中指定人员麦克风能量等级
  • 返回值: 能量等级0~9 ,9为最大能量等级(number)
sdk_engine.getUserMicEnergy(userID)
参数 类型 说明
userID string 用户ID, 详细介绍见关键词
  • 补充说明:

房间中关麦后,获取的麦能量值将为0
如果想获取当前麦设备实际能量值,请使用getLocMicDevEnergy;

getVoiceChangeType

  • 功能: 获取目标用户变声类型
  • 返回值: number,预定义变声类型:CRVSDK_VOICECHANGE_TYPE<br />自定义变声:取值100~200, 150为原声,<150为降调,>150为升调
sdk_engine.getVoiceChangeType(userID)
参数 类型 说明
userID string 用户ID, 详细介绍见关键词

setVoiceChange

  • 功能: 设置目标用户变声
  • 返回值: 无
sdk_engine.setVoiceChange(userID, type)
参数 类型 说明
userID string 用户ID, 详细介绍见关键词
type number 预定义变声类型:CRVSDK_VOICECHANGE_TYPE
自定义变声:取值100~200, 150为原声,<150为降调,>150为升调
  • 补充说明:

变声功能为服务器实现,所以本地录制、本地声音环回测试,声音都是不变声过的;

setAudioSubscribeMode

  • 功能: 设置语音订阅模式
  • 返回值: 无
sdk_engine.setAudioSubscribeMode(mode)
参数 类型 说明
mode CRVSDK_ASUBSCRIB_MODE 订阅模式
  • 补充说明:

sdk内部默认为CRVSDK_ASM_MIXED模式,此模式进入房间成功就能听到房间内所有开麦人的声音;
配置为CRVSDK_ASM_SEPARATE模式后,默认不订阅任何人的声音,需要调用setAudioSubscribeListForSeparateMode设置要订阅的人员名单;
此接口在进入房间前可调用, 程序退出后失效;

setAudioSubscribeListForSeparateMode

  • 功能: 设置独立音频订阅名单
  • 返回值: 无
sdk_engine.setAudioSubscribeListForSeparateMode(type, userIds)
参数 类型 说明
type CRVSDK_ASUBSCRIB_LISTTYPE 列表类型
userIds string 用户ID列表,使用";"分割
  • 补充说明:

只有在CRVSDK_ASM_SEPARATE音频订阅模式下才能设置,可调用setAudioSubscribeMode修改模式;
切换到其它音频订阅模式时,之前设置的名单自动失效;
此接口在进入房间前可调用,程序退出后失效;
白名单和黑名单不共存,后面的数据将覆盖之前的数据;
其他人员进出房间、开关麦,不影响设置的名单;sdk内部会退订离开或关麦的流,在开麦后再次订阅;

notifyAudioDevChanged

  • 功能: 通知本地音频设备变化
sdk_engine.on("notifyAudioDevChanged", () => {})

notifyAudioErr

  • 功能: 通知本地音频相关错误
sdk_engine.on("notifyAudioErr", (sdkErr) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码

notifyMicStatusChanged

  • 功能: 通知房间中有人麦克风状态变化
sdk_engine.on("notifyMicStatusChanged", (userID, oldStatus, newStatus, operatorID) => {})
参数 类型 说明
userID string 用户ID, 详细介绍见关键词
oldStatus number 旧的麦克风状态
newStatus number 新的麦克风状态
operatorID string 操作者的用户ID

notifyMicEnergy

  • 功能: 通知房间有人麦克风能量变化
sdk_engine.on("notifyMicEnergy", (userID, oldLevel, newLevel) => {})
参数 类型 说明
userID string 用户ID, 详细介绍见关键词
oldLevel number 之前的说话声音强度(0~10)
newLevel number 现在的说话声音强度(0~10)

notifySetVoiceChange

  • 功能: 通知房间中有人变声状态变化
sdk_engine.on("notifySetVoiceChange", (userID, type, operatorID) => {})
参数 类型 说明
userID string 用户ID, 详细介绍见关键词
type number 预定义变声类型:CRVSDK_VOICECHANGE_TYPE
自定义变声:取值100~200, 150为原声,<150为降调,>150为升调
operatorID string 操作者的用户ID

notifyCloseAllMic

  • 功能: 通知有人发起了全体关麦操作
sdk_engine.on("notifyCloseAllMic", (operatorID) => {})
参数 类型 说明
operatorID string 操作者的用户ID

addCanvas

  • 功能: 订阅绘制视图画面
  • 返回值: 无
sdk_engine.addCanvas(canvas)
参数 类型 说明
canvas CRCanvas 视图控件配置
  • 补充说明:

界面上需要显示摄像头、影音共享、屏幕共享的画面,都需要通过该接口订阅视频,示例代码参见视图组件

rmCanvas

  • 功能: 取消订阅绘制视图画面
  • 返回值: 无
sdk_engine.rmCanvas(canvasId)
参数 类型 说明
canvasId string 要销毁的视图控件ID,参见addCanvas

getAllVideoInfo

  • 功能: 获取指定成员的所有摄像头信息
  • 返回值: Array<CRVideoDevInfo>,视频设备信息
sdk_engine.getAllVideoInfo(userID)
参数 类型 说明
userID string 用户ID, 详细介绍见关键词

getVideoCfg

  • 功能: 获取本地视频全局配置
  • 返回值: 视频全局配置,请参见CRVideoCfg
sdk_engine.getVideoCfg()

setVideoCfg

  • 功能: 设置本地视频全局配置
  • 返回值: 错误码,详细见错误码定义
sdk_engine.setVideoCfg(cfg)
参数 类型 说明
cfg CRVideoCfg 视频全局配置

openVideo

  • 功能: 打开指定人的摄像头
  • 返回值: 无
sdk_engine.openVideo(userID)
参数 类型 说明
userID string 用户ID, 详细介绍见关键词
  • 补充说明:

打开用户的摄像头,以便本地、远端显示视频图像;
开启摄像头后可通过视频组件将画面渲染到界面上;
打开多个摄像头,参见setMutiVideos;

closeVideo

  • 功能: 关闭指定人的摄像头
  • 返回值: 无
sdk_engine.closeVideo(userID)
参数 类型 说明
userID string 用户ID, 详细介绍见关键词

getVideoStatus

  • 功能: 获取房间中指定成员的视频状态
  • 返回值: CRVSDK_VSTATUS
sdk_engine.getVideoStatus(userID)
参数 类型 说明
userID string 用户ID, 详细介绍见关键词

setDefaultVideo

  • 功能: 配置默认摄像头
  • 返回值: 无
sdk_engine.setDefaultVideo(videoID)
参数 类型 说明
videoID number 摄像头ID
  • 补充说明:

sdk内部会自动产生默认摄像头,除非系统没有任何真实摄像头、自定义摄像头、网络摄像头等;
当默认摄像头被移除时,sdk内部会自动产生一个新的默认摄像头;
sdk内部产生默认摄像头时,优先将将打开的多摄像头上选择;

getDefaultVideo

  • 功能: 获取默认摄像头
  • 返回值: 摄像头ID(number), 0代表没有默认摄像头
sdk_engine.getDefaultVideo(userID)
参数 类型 说明
userID string 用户ID, 详细介绍见关键词

setMutiVideos

  • 功能: 配置本地多摄像头
  • 返回值: 无
sdk_engine.setMutiVideos(moreVideos, count)
参数 类型 说明
moreVideos Array<Number> 需要开启的摄像头ID列表(不应该包含默认摄像头,即使传入也会被忽略)
count number moreVideoIDs个数,0代表关闭多摄像头功能

getMutiVideos

  • 功能: 获取本地的或他人的多摄像头列表
  • 返回值: Array<Number>,摄像头ID列表
sdk_engine.getMutiVideos(userID)
参数 类型 说明
userID string 用户ID, 详细介绍见关键词

setLocVideoAttributes

  • 功能: 设置本地指定设备私有配置
  • 返回值: 无
sdk_engine.setLocVideoAttributes(videoID, jsonAttributes)
参数 类型 说明
videoID number 摄像头ID
jsonAttributes string json格式,请参见CRVideoAttributesObj

getLocVideoAttributes

  • 功能: 获取本地指定设备私有配置
  • 返回值: string, json格式,请参见CRVideoAttributesObj
sdk_engine.getLocVideoAttributes(videoID)
参数 类型 说明
videoID number 摄像头ID

setVideoEffects

  • 功能: 配置视频效果参数
  • 返回值: 无
sdk_engine.setVideoEffects(efs)
参数 类型 说明
efs string 视频效果配置,json字符串,请参见CRVideoEffectsObj

getVideoEffects

  • 功能: 获取视频效果参数
  • 返回值: 视频效果配置,json字符串,请参见CRVideoEffectsObj
sdk_engine.getVideoEffects()

notifyVideoDevChanged

  • 功能: 通知用户视频设备变化(设备个数、设备能力参数、默认设备、启停多摄像头等)
sdk_engine.on("notifyVideoDevChanged", (userID) => {})
参数 类型 说明
userID string 用户ID, 详细介绍见关键词

notifyDefaultVideoChanged

  • 功能: 通知用户默认视频设备变化
sdk_engine.on("notifyDefaultVideoChanged", (userID, videoID) => {})
参数 类型 说明
userID string 用户ID, 详细介绍见关键词
videoID number 摄像头ID

openVideoDevRslt

  • 功能: 本地视频设备打开结果
sdk_engine.on("openVideoDevRslt", (videoID, isSucceed) => {})
参数 类型 说明
videoID number 摄像头ID
isSucceed boolean 打开结果

notifyVideoStatusChanged

  • 功能: 通知用户视频状态变化
sdk_engine.on("notifyVideoStatusChanged", (videoID, oldStatus, newStatus, operatorID) => {})
参数 类型 说明
videoID number 摄像头ID
oldStatus number 旧的视频状态
newStatus number 新的视频状态
operatorID string 操作者的用户ID

createCustomVideoDev

  • 功能: 创建自定义摄像头
  • 返回值: >=0添加成功,返回值为videoID(摄像头ID); <0代表添加失败,参见错误码
sdk_engine.createCustomVideoDev(camName, pixFmt, width, height)
参数 类型 说明
camName string 摄像头名
pixFmt CRVSDK_VIDEO_FORMAT 图像格式,CRVSDK_VFMT_YUV420P格式性能最佳;
width number 图像宽
height number 图像高
  • 补充说明:

最多支持添加5个;
添加成功后与本地摄像头处理一致;本地通过getAllVideoInfo接口可以识别哪些是自定义摄像头;
添加的摄像头在反初始化时删除;
创建成功后,调用inputCustomVideoDat送入摄像头图像数据;

destroyCustomVideoDev

  • 功能: 销毁自定义摄像头
  • 返回值: 无
sdk_engine.destroyCustomVideoDev(videoID)
参数 类型 说明
videoID number 摄像头ID

inputCustomVideoDat

  • 功能: 送入自定义摄像头数据
  • 返回值: 错误码,详细见错误码定义
sdk_engine.inputCustomVideoDat(videoID, frm)
参数 类型 说明
videoID number 摄像头ID
frm CRVideoFrame 图像数据(请保证格式、和尺寸与摄像头一致)

addIPCam

  • 功能: 添加网络摄像头
  • 返回值: 返回值>=0代表添加成功,返回值为videoID(摄像头ID); 返回值<0代表添加失败,参见错误码
sdk_engine.addIPCam(url, jsonParam)
参数 类型 说明
url string 网络摄像头url,支持协议:rtmp,rtsp
jsonParam string json格式参数,可不传, 支持:
name:摄像头名称,不配置则为url
maxRetry:连接失败或中断连时重试连接次数,<0代表无限重试,默认值-1
  • 示例代码:
const rtmp = 'rtmp://xxxx';
const jsonParam = {
    name: '摄像头名称'
}
const videoID = sdk_engine.addIPCam(rtmp, JSON.stringify(jsonParam));
if (videoID < 0) {
    //小于0,添加失败
    console.log('添加失败,错误码: ' + videoID);
} else {
    sdk_engine.setDefaultVideo(videoID); //设置为默认摄像头
}
  • 补充说明:

最多支持添加5个;
添加成功后与本地摄像头处理一致;本地通过getAllVideoInfo接口可以识别哪些是网络摄像头;
添加的摄像头在反初始化时删除;

delIPCam

  • 功能: 删除网络摄像头
  • 返回值: 无
sdk_engine.delIPCam(videoID)
参数 类型 说明
videoID number 摄像头ID

setMediaCfg

  • 功能: 设置影音共享配置
  • 返回值: 错误码,详细见错误码定义
sdk_engine.setMediaCfg(jsonCfg)
参数 类型 说明
jsonCfg string 影音共享配置,json格式,请参见CRVideoCfg

getMediaCfg

  • 功能: 获取影音共享配置
  • 返回值: 影音共享配置,json格式,请参见CRVideoCfg
sdk_engine.getMediaCfg()

startPlayMedia

  • 功能: 开始影音共享
  • 返回值: 无
sdk_engine.startPlayMedia(fileName, bLocPlay, bPauseWhenFinished)
参数 类型 说明
fileName string 文件全路径或者网络地址
bLocPlay boolean 是否本地播放。本地播放时,声音图像不会送入房间,适用于本地录像检测,默认值false
bPauseWhenFinished boolean 文件正常播放完成时,暂停在文件未尾,默认值false
  • 补充说明:

开启后可通过视频组件将画面渲染到界面上
支持本地完整路径文件,支持mp4、flv、avi、wmv、mkv、mov、3gp、wma、mp3、m4a、wav等常见文件格式;
支持网络媒体流,支持的协议有:http、rtmp、rtsp;
一个房间同一时间只能一个影音共享(本地播放除外);
开启共享失败时,将有startPlayMediaFail回调;
开启共享成功时,房间内所有人都将收到notifyMediaStart通知;
开启共享成功后,共享端开始向房间内播放文件,共享者在文件打开成功时将收回notifyMediaOpened回调;
共享中,如果文件打开失败、或中途读取失败、或播放结果, sdk内部将自动停止影音共享,房间内所有人都将收到notifyMediaStop通知;

pausePlayMedia

  • 功能: 暂停影音共享
  • 返回值: 无
sdk_engine.pausePlayMedia(bPause)
参数 类型 说明
bPause boolean 暂停共享true/恢复共享false
  • 补充说明:

共享暂停后,房间内所有人将收到notifyMediaPause通知;

stopPlayMedia

  • 功能: 停止影音共享
  • 返回值: 无
sdk_engine.stopPlayMedia()
  • 补充说明:

可以停止本地或他人的影音共享;
影音共享被停止时,房间内所有人将收到notifyMediaStop通知;

setMediaPlayPos

  • 功能: 设置播放位置
  • 返回值: 无
sdk_engine.setMediaPlayPos(ms)
参数 类型 说明
ms number 设置播放位置,单位:毫秒

getMediaInfo

  • 功能: 获取当前影音共享信息
  • 返回值: 共享信息,参见CRMediaInfo
sdk_engine.getMediaInfo()

getMediaStreamInfo

  • 功能: 获取当前影音共享流信息
  • 返回值: CRVStreamInfo
sdk_engine.getMediaStreamInfo()

setMediaVolume

  • 功能: 配置影音播放音量
  • 返回值: 无
sdk_engine.setMediaVolume(volume)
参数 类型 说明
volume number 影音音量,范围:0~255
  • 补充说明:

此调整同时影响本地影音的播放音量,也影晌他人的影音播放音量;
此调整不影响他人的说话声音大小;

getMediaVolume

  • 功能: 获取影音播放音量
  • 返回值: 影音音量,范围:0~255
sdk_engine.getMediaVolume()

startPlayMediaFail

  • 功能: 影音共享开启失败
sdk_engine.on("startPlayMediaFail", (sdkErr) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码

notifyMediaStart

  • 功能: 通知影音共享开启
sdk_engine.on("notifyMediaStart", (userID) => {})
参数 类型 说明
userID string 用户ID, 详细介绍见关键词
  • 补充说明:

收到通知后可通过视频组件将画面渲染到界面上

notifyMediaOpened

  • 功能: 本地影音共享文件打开成功通知
sdk_engine.on("notifyMediaOpened", (totalTime, w, h) => {})
参数 类型 说明
totalTime number 文件总时长(ms), -1代表没有总时长(通常为网络摄像头、直播流等)
w number 图像宽
h number 图像高

notifyMediaStop

  • 功能: 通知影音共享停止
sdk_engine.on("notifyMediaStop", (userID, reason) => {})
参数 类型 说明
userID string 用户ID, 详细介绍见关键词
reason CRVSDK_MEDIA_STOPREASON 停止的原因

notifyMediaPause

  • 功能: 通知影音共享暂停
sdk_engine.on("notifyMediaPause", (userID, bPause) => {})
参数 类型 说明
userID string 用户ID, 详细介绍见关键词
bPause boolean 是否暂停

setScreenShareCfg

  • 功能: 设置屏幕共享配置
  • 返回值: 无
sdk_engine.setScreenShareCfg(cfg)
参数 类型 说明
cfg string 屏幕共享配置,json格式,参见CRScreenShareCfg

getScreenShareCfg

  • 功能: 获取屏幕共享配置
  • 返回值: 屏幕共享配置,json格式,参见CRScreenShareCfg
sdk_engine.getScreenShareCfg()

getScreenShareInfo

sdk_engine.getScreenShareInfo()

startScreenShare

  • 功能: 开始屏幕共享
  • 返回值: 无
sdk_engine.startScreenShare()
  • 补充说明:

开始结果请参见:startScreenShareRslt
开始成功后,sdk内部将自动完成抓屏共享处理

stopScreenShare

  • 功能: 停止屏幕共享
  • 返回值: 无
sdk_engine.stopScreenShare()
  • 补充说明:

结果请参见:stopScreenShareRslt

pauseScreenShare

  • 功能: 暂停共享
  • 返回值: 无
sdk_engine.pauseScreenShare(bPause)
参数 类型 说明
bPause bool true:共享暂停、false:正常共享

startScreenShareRslt

  • 功能: 开启屏幕共享结果
sdk_engine.on("startScreenShareRslt", (sdkErr) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码

stopScreenShareRslt

  • 功能: 停止屏幕共享结果
sdk_engine.on("stopScreenShareRslt", (sdkErr) => {})
参数 类型 说明
sdkErr CRVSDK_ERR_DEF 错误码

notifyScreenShareStarted

  • 功能: 通知屏幕共享开始
sdk_engine.on("notifyScreenShareStarted", (userID) => {})
参数 类型 说明
userID string 用户ID, 详细介绍见关键词
  • 补充说明:

收到通知后可通过视频组件将画面渲染到界面上

notifyScreenShareStopped

  • 功能: 通知屏幕共享停止
sdk_engine.on("notifyScreenShareStopped", (operatorID) => {})
参数 类型 说明
operatorID string 操作者的用户ID

createLocMixer

  • 功能: 创建本地混图器
  • 返回值: 错误码
sdk_engine.createLocMixer(mixerID, mixerCfg, mixerContents)
参数 类型 说明
mixerID string 混图器唯一标识
mixerCfg CRLocMixerCfgObj 混图器规格配置
mixerContents Array<CRMixerContentObj> 混图器内容配置
  • 补充说明:

创建本地混图器(用于本地录制、本地推流),当需要多个不同内容的录制、或直播时,就要创建多个混图器 。混图器开消比较大,多个同样图像的输出应该有一个混图器加上多个输出实现;
开启成功后,可以通过updateLocMixerContent更新内容;
开启成功后,可以通过addLocMixerOutput添加输出目标,如输出到文件,或输出到网络直播流;
混图器如果异常停止时,将通过notifyLocMixerStateChanged回调用户;

updateLocMixerContent

  • 功能: 更新本地混图器内容
  • 返回值: 错误码
sdk_engine.updateLocMixerContent(mixerID, mixerContents)
参数 类型 说明
mixerID string 混图器唯一标识
mixerContents Array<CRMixerContentObj> 混图器内容配置

destroyLocMixer

  • 功能: 销毁本地混图器
  • 返回值: 无
sdk_engine.destroyLocMixer(mixerID)
参数 类型 说明
mixerID string 混图器唯一标识
  • 补充说明:

销毁本地混图器时,内部将自动正常移除所有输出;

getLocMixerState

sdk_engine.getLocMixerState(mixerID)
参数 类型 说明
mixerID string 混图器唯一标识

addLocMixerOutput

  • 功能: 开启本地录制、开启直播推流
  • 返回值: 错误码
sdk_engine.addLocMixerOutput(mixerID, mixerOutput)
参数 类型 说明
mixerID string 混图器唯一标识
mixerOutput Array<CRLocMixerOutputObj> 本地输出对象
  • 补充说明:

添加输出节点后,可以通过notifyLocMixerOutputInfo关注输出信息

rmLocMixerOutput

  • 功能: 停止本地录制、直播推流
  • 返回值: 无
sdk_engine.rmLocMixerOutput(mixerID, nameOrUrls)
参数 类型 说明
mixerID string 混图器唯一标识
nameOrUrls string 要移除的输出的filename或liveUrl, 支持多值,以";"分隔;
  • 补充说明:

移除输出时,内部将结束文件录制,或结束直播推流;

setPicResource

  • 功能: 配置图片资源(设置空的帧代表移除)
  • 返回值: 无
sdk_engine.setPicResource(picID, frm)
参数 类型 说明
picID string 本地资源唯一标识
frm CRVideoFrame 图像数据(请保证格式、和尺寸与摄像头一致)
  • 补充说明:

设置本地图像资源,可在本地混图器中引用,参见录制内容类型CRVSDK_MIXER_CONTENT_TYPE的CRVSDK_MIXCONT_PIC;
当资源不再需要时,应将此picID设置空的图像帧,以便sdk内部将释放相关资源;
离开房间时,设置的相关图片资源,将自动被移除;

notifyLocMixerStateChanged

  • 功能: 本地混图器状态变化通知
sdk_engine.on("notifyLocMixerStateChanged", (mixerID, state) => {})
参数 类型 说明
mixerID string 混图器唯一标识
state CRVSDK_MIXER_STATE 混图器状态

notifyLocMixerOutputInfo

  • 功能: 本地录制文件、本地直播信息通知
sdk_engine.on("notifyLocMixerOutputInfo", (mixerID, nameOrUrl, outputInfo) => {})
参数 类型 说明
mixerID string 混图器唯一标识
nameOrUrl string 录像名称、或直播url
outputInfo CRLocMixerOutputInfoObj 通知内容

createCloudMixer

  • 功能: 创建云端混图器
  • 返回值: 云端混图器ID
sdk_engine.createCloudMixer(cfg)
参数 类型 说明
cfg CRCloudMixerCfgObj 云端混图器配置
  • 补充说明:

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

updateCloudMixerContent

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

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

destroyCloudMixer

  • 功能: 销毁云端混图器
  • 返回值: 无
sdk_engine.destroyCloudMixer(mixerID)
参数 类型 说明
mixerID string 混图器ID, 参见createCloudMixer
  • 补充说明:

销毁云端混图器时,调用者将收到notifyCloudMixerStateChanged通知进入CRVSDK_MIXER_STOPPING状态,在停止完成后,房间内所有人都将收到notifyCloudMixerStateChanged通知进入CRVSDK_MIXER_NULL状态;

getCloudMixerInfo

  • 功能: 获取云端混图器信息
  • 返回值: 云端混图器信息,参见CRCloudMixerInfo
sdk_engine.getCloudMixerInfo(mixerID)
参数 类型 说明
mixerID string 混图器ID, 参见createCloudMixer

getAllCloudMixerInfo

  • 功能: 获取所有云端混图器
  • 返回值: Array<CRCloudMixerInfo>,云端混图器信息列表
sdk_engine.getAllCloudMixerInfo()

createCloudMixerFailed

  • 功能: 通知创建云端录制/推流失败
sdk_engine.on("createCloudMixerFailed", (mixerID, sdkErr) => {})
参数 类型 说明
mixerID string 混图器ID, 参见createCloudMixer
sdkErr CRVSDK_ERR_DEF 错误码

notifyCloudMixerInfoChanged

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

可调用:getCloudMixerInfo获取相关信息

notifyCloudMixerStateChanged

  • 功能: 通知云端录制/推流状态变化
sdk_engine.on("notifyCloudMixerStateChanged", (mixerID, state, exParam, operUserID) => {})
参数 类型 说明
mixerID string 混图器ID, 参见createCloudMixer
state CRVSDK_MIXER_STATE 录制状态
exParam string json格式扩展参数,state状态及参数定义:
MIXER_NULL:包含err(错误码), errDesc字段;
MIXER_STARTING:包含jsonCfg字段
operUserID string 操作者用户ID

notifyCloudMixerEvent

  • 功能: 通知云端录制/推流事件
sdk_engine.on("notifyCloudMixerEvent", (mixerID, eventType, cloudMixerEventInfoObj) => {})
参数 类型 说明
mixerID string 混图器ID, 参见createCloudMixer
eventType CRVSDK_CLOUDMIXER_EVENT_TYPE 事件类型
cloudMixerEventInfoObj CRCloudMixerEventInfoObj 云端混图器事件信息
  • 补充说明:

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

  CRVSDK_EVT_OUTPUT_START(1):输出开始:
参数 类型 含义
outputName string 文件名/推流地址
  CRVSDK_EVT_OUTPUT_END(2):输出结束:
参数 类型 含义
outputName string 文件名/推流地址
startTime int64 创建时间(从1970年1月1日00:00:00起的毫秒数)
duration int64 录像时长(ms)
size int64 文件大小(Byte)
  CRVSDK_EVT_OUTPUT_FAILED(3):输出错误:
参数 类型 含义
outputName string 文件名/推流地址
errCode CRVSDK_ERR_DEF 错误码
errDesc string 错误描述
  CRVSDK_EVT_FILE_UPLOADING(4):文件上传中:
参数 类型 含义
outputName string 文件名/推流地址
progress float 上传进度(0~100.0)
  CRVSDK_EVT_FILE_UPLOADED(5):文件上传完成:
参数 类型 含义
outputName string 文件名/推流地址
startTime int64 创建时间(从1970年1月1日00:00:00起的毫秒数)
duration int64 录像时长(ms)
size int64 文件大小(Byte)
  CRVSDK_EVT_FILE_UPLOADFAILED(6):文件上传失败:
参数 类型 含义
outputName string 文件名/推流地址
errCode CRVSDK_ERR_DEF 错误码
errDesc string 错误描述
  CRVSDK_EVT_ALLFILE_FINISHED(8):所有文件完成:
参数 类型 含义
allFileState int 录制文件上传整体状态, 0:全部未上传,1:全部上传成功,2:部分上传成功
allFileInfo CRCloudRecordFileInfo[] 录制文件上传信息列表
  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 事件描述