API

API接口主要分为:基础函数初始化/反初始化登录/注销成员管理队列管理透明通道/呼叫排队房间管理音频管理视频管理屏幕共享影音共享本地录制/本地直播云端录制/互动直播电子白板/文档共享可视化组件

接口描述

基础函数:

方式 接口 描述
主调 CRVideo_GetSDKJsVersion 获取Web js版本号
CRVideo_PluginVersion 获取Plugin版本号
CRVideo_SdkPath 获取sdk所在的目录
CRVideo_EnableLog2File 设置是否开启日志
CRVideo_EnableLogReport 设置是否开启日志上报
CRVideo_SetSDKParams 设置SDK参数
CRVideo_SetFileUploadRate 文件上传的流量控制
CRVideo_SetFileDownloadRate 文件下载的流量控制
CRVideo_SetAliyunOssAccountInfo 设置阿里云OSS信息
CRVideo_WriteLog 向日志文件中写入内容

初始化/反初始化:

方式 接口 描述
主调 CRVideo_Init2 SDK初始化
CRVideo_Uninit SDK反初始化

登录/注销:

方式 接口 描述
主调 CRVideo_Login 登录
CRVideo_Logout 注销
回调 CRVideo_LoginSuccess 登陆成功
CRVideo_LoginFail 登录失败

成员管理:

方式 接口 描述
主调 CRVideo_GetAllMembers 房间成员列表
CRVideo_GetMemberInfo 房间成员信息
CRVideo_GetMemberNickName 房间成员昵称
CRVideo_IsUserInMeeting 用户是否在房间中
CRVideo_SetNickName 设置某个用户的昵称

队列管理

方式 接口 描述
主调 CRVideo_InitQueueDat 初始化队列
CRVideo_RefreshAllQueueStatus 刷新所有队列状态
CRVideo_GetAllQueueInfo 查询队列
CRVideo_GetQueueStatus 获取队列状态
CRVideo_GetQueuingInfo 获取我的排队信息
CRVideo_GetServingQueues 获取我服务的所有队列
CRVideo_GetSessionInfo 获取我的会话信息
CRVideo_StartQueuing2 开始排队
CRVideo_StopQueuing 停止排队
CRVideo_StartService2 开始服务队列
CRVideo_StopService 停止服务队列
CRVideo_ReqAssignUser 请求分配一个客户
CRVideo_AcceptAssignUser 接受分配的客户
CRVideo_RejectAssignUser 拒绝分配的客户
回调 CRVideo_InitQueueDatRslt 列初始化操作结果
CRVideo_QueueStatusChanged 队列状态变化通知
CRVideo_QueuingInfoChanged 排队信息变化通知
CRVideo_StartQueuingRslt 开始排队通知
CRVideo_StopQueuingRslt 停止排队通知
CRVideo_StartServiceRslt 开始服务队列通知
CRVideo_StopServiceRslt 停止服务队列通知
CRVideo_ResponseAssignUserRslt 响应分配客户操作结果
CRVideo_AutoAssignUser 自动分配用户通知
CRVideo_ReqAssignUserRslt 请求分配用户结果
CRVideo_CancelAssignUser 分配用户被取消

透明通道/呼叫排队

方式 接口 描述
主调 CRVideo_Call 发起呼叫
CRVideo_AcceptCall 接受对方发起的呼叫
CRVideo_RejectCall 拒绝对方发起的呼叫
CRVideo_HungupCall 挂断呼叫
CRVideo_SetDNDStatus 设置免打扰状态
CRVideo_GetUserStatus 获取企业下所有用户在线状态
CRVideo_GetOneUserStatus 获取企业下指定用户的在线状态
CRVideo_StartUserStatusNotify 开启用户的状态推送
CRVideo_StopUserStatusNotify 关闭用户的状态推送
CRVideo_SendCmd 发送小块数据
CRVideo_SendBuffer 发送大块数据
CRVideo_SendFile 发送文件(分块发送 )
CRVideo_CancelSend 取消数据发送
CRVideo_SendIMmsg 发送点对点消息
回调 CRVideo_CallSuccess 发起呼叫操作成功
CRVideo_CallFail 发起呼叫操作失败
CRVideo_AcceptCallSuccess 接受他人呼叫操作成功
CRVideo_AcceptCallFail 接受他人呼叫操作失败
CRVideo_RejectCallSuccess 拒绝他人的呼叫成功
CRVideo_RejectCallFail 拒绝他人的呼叫失败
CRVideo_HangupCallSuccess 挂断他人的呼叫成功
CRVideo_HangupCallFail 挂断他人的呼叫失败
CRVideo_NotifyCallIn 通知有人呼入
CRVideo_NotifyCallAccepted 通知呼叫被对方接受
CRVideo_NotifyCallRejected 通知呼叫被对方拒绝
CRVideo_NotifyCallHungup 通知呼叫被对方挂断
CRVideo_SetDNDStatusSuccess 设置免打扰状态操作成功
CRVideo_SetDNDStatusFail 设置免打扰状态操作失败
CRVideo_GetUserStatusSuccess 获取所有用户在线状态成功
CRVideo_GetUserStatusFail 获取所有用户在线状态失败
CRVideo_StartUserStatusNotifyRslt 开启用户状态推送结果
CRVideo_StopUserStatusNotifyRslt 关闭用户状态推送结果
CRVideo_NotifyUserStatus 用户状态变化通知
CRVideo_SendCmdRlst 发送小块数据
CRVideo_SendBufferRlst 发送大块数据
CRVideo_SendFileRlst 发送文件
CRVideo_SendProgress 发送数据时,通知发送进度
CRVideo_CancelSendRlst 取消发送响应
CRVideo_NotifyCmdData 通知收到小块数据
CRVideo_NotifyBufferData 通知收到大块数据
CRVideo_NotifyFileData 通知收到文件数据
CRVideo_NotifyCancelSend 通知取消发送文件数据
CRVideo_SendIMmsgRlst 发送点对点消息结果
CRVideo_NotifyIMmsg SDK通知收到IM消息

房间管理

方式 接口 描述
主调 CRVideo_Switchtopage 功能切换
CRVideo_Getcurrentmainpage 获取当前主功能区
CRVideo_Getcurrentsubpage 获取当前子页面
CRVideo_GetMainVideo 获取当前哪个用户为主视频
CRVideo_SetMainVideo 设置当前哪个用户为主视频
CRVideo_CreateMeeting 创建房间
CRVideo_DestroyMeeting 销毁房间
CRVideo_GetMeetings 获取房间列表
CRVideo_EnterMeeting 进入房间
CRVideo_ExitMeeting 离开房间
CRVideo_StopMeeting 结束房间
回调 CRVideo_EnterMeetingRslt 进入房间结果
CRVideo_StopMeetingRslt 结束房间结果
CRVideo_UserEnterMeeting 有人进入房间通知
CRVideo_MeetingStopped 房间被结束通知
CRVideo_MeetingDropped 房间掉线通知
CRVideo_UserLeftMeeting 有人离开房间通知
CRVideo_LineOff 通知自己掉线
CRVideo_CreateMeetingSuccess 创建房间成功
CRVideo_CreateMeetingFail 创建房间失败
CRVideo_DestroyMeetingRslt 销毁房间响应
CRVideo_GetMeetingsSuccess 获取房间列表成功
CRVideo_GetMeetingsFail 获取房间列表失败
CRVideo_SetNickNameRsp 设置房间成员昵称的结果
CRVideo_NotifyNickNameChanged 某用户改变了昵称
CRVideo_NotifyVideoWallMode2 会话内视频分屏模式通知
CRVideo_NotifyMainVideoChanged 会话内主视频变化通知
CRVideo_NotifySwitchToPage 会话内主功能页切换通知
CRVideo_DefVideoChanged 通知用户的视频默认设备有变化
CRVideo_NetStateChanged 通知我的网络变化

音频管理

方式 接口 描述
主调 CRVideo_GetAudioMicNames 麦克风设备列表
CRVideo_GetAudioSpkNames 扬声器设备列表
CRVideo_SetAudioCfg 设置系统音频参数
CRVideo_GetAudioCfg 获取系统音频参数
CRVideo_GetMicEnergy 麦克风声音大小
CRVideo_OpenMic 打开麦克风
CRVideo_CloseMic 关闭麦克风
CRVideo_GetAudioStatus 麦克风状态
CRVideo_GetAudioStatus 获取麦克风音量
CRVideo_SetMicVolume 设置麦克风音量
CRVideo_GetSpeakerVolume 获取扬声器音量
CRVideo_SetSpeakerVolume 设置扬声器音量
CRVideo_SetSpeakerMute 设置扬声器是否静音
CRVideo_GetSpeakerMute 获取扬声器是否静音
CRVideo_SetAllAudioClose 关闭所有人麦克风
回调 CRVideo_AudioDevChanged 麦克风设备变化
CRVideo_AudioStatusChanged 麦克风状态变化
CRVideo_MicEnergyUpdate 麦克风声音变化

视频管理

方式 接口 描述
主调 CRVideo_GetVideoWallMode2 获取视频墙当前分屏模式
CRVideo_SetVideoWallMode2 设置视频墙分屏模式
CRVideo_GetVideoCfg 获取视频参数
CRVideo_SetVideoCfg 设置视频参数
CRVideo_GetVideoStatus 获取视频状态
CRVideo_GetDefaultVideo 获取默认视频
CRVideo_SetDefaultVideo 设置默认视频
CRVideo_GetAllVideoInfo 摄像头设备列表
CRVideo_SetVideoDenoise 开启或关闭摄像头降噪处理
CRVideo_GetVideoDenoise 获取是否开启摄像头降噪
CRVideo_CreateScreenCamDev 创建桌面摄像头(sdk最大支持5个)
CRVideo_UpdateScreenCamDev 更新桌面摄像头
CRVideo_DestroyScreenCamDev 消毁桌面摄像头
CRVideo_CreateCustomVideoDev 创建自定义摄像头(sdk最大支持5个)
CRVideo_DestroyCustomVideoDev 消毁自定义摄像头
CRVideo_InputCustomVideoDat 输入摄像头图像数据
CRVideo_GetWatchableVideos 房间内可观看摄像头列表
CRVideo_OpenVideo 打开用户的摄像头
CRVideo_CloseVideo 关闭用户的摄像头
CRVideo_GetEnableMutiVideo 获取是否启用多摄像头
CRVideo_GetVideoImg 摄像头图像数据
CRVideo_ShowVideoAdvCfgDlg 调出摄像头驱动的高级配置(只对真实物理摄像头有效)
CRVideo_SetLocVideoAttributes 视频设备私有参数配置
CRVideo_GetLocVideoAttributes 获取某个摄像头私有参数
CRVideo_SetEnableMutiVideo 设置用户是否启用多摄像头
CRVideo_AddIPCam 添加网络摄像头
CRVideo_DelIPCam 移除网络摄像头
回调 CRVideo_VideoDevChanged 摄像头设备变化
CRVideo_VideoStatusChanged 视频状态变化

屏幕共享

方式 接口 描述
主调 CRVideo_GetScreenShareCfg 获取屏幕共享配置
CRVideo_SetScreenShareCfg 设置屏幕共享配置
CRVideo_StartScreenShare 停止屏幕共享
CRVideo_RequestShare 请求某人开启屏幕共享
CRVideo_CancelShareRequestion 取消屏幕共享请求
CRVideo_RejectShareRequestion 拒绝分享请求
CRVideo_GetShareScreenDecodeImg 屏幕共享图像数据
CRVideo_SetCustomizeScreenImg 自定义的抓屏图像数据
CRVideo_GiveCtrlRight 赋予控制权限
CRVideo_ReleaseCtrlRight 收回控制权限
CRVideo_SendMouseCtrlMsg 发送鼠标控制消息
CRVideo_SendKeyCtrlMsg 发送键盘控制消息
回调 CRVideo_StartScreenShareRslt 开启屏幕共享的响应事件
CRVideo_StopScreenShareRslt 停止屏幕共享的响应事件
CRVideo_NotifyScreenShareStarted 收到他人开启了屏幕共享的通知
CRVideo_NotifyScreenShareStopped 收到他人停止了屏幕共享的通知
CRVideo_NotifyGiveCtrlRight SDK通知远程控制权限给予了他人
CRVideo_NotifyReleaseCtrlRight SDK通知他人收回屏幕共享操作权限
CRVideo_NotifyRequestShare 请求屏幕共享通知
CRVideo_NotifyCancelShareRequestion 取消屏幕共享请求通知
CRVideo_NotifyRejectShareRequestion 拒绝屏幕共享请求通知

影音共享

方式 接口 描述
主调 CRVideo_StartPlayMedia 开始播放影音
CRVideo_PausePlayMedia 暂停或恢复播放影音
CRVideo_StopPlayMedia 停止播放影音
CRVideo_SetMediaplaypos 设置播放进度
CRVideo_SetMediacfg 配置远程影音共享时,图像质量参数
CRVideo_GetMediacfg 获取影音共享的图像质量参数
CRVideo_GetAllFilesInMediaPath 影音文件列表
CRVideo_Getmediainfo 影音播放信息
CRVideo_Getmediaimg 获取影音图像数据
CRVideo_StartGetAudioPCM 开始获取语音pcm数据
CRVideo_StopGetAudioPCM 停止获取语音pcm数据
回调 CRVideo_NotifyMediaOpened 通知影音文件打开
CRVideo_NotifyMediaStart 通知影音开始播放
CRVideo_NotifyMediaStop 通知影音播放停止
CRVideo_NotifyMediaPause 通知影音播放是否暂停
CRVideo_NotifyPlayPosSetted 通知更新影音播放进度
CRVideo_NotifyAudioPCMDat 通知语音PCM数据

本地录制/本地直播

方式 接口 描述
主调 CRVideo_CreateLocMixer 创建本地混图器
CRVideo_UpdateLocMixerContent 更新本地混图器内容
CRVideo_DestroyLocMixer 消毁本地混图器
CRVideo_GetLocMixerState 获取本地混图器状态
CRVideo_AddLocMixerOutput 开启本地录制、直播推流
CRVideo_RmLocMixerOutput 停止本地录制、直播推流
CRVideo_GetAllRecordFiles 录制文件列表
CRVideo_CancelFileTransfer 取消传输
CRVideo_CancelUploadRecordFile 取消上传录像文件
CRVideo_UploadRecordFile 上传录像文件
CRVideo_PlaybackRecordFile 回放录制文件
CRVideo_AddFileToRecordMgr 添加本地文件到录制文件管理中
CRVideo_RemoveFromFileMgr 删除本地的录制文件
CRVideo_UploadRecordFile2 上传录像文件
CRVideo_GetRecordFileInfo 获取录制文件信息
回调 CRVideo_LocMixerStateChanged 本地录制、本地直播状态变化通知
CRVideo_LocMixerOutputInfo 本地录制文件、本地直播信息通知
CRVideo_NotifyRecordFileStateChanged 通知录制文件状态更改
CRVideo_NotifyRecordFileUploadProgress 通知上传录制文件进度
CRVideo_UploadRecordFileErr 录制文件上传错误

云端录制/互动直播

方式 接口 描述
主调 CRVideo_StartSvrMixer 开始云端录制、云端直播
CRVideo_UpdateSvrMixerContent 更新云端录制、云端直播内容
CRVideo_StopSvrMixer 停止云端录制、云端直播
CRVideo_GetSvrMixerState 获取云端录制、云端直播状态
回调 CRVideo_SvrMixerStateChanged 云端录制、云端直播状态变化通知
CRVideo_SvrMixerCfgChanged 云端录制、云端直播内容变化通知
CRVideo_SvrMixerOutputInfo 云端录制文件、云端直播信息变化通知

电子白板/文档共享

方式 接口 描述
主调 CRVideo_Createboard 创建白板
CRVideo_Closeboard 关闭白板
CRVideo_InitBoardPageDat 初始化白板图元数据
CRVideo_CreateElementID 生成白板图元ID
CRVideo_Addboardelement 添加图元信息
CRVideo_ModifyBoardElement 修改图元信息
CRVideo_Delboardelement 删除图元
CRVideo_Setmousehotspot 设置白板鼠标热点
CRVideo_SetBoardCurPageNo 白板翻页
CRVideo_ListNetDiskDocFile 查询文档列表
CRVideo_UploadDocFileToNetDisk 上传文档并转换
CRVideo_DownloadDocSrcFile 下载源始文档
CRVideo_CancelTransforNetDiskDocFile 取消文档传输
CRVideo_DeleteNetDiskDocFile 删除文档
CRVideo_GetNetDiskDocFilePageInfo 获取文档的转换信息
CRVideo_GetNetDiskDocFilePageInfo 下载文档转换后的页文件
CRVideo_SetPicResource 添加图片资源
回调 CRVideo_NotifyInitBoards 通知初始化电子白板列表
CRVideo_NotifyInitBoardPageDat 通知初始化白板内图元数据
CRVideo_NotifyCreateBoard 通知创建白板
CRVideo_NotifyCloseBoard 通知关闭白板
CRVideo_NotifyBoardBkImage 通知白板背景
CRVideo_NotifyAddBoardElement 通知添加图元信息
CRVideo_NotifyModifyBoardElement 通知图元信息被修改
CRVideo_NotifyDelBoardElement 通知删除图元
CRVideo_NotifyMouseHotSpot 通知白板鼠标热点
CRVideo_NotifyBoardCurPageNo 通知白板翻页
CRVideo_UndoEnableChange 通知白板的“撤消”功能是否可用
CRVideo_RedoEnableChange 通知白板的“恢复”功能是否可用
CRVideo_ListNetDiskDocFileRslt 通知查询文档列表结果
CRVideo_GetNetDiskDocFilePageInfoRslt 通知查询文档转换结果
CRVideo_DeleteNetDiskDocFileRslt 通知删除文档结果
CRVideo_NotifyNetDiskDocFileTrsfProgress 通知文档传输进度
CRVideo_NotifyNetDiskIsFull 通知网盘空间已满

可视化组件:

模块 方式 接口 描述
影音共享UI显示组件 主调 CRVideo_CreatMediaObj 创建media对象
disableToolBar 工具条是否可用
shows UI组件的显示
hidden UI组件的隐藏
handler object对象
style UI组件的样式
width UI组件的宽度
height UI组件的高度
id id
keepAspectRatio 绘制模式,是否拉伸绘制
dblClickFullScreen 设置是否支持双击全屏,默认不支持双击全屏
savePicToBase64 保存播放影音画面到图片文件
savePicToFile 保存播放影音画面到图片文件
setToolBarUIElementVisible 显示隐藏播放工具条上的界面元素
setToolBarSize 设置工具条的高度
setFullScreen 设置全屏
getFullScreen 获取全屏
屏幕共享UI显示组件 主调 CRVideo_CreatScreenShareObj 创建screenShare对象
clear 清空缓存的图像
ctrlOpen 开启控制模式
disableFloatToolbar 禁止出现浮动工具条
isCursorInUI 鼠标是否在屏幕共享显示控件上
getCursorPosInRemote 鼠标在本地的屏幕共享UI控件上时,鼠标位置映射到远端的屏幕上的坐标
getPicWidth 获取远端屏幕的实际宽度
getPicHeight 获取远端屏幕的实际高度
enableMarked 开启标注模式
isPicEmpty 检查图像是否为空
keepAspectRatio 绘制模式,是否拉伸绘制
savePic 拍照
setPenStyle 设置标注画笔样式
setFullScreen 设置全屏
getFullScreen 获取全屏
setDblClickFullScreen 配置是否允许双击全屏
getDblClickFullScreen 获取是否允许双击全屏
成员视频UI显示组件 主调 CRVideo_CreatVideoObj 创建video对象
clear object对象
getVideoID 获取当前显示的用户的视频设备
setVisibleNickName 设置是否显示昵称
getVisibleNickName 获取是否显示昵称
handler object对象
style 成员视频UI显示组件的样式
width 成员视频UI显示组件宽度
height 成员视频UI组件的高度
id id
isPicEmpty 检查图像是否为空
getPicFrameTime 获取图像时间戳
keepAspectRatio 设置显示的视频画面是否保持比例
dblClickFullScreen 设置是否支持双击全屏,默认不支持双击全屏
savePic 拍照
pathFileName 本地绝对路径文件名(支持格式:bmp, png, gif, jpg, jpeg)
setSavePicRect 设置拍照区域
getPicWidth 获取图像宽
getPicHeight 获取图像高
setFullScreen 设置全屏
getFullScreen 获取全屏
setVideo 设置显示的目标用户视频
setVideo2 设置显示目标用户的第2、第3档视频
getQualityLv 获取当前显示的视频档位
setMaskPic 在视频窗口上显示一个遮罩图片
shows 成员视频UI显示组件显示
hidden 成员视频UI显示组件的隐藏
白板显示UI显示组件 主调 CRVideo_CreatBoardObj 创建board对象
id id
width 白板显示UI显示组件宽度
height 白板显示UI显示组件高度
getBoardIDs 获取当前房间内的所有白板ID
getBoardInfo 获取指定白板的信息
getCurBoardID 获取当前显示的白板
getCurPageNo 获取当前白板的当前页
setCurBoard 设置当前白板
undo 撤消我的最后一个标注
redo 恢复我的最后一次撤消
clear 清空当前白板所有标注(清空操作不能再恢复)
isScaledContents 获取白板当前的缩放模式,缩放模式下内容将被缩小或放大以填充有效区域,非缩放模式下图像将按原始尺寸显示并可能出现滚动条
setScaledContents 设置白板的缩放模式
setColor 设置画笔颜色
getColor 获取当前画笔颜色
setLineWidth 设置画笔粗细
getLineWidth 获取当前画笔宽带
setReadOnly 设置白板本地只读(本地禁止标注,其他端不受影响)
isReadOnly 获取白板本地只读配置

Http文件管理组件

方式 接口 描述
主调 CRVideo_StartHttpMgr 开启http文档上传下载功能
CRVideo_StopHttpMgr 停止http文档上传下载功能
CRVideo_GetAllTransferInfos 获取所有本地上传、下载文件信息
CRVideo_GetTransferInfo 获取本地指定文件的上传、下载文件信息
CRVideo_StartTransferFile 开始/取消传输文件
CRVideo_CancelFileTransfer 取消传输
CRVideo_RmTransferInfo 删除传输记录
回调 CRVideo_FileStateChanged 通知用户文件状态更改
CRVideo_FileProgress 通知文件传输(上传/下载)进度
CRVideo_FileFinished 通知用户文件传输结束
CRVideo_FileHttpRspHeader 通知http响应消息的header数据
CRVideo_FileHttpRspContent 通知上传完成后,http的响应内容

接口详情

CRVideo_GetSDKJsVersion()

  • 功能: 获取Web js版本号

  • 返回值:云屋SDK js的版本号(string)

CRVideo_PluginVersion()

  • 功能: 获取Plugin版本号

  • 返回值:Plugin版本号(string)

CRVideo_SdkPath()

  • 功能: 获取sdk所在的目录

  • 返回值:返回sdk所在的目录(string)

CRVideo_EnableLog2File(bEnable)

  • 功能: 设置是否开启日志

  • 返回值:无

参数 类型 含义
bEnable number 1表示开启日志,0表示不开启日志

SDK中日志功能默认是打开的,这个接口在CRVideo_Init2之前可调用

CRVideo_EnableLogReport(bEnable)

  • 功能: 设置是否开启日志上报

  • 返回值:无

参数 类型 含义
bEnable number 1表示开启日志上报,0表示不开启日志上报

SDK中日志上报默认是打开的,这个接口在CRVideo_Init2之前可调用

CRVideo_SetSDKParams(jsonVal)

  • 功能: 设置SDK参数

  • 返回值:无

  • 参数:json格式,具体可用参数如下:

//使用格式如下:
{"NoQueue":	0}
参数 取值 含义
NoQueue 0/1(缺省:0) 设为1可加快登录速度(适合于不使用sdk的排队功能的业务,如:临柜双录业务、链接入 会业务)
Timeout (缺 省:90000) 网络通信超时时间,单位是毫秒
DatEncType 0/1 (缺省:1) 数据加密类型(0:敏感数据加密,1:全面加密)

这个接口在init之前调用有效

CRVideo_SetFileUploadRate(maxbps)

  • 功能: 文件上传的流量控制(SDK默认不开启流控,目前对文件上传控制的功能有:录制文件上传、网盘文件上传。)

  • 返回值:无

参数 类型 含义
maxbps number 每秒上传的最大字节数,小于等于0表示不开启流控

CRVideo_SetFileDownloadRate(maxBytePerSec)

  • 功能: 文件下载的流量控制

  • 返回值:无

参数 类型 含义
maxBytePerSec number 每秒下载的最大字节数。-1代表不进行流控

CRVideo_SetAliyunOssAccountInfo(accessKey,accessSecret)

  • 功能: 设置阿里云OSS信息

  • 返回值:无

参数 类型 含义
accessKey string 用于标示用户
accessSecret string 用户用于加密签名字符串和OSS用来验证签名字符串的密钥

参考阿里云的用户签名验证相关文档 :https://help.aliyun.com/document_detail/31950.html?spm=a2c4g.11186623.6.707.44c0734ctzHsOa

CRVideo_WriteLog(level, log)

  • 功能: 向日志文件中写入内容

  • 返回值:无

参数 类型 含义
level number 详见CRVideo_E_LOG_LEVEL_DEF
log string 日志内容

CRVideo_Init2(sdkFilePath, isCallSer, isMediaSer, isHttp)

  • 功能: 登录

  • 返回值:返回错误码(错误码为CRVideo_NOERR表示没有错误)(number)

参数 类型 含义
sdkFilePath string SDK工作目录,用于存储配置文件、临时文件、录制文件、影音文件、日志等文件,如果传空值,则默认为sdk的安装目录
isCallSer number 是否启用callSer模块。 0为不启用,1为启用。(可缺省,缺省为1)
isMediaSer number 是否启用mediaSer模块。 0为不启用,1为启用,(可缺省,缺省为1)
isHttp number 是否启用http模块。0为不启用,1为启用,(可缺省,缺省为0)
  • 注意:程序开始时init,程序结束时uninit,整个程序的生命周期中只进行一次初始化和反初始化。
  • 注意目录的读写权限,如果目录只读,则无法在此目录下生成其他文件和文件夹

CRVideo_Init2等价于CRVideo_Init,功能一致;CRVideo_Init2为新增的接口,比CRVideo_Init少了一个oemID参数。两个方法是完全兼容,新版本均使用CRVideo_Init2方法

CRVideo_Uninit()

  • 功能: SDK反初始化

  • 返回值:无

  • 参数:无

CRVideo_SetServerAddr(serverList)

  • 功能: 设置服务器地址
  • 返回值:无
参数 类型 含义
serverList string 服务器地址,多个服务器地址使用分号隔开(如:www.cloudroom.com:8080;183.60.47.52:8080;)

CRVideo_Login(appID, md5_appSecret, nickName, UID, userAuthCode, cookie)

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

登陆成功则回调CRVideo_LoginSuccess,登陆失败则回调CRVideo_LoginFail

CRVideo_LoginSuccess.callback = function(UID,cookie){}

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

CRVideo_LoginFail.callback = function(sdkErr,cookie){}

  • 功能: 登录失败回调,登录出错,可以弹出错误提示,或调用登录接口再次重试登录

CRVideo_Logout

  • 功能: 注销
/**
* 注销本次登陆
* @access public
*/
CRVideo_Logout()

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

CRVideo_GetAllMembers()

  • 功能: 房间成员列表

  • 返回值:返回含多个成员信息(Array ------CRVideo_MemberInfo

CRVideo_GetMemberInfo(UID)

  • 功能: 房间成员信息

  • 返回值:返回用户UID的成员信息(CRVideo_MemberInfo

参数 类型 含义
UID string 用户ID

CRVideo_GetMemberNickName(UID)

  • 功能: 房间成员昵称

  • 返回值:用户UID的昵称(string)

参数 类型 含义
UID string 用户ID

CRVideo_IsUserInMeeting(UID)

  • 功能: 用户是否在房间中

  • 返回值:如果用户存在则返回true,否则返回false(bool)

参数 类型 含义
UID string 用户的id

CRVideo_SetNickName(userid,strNickName)

  • 功能: 设置某个用户的昵称

  • 返回值: 无

参数 类型 含义
userid string 用户ID
strNickName string 新的用户昵称

回调函数 CRVideo_SetNickNameRsp 调用此接口如果设置成功,其他会话用户会收到 CRVideo_NotifyNickNameChanged

CRVideo_GetScreenShareCfg()

CRVideo_SetScreenShareCfg(jsonCfg)

  • 功能: 设置屏幕共享配置

  • 返回值:无

参数 类型 含义
jsonCfg CRVideo_ScreenShareCfgObj 屏幕共享配置

CRVideo_StartScreenShare()

  • 功能: 开启屏幕共享

  • 返回值:无

CRVideo_StopScreenShare()

  • 功能: 停止屏幕共享

  • 返回值:无

CRVideo_RejectShareRequestion(requesterId,param)

  • 功能: 拒绝分享请求

CRVideo_SetCustomizeScreenImg(format, width, heigh, dat)

  • 功能: 自定义的抓屏图像数据

  • 返回值:无

参数 类型 含义
format CRVideo_VIDEO_FORMAT 视频格式
width number 图像的宽度
heigh number 图像的高度
dat string 承载argb数据,base64编码

CRVideo_GiveCtrlRight(UID)

  • 功能: 赋予控制权限

  • 返回值:无

参数 类型 含义
UID string 用户ID

CRVideo_ReleaseCtrlRight(UID)

  • 功能: 收回控制权限

  • 返回值:无

参数 类型 含义
UID string 用户ID

CRVideo_SendMouseCtrlMsg(msgType, mouseMsgType, x, y)

  • 功能: 发送鼠标控制消息

  • 返回值:无

参数 类型 含义
msgType CRVideo_MOUSE_MSG_TYPE 鼠标事件类型
mouseMsgType CRVideo_MOUSE_KEY_TYPE 鼠标键类型
x number 鼠标在屏幕中的横坐标
y number 鼠标在屏幕中的纵坐标

CRVideo_SendKeyCtrlMsg(keyMsgType, vk, bExtendedKey)

  • 功能: 发送键盘控制消息

  • 返回值:无

参数 类型 含义
keyMsgType CRVideo_KEY_MSG_TYPE 键盘事件类型
vk number 键盘虚拟键值
bExtendedKey number -

CRVideo_GetShareScreenDecodeImg()

CRVideo_StartScreenShareRslt.callback = function(sdkEr){}

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

CRVideo_StopScreenShareRslt.callback = function(sdkEr){}

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

CRVideo_NotifyRequestShare.callback = function(sharerId,requesterId, param){}

  • 功能:SDK通知请求屏幕共享
  • 参数
    • sharerId ----- 共享者ID
    • requesterId ----- 请求者ID
    • param ----- 自定义参数

CRVideo_NotifyCancelShareRequestion.callback = function(sharerId,requesterId){}

  • 功能:SDK通知取消屏幕共享请求
  • 参数
    • sharerId ----- 共享者ID
    • requesterId ----- 请求者ID

CRVideo_NotifyRejectShareRequestion.callback = function(requesterId,sharerId, param){}

  • 功能:SDK通知拒绝屏幕共享请求
  • 参数
    • requesterId ----- 请求者ID
    • sharerId ----- 共享者ID
    • param ----- 自定义参数

CRVideo_RequestShare(sharerId,param)

  • 功能: 请求某人开启屏幕共享

  • 返回值: 无

参数 类型 含义
sharerId number 需要开启共享的用户ID
param string 自定义参数,可传空

CRVideo_CancelShareRequestion(sharerId)

  • 功能: 取消屏幕共享请求

  • 返回值: 无

参数 类型 含义
sharerId number 需要取消的共享者ID,与CRVideo_RequestShare的参数对应

CRVideo_RejectShareRequestion(requesterId,param)

  • 功能: 拒绝分享请求

  • 返回值: 无

参数 类型 含义
requesterId number 请求者ID
param string 自定义参数,可传空

CRVideo_NotifyScreenShareStarted.callback = function(){}

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

CRVideo_NotifyScreenShareStopped.callback = function(){}

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

CRVideo_NotifyScreenShareData.callback = function(UID,rect){}

  • 功能:通知对端屏幕图像有变化
  • 参数
    • UID ----- 用户ID
    • rect ----- 变化的区域;(可以只重绘这块区域)

CRVideo_NotifyCatchScreen.callback = function(){}

  • 功能:自定义抓屏时,SDK通知使用者抓屏(在收到通知时, 一定要及时CRVideo_SetCustomizeScreenImg,如果没图像时,可以先送入空图像)

CRVideo_NotifyGiveCtrlRight.callback = function(operId,targetId){}

  • 功能:SDK通知远程控制权限给予了他人
  • 参数
    • operId ----- 操作的用户ID
    • targetId ----- 控制权限给予了谁

CRVideo_NotifyReleaseCtrlRight.callback = function(operId,targetId){}

  • 功能:SDK通知他人收回屏幕共享操作权限
  • 参数
    • operId ----- 操作的用户ID
    • targetId ----- 收回了谁的控制权限

CRVideo_NotifyShareRectChanged.callback = function(w,h){}

  • 功能:通知屏幕共享大小改变
  • 参数
    • w ----- 宽度
    • h ----- 高度

CRVideo_CreateLocMixer(mixerID, mixerCfg, mixerContent)

  • 功能: 创建本地混图器

  • 返回值: 错误码

参数 类型 含义
mixerID string 混图器唯一标识
mixerCfg CRVideo_MixerCfgObj 混图器规格配置,json格式
mixerContent CRVideo_MixerContentObj 混图器内容配置,json格式

CRVideo_UpdateLocMixerContent(mixerID,mixerContent)

  • 功能: 更新本地混图器内容

  • 返回值: 错误码

参数 类型 含义
mixerID string 混图器唯一标识
mixerContent CRVideo_MixerContentObj 混图器内容配置,json格式

CRVideo_DestroyLocMixer(mixerID)

  • 功能: 消毁本地混图器

  • 返回值: 无

参数 类型 含义
mixerID string 混图器唯一标识

CRVideo_GetLocMixerState(mixerID)

参数 类型 含义
mixerID string 混图器唯一标识

CRVideo_AddLocMixerOutput(mixerID, mixerOutput)

  • 功能: 开启本地录制、直播推流

  • 返回值: 错误码

参数 类型 含义
mixerID string 混图器唯一标识,请确保创建了有效的混图器CRVideo_CreateLocMixer
mixerOutput CRVideo_MixerOutputObj 混图器输出配置,json格式
  • 注意事项:

    • 可以一次添加多个输出,也可以依据业务需要稍后再添加新的输出;
    • 多个输出不能同名、或同一url;
    • 每个输出,有独立的信息通知,请见事件CRVideo_LocMixerOutputInfo.如果输出异常时,将自动停止;

CRVideo_RmLocMixerOutput(mixerID,nameOrUrl)

  • 功能: 停止本地录制、直播推流

  • 返回值: 无

参数 类型 含义
mixerID string 混图器唯一标识
nameOrUrl string 要停止的录制文件名或直播url,支持多值,以";"分隔;

注意事项:所有输出停止后并不会消毁混图器,如果混图器不再需要请手工消毁;

CRVideo_GetAllRecordFiles()

CRVideo_CancelFileTransfer(fileName)

  • 功能: 取消传输

  • 返回值:无

参数 类型 含义
fileName string 本地路径文件名

取消时,只是停止了传输任务,不清理记录及断点文件

CRVideo_CancelUploadRecordFile(filename)

  • 功能: 取消上传录像文件

  • 返回值:无

参数 类型 含义
filename string 文件名

CRVideo_UploadRecordFile(filename)

  • 功能: 上传录像文件

  • 返回值:无

参数 类型 含义
filename string 文件名

上传文件在默认位置

CRVideo_UploadRecordFile2(fileName,svrPathFileName)

  • 功能: 上传录像文件

  • 返回值:无

参数 类型 含义
filename string 文件名
svrPathFileName string 服务器路径文件名

上传文件到服务器指定位置

CRVideo_PlaybackRecordFile(filename)

  • 功能: 回放录制文件

  • 返回值:无

参数 类型 含义
filename number 文件名

CRVideo_LocMixerStateChanged.callback = function(mixerID,state){}

  • 功能:SDK通知本地录制、本地直播状态变化

CRVideo_LocMixerOutputInfo.callback = function(mixerID,nameOrUrl,outputInfo){}

  • 功能:SDK通知本地录制文件、本地直播信息通知
  • 参数
    • mixerID ----- 混图器唯一标识
    • nameOrUrl ----- 录像名称、或直播url
    • outputInfo ----- json结构的字符串,请参见CRVideo_MixerOutputInfoObj

CRVideo_NotifyRecordFileStateChanged.callback = function(fileName,state){}

  • 功能:SDK通知录制文件状态更改
  • 参数
    • fileName ----- 本地文件路径
    • state ----- 状态: 0未上传 1上传中 2已上传

CRVideo_NotifyRecordFileUploadProgress.callback = function(fileName,percent){}

  • 功能:SDK通知上传录制文件进度
  • 参数
    • fileName ----- 文件名
    • percent ----- 进度0-100

CRVideo_UploadRecordFileErr.callback = function(fileName,sdkEr){}

  • 功能:上传录制文件错误通知
  • 参数
    • fileName ----- 本地文件路径
    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF

CRVideo_StartSvrMixer(mutiMixerCfgs, mutiMixerContents,mutiMixerOutputs)

  • 功能: 开始云端录制、云端直播

  • 返回值: 错误码

参数 类型 含义
mutiMixerCfgs CRVideo_MutiMixerCfgsObj 服务器混图配置
mutiMixerContents CRVideo_MutiMixerContentsObj 服务器混图内容
mutiMixerOutputs CRVideo_MutiMixerOutputsObj 服务器输出

注意事项 : 启动云端功能有一定耗时,请关注混图器的状态变化事件CRVideo_SvrMixerStateChanged 每个输出有私有的状态变化事件CRVideo_SvrMixerOutputInfo

CRVideo_UpdateSvrMixerContent(mutiMixerContents)

  • 功能: 更新云端录制、云端直播内容

  • 返回值: 错误码

参数 类型 含义
mutiMixerContents CRVideo_MutiMixerContentsObj 服务器混图内容

CRVideo_StopSvrMixer()

  • 功能: 停止云端录制、云端直播

  • 返回值: 无

注意事项 : 停止有有一定耗时,请关注混图器的状态变化事件svrMixerStateChanged 每个输出有私有的状态变化事件svrMixerOutputInfo

CRVideo_GetSvrMixerState()

CRVideo_SvrMixerStateChanged.callback = function(state, err,operatorID){}

  • 功能:SDK通知云端录制、云端直播状态变化

CRVideo_SvrMixerCfgChanged.callback = function(){}

  • 功能:SDK通知云端录制、云端直播内容变化
  • 参数:无

CRVideo_SvrMixerOutputInfo.callback = function(outputInfo){}

  • 功能:SDK通知云端录制文件、云端直播信息变化

CRVideo_Createboard(title, width, height, pageCount)

  • 功能: 创建白板

  • 返回值:白板 boardID

参数 类型 含义
title string 白板名称
width number 白板宽度
height number 白板高度
pageCount number 白板内有多个页(一般空白板1页,文档白板为实际页数

其他参会者会收到:CRVideo_NotifyCreateBoard事件;同时后台会记录下白板数据,新入会者会收到:CRVideo_NotifyInitBoards事件.注意:创建完白板后,一定要及尽快调用CRVideo_InitBoardPageDat初始化各页数据

CRVideo_Closeboard(boardID)

  • 功能: 关闭白板

  • 返回值:无

参数 类型 含义
boardID string 白板标识

其他参会者将收到CRVideo_NotifyCloseBoard事件;同时后台会移除对应白板的所有信息

CRVideo_InitBoardPageDat(boardID, boardPageNo, imgID, elemets)

  • 功能: 初始化白板图元数据

  • 返回值:无

参数 类型 含义
boardID string 白板标识
boardPageNo number 白板第几页(0:代表第一页)
imgID string 白板的背景图片标识(空代表无背影图)
elemets string 白板的初始图元(空代表无图元,一般在导入历史文件才用到)
  1. imgID非空时, 代表背景的图片ID。 img来源请参见CRVideo_GetNetDiskDocFilePageInfo
  1. 其他参会者将收到CRVideo_NotifyInitBoardPageDat事件;
  1. 后台会记录下白板的页数据,在新用户入会时,也会收到CRVideo_NotifyInitBoardPageDat事件

CRVideo_CreateElementID()

  • 功能: 生成白板图元ID

  • 返回值:图元id

本地操作;所有白板图元id,必须由此接口创建;(历史文件存储的图元id,在房间内不能再使用,应重新创建)

CRVideo_Addboardelement(boardID, boardPageNo, element)

  • 功能: 添加图元信息

  • 返回值:elementID ----- 图元标识

参数 类型 含义
boardID string 白板标识
boardPageNo number 白板的页序号(0为第一页)
element string 图元信息,参见json格式之CRVideo_BoardElementObj

其他参会者会收到:CRVideo_NotifyAddBoardElement事件;同时后台会保存图元,新入会者会在CRVideo_NotifyInitBoardPageDat中得到这些图元

CRVideo_ModifyBoardElement(boardID, boardPageNo, element)

  • 功能: 修改图元信息

  • 返回值:elementID图元标识(string)

参数 类型 含义
boardID string 白板标识
boardPageNo number 白板的页序号(0为第一页)
element string 图元信息,参见json格式之 CRVideo_BoardElementObj

说明:其他参会者会收到:CRVideo_NotifyModifyBoardElement事件;同时后台会覆盖对应图元的数据,新入会者会在CRVideo_NotifyInitBoardPageDat中得到这些图元

CRVideo_Delboardelement(boardID, boardPageNo, elementIDs)

  • 功能: 删除图元

  • 返回值:无

参数 类型 含义
boardID string 白板标识
boardPageNo number 白板的页序号(0为第一页)
elementIDs string 图元id列表,多值时,以“;”分隔,如:“id1;id2”

说明:其他参会者会收到:CRVideo_NotifyDelBoardElement事件;同时后台会移除这些图元,新入会者会在CRVideo_NotifyInitBoardPageDat中将不包含这些图元

CRVideo_Setmousehotspot(boardID, boardPageNo, x, y)

  • 功能: 设置白板鼠标热点

  • 返回值:无

参数 类型 含义
boardID string 白板标识
boardPageNo number 白板的页序号(0为第一页)
x number 屏幕横坐标
y number 屏幕纵坐标

CRVideo_SetBoardCurPageNo(boardID, boardPageNo, pagePos1, pagePos2)

  • 功能: 白板翻页

  • 返回值:无

参数 类型 含义
boardID string 白板标识
boardPageNo number 白板的页序号(0为第一页)
pagePos1 number 私有扩展参数1(如可用于页内x方向滚动位置)
pagePos2 number 私有扩展参数2(如可用于页内y方向滚动位置)

CRVideo_ListNetDiskDocFile(dir)

参数 类型 含义
dir string 要查询的目录,空或"/"时,代表查询根目录下的内容;

查询服务器指定目录下的内容(子目录名、上传的文档源文件及文档转换状态)

CRVideo_UploadDocFileToNetDisk(svrPathFileName,locPathFileName)

  • 功能: 上传文档并转换

  • 返回值:无

参数 类型 含义
svrPathFileName string 服务器的路径文件名,包含目录时,服务器自动创建对应目录
locPathFileName string 要上传文件的本地的路径文件名

上传进度请参见CRVideo_NotifyNetDiskDocFileTrsfProgress, 转换结果请调用CRVideo_ListNetDiskDocFile或者CRVideo_GetNetDiskDocFilePageInfo

说明:支持的文件格式有:doc,docx, ppt, pptx, pps, ppsx, xls, xlsx, et, ett, wps, wpt, dps, pdf, txt, log, ini, bmp, png, jpg, jpeg;

CRVideo_DownloadDocSrcFile(svrPathFileName, locPathFileName)

  • 功能: 下载源始文档

  • 返回值:无

参数 类型 含义
svrPathFileName string 服务器的路径文件名
locPathFileName string 文件下载后存放的本地的路径文件名,目录不存在时自动创建

下载进度请参见CRVideo_NotifyNetDiskDocFileTrsfProgress

CRVideo_CancelTransforNetDiskDocFile(svrPathFileName)

  • 功能: 取消文档传输

  • 返回值:无

参数 类型 含义
svrPathFileName string 服务器的路径文件名

CRVideo_DeleteNetDiskDocFile(svrPathFileName)

参数 类型 含义
svrPathFileName string 服务器的路径文件名

CRVideo_GetNetDiskDocFilePageInfo(svrPathFileName)

参数 类型 含义
svrPathFileName string 服务器的路径文件名

说明:获取到的文档转换后的信息后, 就可以创建白板CRVideo_Createboard, 然后为白板初始化文档内容CRVideo_InitBoardPageDat

CRVideo_DeleteNetDiskDocFile(CRVideo_DownloadNetDiskDocFilePage(pagePathFileName, locPathFileName))

参数 类型 含义
pagePathFileName string 页文件在服务器的路径文件名
locPathFileName string 文件下载后存放的本地的路径文件名,目录不存在时自动创建

说明:页文件格式: 6字节保留,4字节图像格式(2:jpg, 4:png),4字节图像内容长度,图像内容

CRVideo_SetPicResource(resourceid, picJsonVal)

  • 功能: 添加图片资源

  • 返回值:无

参数 类型 含义
resourceid string 资源唯一标识;(可以是guid,也可以序号方式)
picJsonVal object 资源内容,json格式,详见CRVideo_PicResourceObj说明

CRVideo_NotifyInitBoards.callback = function(BoardObjs){}

  • 功能:SDK入会后通知房间中已经存在的白板列表
  • 参数
    • BoardObjs ----- 已经创建好的白板列表, json结构体请参见CRVideo_BoardObjs说明

CRVideo_NotifyInitBoardPageDat.callback = function(boardID,boardPageNo,imgID,elementDatas,operatorID){}

  • 功能:通知初始化白板内图元数据
  • 参数
    • boardID ----- 白板标识
    • boardPageNo ----- 白板页序号
    • imgID ----- 页背景文件ID(空代表无背景)
    • elementDatas ----- 此页的所有图元, 详见json结构之CRVideo_BoardElementObjs
    • operatorID ----- 初始化用户(为空时,代表入会时后台事件)

CRVideo_NotifyCreateBoard.callback = function(jsonBoard,operatorID){}

  • 功能:SDK通知创建白板
  • 参数
    • jsonBoard ----- 白板信息,详见json格式之CRVideo_BoardObj
    • operatorID ----- 创建白板的用户ID

CRVideo_NotifyCloseBoard.callback = function(boardID,operatorID){}

  • 功能:SDK通知关闭白板
  • 参数
    • boardID ----- 白板标识
    • operatorID ----- 关闭白板的用户ID

CRVideo_NotifyBoardBkImage.callback = function(subPage,imgFileID,operatorID){}

  • 功能:SDK通知白板背景
  • 参数
    • subPage ----- 白板信息
    • imgFileID ----- 背景图片文件,通过downloadNetDiskFile可下载到本地显示
    • operatorID ----- 操作用户ID

CRVideo_NotifyAddBoardElement.callback = function(boardID,boardPageNo,element,operatorID){}

  • 功能:SDK通知添加图元信息
  • 参数
    • boardID ----- 白板标识
    • boardPageNo ----- 白板页序号
    • element ----- 此页的所有图元, 详见json结构之CRVideo_BoardElementObj
    • operatorID ----- 添加图元的用户ID

CRVideo_NotifyModifyBoardElement.callback = function(boardID,boardPageNo,element,operatorID){}

  • 功能:SDK通知图元信息被修改
  • 参数
    • boardID ----- 白板标识
    • boardPageNo ----- 白板页序号
    • element ----- 此页的所有图元, 详见json结构之CRVideo_BoardElementObj
    • operatorID ----- 添加图元的用户ID

应从页内找到旧的图元并替换;

CRVideo_NotifyDelBoardElement.callback = function(boardID,boardPageNo,elementIDs,operatorID){}

  • 功能:SDK通知删除图元
  • 参数
    • boardID ----- 白板标识
    • boardPageNo ----- 白板页序号
    • elementIDs ----- 图元id列表,以 “;”分隔
    • operatorID ----- 删除图元的用户ID

CRVideo_NotifyMouseHotSpot.callback = function(boardID,x,y,operatorID){}

  • 功能:SDK通知设置鼠标热点消息
  • 参数
    • boardID ----- 白板标识
    • x ----- 屏幕横坐标
    • y ----- 屏幕纵坐标
    • operatorID ----- 操作者的用户ID

CRVideo_NotifyBoardCurPageNo.callback = function(boardID, pageNo, pagePos1, pagePos2, operatorID){}

  • 功能:SDK通知通知白板翻页
  • 参数
    • boardID ----- 白板标识
    • pageNo ----- 翻到第几页
    • pagePos1 ----- 扩展参数1
    • pagePos2 ----- 扩展参数2
    • operatorID ----- 操作者的用户ID

CRVideo_UndoEnableChange.callback = function(isEnable){}

  • 功能:SDK通知白板的“撤消”功能是否可用
  • 参数
    • isEnable ----- 撤消功能是否可用(bool)

CRVideo_RedoEnableChange.callback = function(isEnable){}

  • 功能:SDK通知白板的“恢复”功能是否可用
  • 参数
    • isEnable ----- 恢复功能是否可用(bool)

CRVideo_ListNetDiskDocFileRslt.callback = function(dir, sdkErr, rslt){}

  • 功能 通知查询文档列表结果

CRVideo_GetNetDiskDocFilePageInfoRslt.callback = function(svrPathFileName, sdkErr,rslt) {}

  • 功能 通知查询文档转换结果

CRVideo_DeleteNetDiskDocFileRslt.callback = function(svrPathFileName, sdkERR) {}

  • 功能: 通知删除文档结果
  • 参数:
    • svrPathFileName ----- 查询的文档名
    • sdkERR ----- 删除结果,0代表删除成功, 错误码取值参考CRVideo_ERR_DEF

CRVideo_NotifyNetDiskDocFileTrsfProgress.callback = function(svrPathFileName, percent){}

  • 功能 通知文档传输进度
  • 参数
    • svrPathFileName ----- 传输的文档,或页文件名
    • percent ----- 传输进度(等于100代表传输完成)

CRVideo_NotifyNetDiskIsFull.callback = function(fileList){}

  • 功能:SDK通知网盘空间已满,容量不足
  • 参数
    • fileList ----- 文件列表

CRVideo_GetOpenFileName(title,directory,filter)

  • 功能:获取用户打开的全路径文件名

  • 返回值: 结果,空串表示用户取消, 否则返回用户选择的文件路径文件名

参数 类型 含义
title string 打开文件框的标题
directory string 打开对话框初始路径,不设初始值时请传空
filter string 文件类型过滤器(可为空),示例:"Images (*.png *.xpm .jpg);;Text files (.txt)"

CRVideo_GetSaveFileName(title,directory,filter)

  • 功能:获取用户保存的全路径文件名

  • 返回值: 结果,空串表示用户取消, 否则返回用户保存的文件路径文件名

参数 类型 含义
title string 打开文件框的标题
directory string 打开对话框初始路径,不设初始值时请传空
filter string 文件类型过滤器(可为空),示例:"Images (*.png *.xpm .jpg);;Text files (.txt)"

CRVideo_SendCmd(targetUserId, data)

  • 功能:发送小块数据

  • 返回值:分配的任务ID(string)

参数 类型 含义
targetUserId string 目标用户ID
data string 发送的数据

一次性发送不会有进度通知,发送结果事件CRVideo_SendCmdRlst,CRVideo_SendCmd不能被CRVideo_CancelSend

CRVideo_SendBuffer(targetUserId, data)

  • 功能:发送大块数据(分块发送)

  • 返回值:分配的任务ID(string)

参数 类型 含义
targetUserId string 目标用户ID
data string 发送的数据

进度通知事件CRVideo_SendProgress,发送结果事件CRVideo_SendBufferRlst,取消发送CRVideo_CancelSend

CRVideo_SendFile(targetUserId, fileName)

  • 功能:发送文件(分块发送 )

  • 返回值:分配的任务ID(string)

参数 类型 含义
targetUserId string 目标用户ID
fileName string 需要发送的文件名

进度通知事件CRVideo_SendProgress,发送结果事件CRVideo_SendFileRlst,取消发送CRVideo_CancelSend)

CRVideo_CancelSend(taskID)

  • 功能: 取消数据发送

  • 返回值:无

参数 类型 含义
taskID string 任务ID

取消数据发送 操作完成则回调CRVideo_CancelSendRlst

CRVideo_SendIMmsg(text, UserID, cookie)

  • 返回值:任务id(string)
参数 类型 含义
text string 发送的文本消息
UserID string 目标用户,如果用户ID为空,消息发送给房间内所有用户
cookie string 详细介绍见关键词

响应事件CRVideo_SendIMmsgRlst

CRVideo_SendIMmsgRlst.callback = function(taskID,sdkEr,cookie){}

  • 功能:发送IM消息,SDK通知使用者发送结果
  • 参数
    • taskID ----- 发送任务id
    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • cookie ----- 详细介绍见关键词

CRVideo_NotifyIMmsg.callback = function(fromUserID,text,sendTime){}

  • 功能:SDK通知收到IM消息
  • 参数
    • fromUserID ----- 消息来源
    • text ----- 消息内容
    • sendTime ----- 消息发送时间戳,从1970开始算起

CRVideo_InitQueueDat(cookie)

  • 功能: 初始化队列

  • 返回值:无

参数 类型 含义
cookie string 详细介绍见关键词

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

CRVideo_RefreshAllQueueStatus()

  • 功能: 刷新所有队列状态

  • 返回值:无

操作完成则触发CRVideo_QueueStatusChanged(当前排队的队列,或服务的队列,sdk自动有状态变化回调)

CRVideo_GetAllQueueInfo()

  • 功能: 查询队列

  • 返回值:返回所有队列信息(Array ----- CRVideo_QueueInfo

CRVideo_GetQueueStatus(queID)

参数 类型 含义
queID string 队列ID

CRVideo_GetQueuingInfo()

CRVideo_GetServingQueues()

  • 功能: 获取我服务的所有队列

  • 返回值:返回我服务的队列列表(Array)

CRVideo_GetSessionInfo()

CRVideo_StartQueuing2(queID,usrExtDat,cookie)

  • 功能: 开始排队

  • 返回值:无

参数 类型 含义
queID string 队列ID
usrExtDat string 用户排队携带的扩展数据, 座席在服务时可获得。
cookie string 详细介绍见关键词

带自定义扩展参数。 操作完成回调CRVideo_StartQueuingRslt

CRVideo_StopQueuing(cookie)

  • 功能: 停止排队

  • 返回值:无

参数 类型 含义
cookie string 详细介绍见关键词

操作完成回调CRVideo_StopQueuingRslt

CRVideo_StartService2(queID,priority,cookie)

  • 功能: 开始服务队列

  • 返回值:无

参数 类型 含义
queID number 队列ID
priority number 坐席优先级 (缺省为0,取值为0~1000内整数。值越小优先级越高。0为最高优先级 ))
cookie string 详细介绍见关键词

可以多次调用,开启对多个队列的服务。操作回调CRVideo_StartServiceRslt 开启成功后: a. 如果没有开启免打挽,那么系统会自动分配客户:CRVideo_AutoAssignUser; b. 如果开启免打挽,系统就不会分配客户,如需服务客户可调用:CRVideo_ReqAssignUser 座席优先级描述:

  1. 座席优先级只在服务的队列内部有效;
  2. 客户优先分配给服务此队列优先级最高的,且空闲的座席;
  3. 优先级相同时,则分配给最先空闲的座席;
  4. 优先级高的座席变空闲时,不抢夺已分配的客户;

CRVideo_StopService(queID, cookie)

  • 功能: 停止服务队列

  • 返回值:无

参数 类型 含义
queID string queID 队列ID
cookie string 详细介绍见关键词

操作完成回调CRVideo_StopServiceRslt

CRVideo_ReqAssignUser(cookie)

  • 功能: 请求分配一个客户

  • 返回值:无

参数 类型 含义
cookie string 详细介绍见关键词

回调函数:CRVideo_ReqAssignUserRslt

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

CRVideo_AcceptAssignUser(queID, UID, cookie)

  • 功能: 接受分配的客户
参数 类型 含义
queID string 队列ID
UID string 队列中的用户ID
cookie string 详细介绍见关键词

CRVideo_RejectAssignUser(queID, UID, cookie)

  • 功能: 拒绝分配的客户

  • 返回值:无

参数 类型 含义
queID string 队列ID
UID string 队列中的用户ID
cookie string 详细介绍见关键词

CRVideo_InitQueueDatRslt.callback = function(sdkEr,cookie){}

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

CRVideo_QueueStatusChanged.callback = function(queStatus){}

  • 功能:队列状态变化通知

CRVideo_QueuingInfoChanged.callback = function(queuingInfo){}

  • 功能:排队信息变化通知

CRVideo_StartQueuingRslt.callback = function(sdkEr,cookie){}

  • 功能:开始排队操作结果

CRVideo_StopQueuingRslt.callback = function(sdkEr,cookie){}

  • 功能:停止排队操作结果

CRVideo_StartServiceRslt.callback = function(queID,sdkEr,cookie){}

  • 功能:开始服务队列操作结果
  • 参数
    • queID ----- 服务的队列ID
    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • cookie ----- 详细介绍见关键词

CRVideo_StopServiceRslt.callback = function(queID,sdkEr,cookie){}

  • 功能:停止服务队列操作结果
  • 参数
    • queID ----- 服务的队列ID
    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • cookie ----- 详细介绍见关键词

CRVideo_ResponseAssignUserRslt.callback = function(sdkEr,cookie){}

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

CRVideo_AutoAssignUser.callback = function(user){}

  • 功能:系统自动安排客户

CRVideo_ReqAssignUserRslt.callback = function(sdkEr,user,cookie){}

  • 功能:请求分配客户操作结果

CRVideo_CancelAssignUser.callback = function(queID,userid){}

  • 功能:系统取消之前分配的的客户
  • 参数
    • queID ----- 服务的队列
    • userid ----- 用户id

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

CRVideo_Call(calledUserID, meetObj, usrExtDat, cookie)

  • 功能: 发起呼叫

  • 返回值:返回本次呼叫标识码(呼叫ID)

参数 类型 含义
calledUserID string 被叫用户的账户ID
meetObj CRVideo_MeetInfoObj 房间信息
usrExtDat string 自定义扩展参数
cookie string 详细介绍见关键词

操作成功则回调CRVideo_CallSuccess,失败则回调CRVideo_CallFail。 呼叫时,对方迟迟不响应,30秒后系统自动结束呼叫

CRVideo_AcceptCall(callID, meetObj, usrExtDat, cookie)

  • 功能: 接受对方发起的呼叫
参数 类型 含义
callID string 呼叫ID
meetObj CRVideo_MeetInfoObj 房间信息
usrExtDat string 自定义扩展参数
cookie string 详细介绍见关键词

开始进入视频房间。操作成功则回调CRVideo_AcceptCallSuccess,失败则回调CRVideo_AcceptCallFail

CRVideo_RejectCall(callID, usrExtDat, cookie)

  • 功能: 拒绝对方发起的呼叫

  • 返回值:无

参数 类型 含义
callID string 呼叫ID
usrExtDat string 自定义扩展参数
cookie string 详细介绍见关键词

操作成功则回调CRVideo_RejectCallSuccess,失败则回调CRVideo_RejectCallFail

CRVideo_HungupCall(callID, usrExtDat, cookie)

  • 功能: 挂断呼叫

  • 返回值:无

参数 类型 含义
callID string 呼叫ID
usrExtDat string 自定义扩展参数
cookie string 详细介绍见关键词

操作成功则回调CRVideo_HangupCallSuccess,失败则回调CRVideo_HangupCallFail

CRVideo_CallSuccess.callback = function(callID ,cookie){}

  • 功能:呼叫他人操作成功响应
  • 参数
    • callID ----- 呼叫全局标识
    • cookie ----- 详细介绍见关键词

CRVideo_CallFail.callback = function(callID,sdkEr,cookie){}

  • 功能:呼叫他人操作失败响应
  • 参数
    • callID ----- 呼叫全局标识
    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • cookie ----- 详细介绍见关键词

CRVideo_AcceptCallSuccess.callback = function(callID,cookie){}

  • 功能:接受他人呼叫操作成功响应
  • 参数
    • callID ----- 呼叫全局标识
    • cookie ----- 详细介绍见关键词

CRVideo_AcceptCallFail.callback = function(callID,sdkEr,cookie){}

  • 功能:接受他人呼叫操作失败响应
  • 参数
    • callID ----- 呼叫全局标识
    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • cookie ----- 详细介绍见关键词

CRVideo_RejectCallSuccess.callback = function(callID,cookie){}

  • 功能:拒绝他人的呼叫成功响应
  • 参数
    • callID ----- 呼叫全局标识
    • cookie ----- 详细介绍见关键词

CRVideo_RejectCallFail.callback = function(callID,sdkEr,cookie){}

  • 功能:拒绝他人的呼叫失败响应
  • 参数
    • callID ----- 呼叫全局标识
    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • cookie ----- 详细介绍见关键词

CRVideo_HangupCallSuccess.callback = function(callID,cookie){}

  • 功能:挂断他人的呼叫成功响应
  • 参数
    • callID ----- 呼叫全局标识
    • cookie ----- 详细介绍见关键词

CRVideo_HangupCallFail.callback = function(callID,sdkEr,cookie){}

  • 功能:挂断呼叫操作失败响应
  • 参数
    • callID ----- 呼叫全局标识
    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • cookie ----- 详细介绍见关键词

CRVideo_NotifyCallIn.callback = function(callID,meetObj,callerID,usrExtDat){}

  • 功能:SDK通知自己被呼叫
  • 参数
    • callID ----- 呼叫全局标识
    • meetObj ----- 房间信息
    • callerID ----- 呼叫人员的标识ID
    • usrExtDat ----- 自定义扩展参数

CRVideo_NotifyCallAccepted.callback = function(callID,meetObj,usrExtDat){}

  • 功能:SDK通知自己视频呼叫被对方接受
  • 参数
    • callID ----- 呼叫全局标识
    • meetObj ----- 房间信息
    • usrExtDat ----- 自定义扩展参数

CRVideo_NotifyCallRejected.callback = function(callID,sdkErr,usrExtDat){}

  • 功能:SDK通知自己呼叫被对方拒绝
  • 参数
    • callID ----- 呼叫全局标识
    • sdkErr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • usrExtDat ----- 自定义扩展参数

CRVideo_NotifyCallHungup.callback = function(callID,usrExtDat){}

  • 功能:SDK通知自己呼叫被挂断
  • 参数
    • callID ----- 呼叫全局标识
    • usrExtDat ----- 自定义扩展参数

CRVideo_SendCmdRlst.callback = function(taskID,sdkEr,cookie){}

  • 功能:发送小块数据时,SDK通知发送结果
  • 参数
    • taskID ----- 发送任务id
    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • cookie ----- 详细介绍见关键词

CRVideo_SendBufferRlst.callback = function(taskID,sdkEr,cookie){}

  • 功能:发送大块数据时,SDK通知发送结果
  • 参数
    • taskID ----- 发送任务id
    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • cookie ----- 详细介绍见关键词

CRVideo_SendFileRlst.callback = function(taskID,fileName,sdkEr,cookie){}

  • 功能:发送文件时,SDK通知发送结果
  • 参数
    • taskID ----- 发送任务id
    • fileName ----- 文件名
    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • cookie ----- 详细介绍见关键词

CRVideo_SendProgress.callback = function(taskID,sendedLen,totalLen,cookie){}

  • 功能:发送数据时,SDK通知发送进度
  • 参数
    • taskID ----- 发送任务id
    • sendedLen ----- 已发送的数据长度
    • totalLen ----- 需要发送的总长度
    • cookie ----- 详细介绍见关键词

CRVideo_CancelSendRlst.callback = function(taskID,sdkEr,cookie){}

  • 功能:取消发送响应
  • 参数
    • taskID ----- 发送任务id
    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • cookie ----- 详细介绍见关键词

CRVideo_NotifyCmdData.callback = function(sourceUserId,data){}

  • 功能:SDK通知收到小块数据
  • 参数
    • sourceUserId ----- 发送数据的用户id
    • data ----- 数据的内容(string)

CRVideo_NotifyBufferData.callback = function(sourceUserId,data){}

  • 功能:SDK通知收到大块数据
  • 参数
    • sourceUserId ----- 发送数据的用户id
    • data ----- 数据的内容(string)

CRVideo_NotifyFileData.callback = function(sourceUserId,tmpFile,orgFileName){}

  • 功能:SDK通知收到文件数据(收到的文件生成在系统临时目录下,请尽快移走对应文件)
  • 参数
    • sourceUserId ----- 发送数据的用户id
    • tmpFile ----- 临时文件,不需要时,请移除或删除对应文件
    • orgFileName ----- 源始文件名

CRVideo_NotifyCancelSend.callback = function(taskID){}

  • 功能:SDK通知取消发送文件数据
  • 参数
    • taskID ----- 取消的任务id

CRVideo_GetVideoWallMode2()

  • 功能: 获取视频墙当前分屏模式

  • 返回值:分屏模式(业务层自由定义)

CRVideo_SetVideoWallMode2(videoWallMode)

  • 功能: 设置视频墙分屏模式

  • 返回值:无

参数 类型 含义
videoWallMode CRVideo_VIDEOLAYOUTMODE 分屏模式

CRVideo_GetVideoCfg()

CRVideo_SetVideoCfg(cfg)

  • 功能: 视频设置

  • 返回值: 设置成功与否,true/false

参数 类型 含义
cfg CRVideo_VideoCfg 设置参数

CRVideo_GetVideoStatus(UID)

  • 功能: 视频状态

  • 返回值:麦克风摄像头状态(CRVideo_VSTATUS

参数 类型 含义
UID string 用户ID

CRVideo_GetDefaultVideo(UID)

  • 功能: 获取默认视频

  • 返回值:返回摄像头ID (number)

参数 类型 含义
UID string 用户ID

CRVideo_SetDefaultVideo(UID, videoID)

  • 功能: 设置默认视频

  • 返回值:无

参数 类型 含义
UID string 用户ID
videoID number 摄像头ID

注意:
1、如果用户只有一个摄像头,可以不设置默认摄像头;
2、如果用户有多个摄像头,但是只想用其中一个,需要把这个设置为默认摄像头;
3、如果用户有多个摄像头,全都要用到,就不需要设置默认摄像头,打开摄像头时会全部打开;
4、如果用户有多个摄像头,想用到其中部分几个摄像头,不用设置默认摄像头,但是要先启用多摄像头,然后调用CRVideo_SetLocVideoAttributes把不想用的禁用了,之后打开的时候就只打开没禁用的那几个;

CRVideo_GetAllVideoInfo(userID)

  • 功能: 获取用户的所有摄像头信息

  • 返回值:用户的所有摄像头信息列表,数据类型为:CRVideo_VideoInfosObj

参数 类型 含义
userID string 用户ID

CRVideo_SetVideoDenoise(bDenoise)

  • 功能: 开启或关闭摄像头降噪处理

  • 返回值:无

参数 类型 含义
bDenoise bool 取值true时,开启降噪处理

CRVideo_GetVideoDenoise()

  • 功能: 获取是否开启摄像头降噪

  • 返回值:true:降噪已开启,false:降噪未开启

CRVideo_CreateScreenCamDev(camName,monitor)

  • 功能: 创建桌面摄像头(sdk最大支持5个)

  • 返回值:<0, 失败, >=0, 为videoID(摄像头ID) (number)

参数 类型 含义
camName string 摄像头名称
monitor number 显示器序号,与系统显示编号一致,-1代表主屏。(创建时对应monitorID不存在时将失败, 运行中monitorID对应的屏关闭时显示全黑,开启后恢复正常工作)

添加成功后与本地摄像头处理一致;getAllVideoInfo接口可以识别摄像头类型。

CRVideo_UpdateScreenCamDev(videoID,monitor)

  • 功能: 更新桌面摄像头

  • 返回值:false失败, true成功 (bool)

参数 类型 含义
videoID number 摄像头id
monitor number 显示器序号,与系统显示编号一致,-1代表主屏。(monitorID不存在时将失败)

CRVideo_DestroyScreenCamDev(videoID)

  • 功能: 消毁桌面摄像头

  • 返回值:无

参数 类型 含义
videoID number 摄像头id

CRVideo_CreateCustomVideoDev(camName,pixFmt,width,height,extParams)

  • 功能: 创建自定义摄像头(sdk最大支持5个)

  • 返回值: <0 ,失败; >=0, 为videoID(摄像头ID) (number)

参数 类型 含义
camName string 摄像头名称
pixFmt number 参见 CRVideo_VIDEO_FORMAT定义
width number 图像宽度
height number 图像高度
extParams string 扩展参数,没有为空

添加成功后与本地摄像头处理一致;getAllVideoInfo接口可以识别摄像头类型。

CRVideo_DestroyCustomVideoDev(videoID)

  • 功能: 消毁自定义摄像头

  • 返回值: 无

参数 类型 含义
videoID number 摄像头id (CRVideo_CreateCustomVideoDev返回值)

CRVideo_InputCustomVideoDat(videoID,base64Dat,timeStamp)

  • 功能: 输入摄像头图像数据

  • 返回值: 无

参数 类型 含义
videoID number 摄像头id
base64Dat string 图像数据,base64编码。(请保证格式、和尺寸与摄像头匹配)
timeStamp number 保留字段,请填0

CRVideo_GetWatchableVideos()

  • 功能: 房间内可观看摄像头列表

  • 返回值:对象VideoIDArray(Array ------ CRVideo_VideoIDsObj

只有摄像头打开才能被获取到,能获取到自已的和房间里其他人的

CRVideo_OpenVideo(UID)

  • 功能: 打开用户的摄像头

  • 返回值:无

参数 类型 含义
UID string 用户的ID

打开用户的摄像头,以便本地、远端显示视频图像

CRVideo_CloseVideo(UID)

  • 功能: 关闭用户的摄像头

  • 返回值:无

参数 类型 含义
UID string 用户ID

CRVideo_GetEnableMutiVideo(UID)

  • 功能: 获取是否启用多摄像头

  • 返回值:用户是否多摄像头(bool)

参数 类型 含义
UID string 用户ID

CRVideo_GetVideoImg()

参数 类型 含义
UID string 用户ID
videoID number 设备id

CRVideo_ShowVideoAdvCfgDlg(videoID, hParenWnd)

  • 功能: 调出摄像头驱动的高级配置(只对真实物理摄像头有效)

  • 返回值:true/false

参数 类型 含义
videoID number 摄像头id
hParenWnd number 高级配置界面的父窗口, 没有特别需求传0即可

CRVideo_SetLocVideoAttributes(videoID, jsonAttributes)

  • 功能: 视频设备私有参数配置

  • 返回值:无

参数 类型 含义
videoID string 本地摄像头id
jsonAttributes json格式 支持的参数有:{"disabled": 取值0/1},1:代表不启用此摄像头;详见VideoAttributesObj

注:未设置的参数,使用全局参数

CRVideo_GetLocVideoAttributes(videoID)

  • 功能: 获取某个摄像头私有参数

  • 返回值:私有参数, json格式,详见(VideoAttributesObj

参数 类型 含义
videoID string 本地摄像头id

CRVideo_SetEnableMutiVideo(UID,enable)

  • 功能: 设置用户是否启用多摄像头
参数 类型 含义
UID string 用户ID (当前只能配置自已)
enable bool 1表示开启(将启用本地所有摄像头),0表示关闭(只启用默认摄像头,CRVideo_SetDefaultVideo

如果只想开启某几个摄像头(不是所有), 那么需要:CRVideo_SetEnableMutiVideo(myUserID, true), 然后调用CRVideo_SetLocVideoAttributes将不需要的摄像头disable掉。

CRVideo_AddIPCam(url)

  • 功能: 添加网络摄像头(sdk最大支持5个)

  • 返回值:sdkErr 操作结果码, 0代成功, 非0代表入会失败,定义见CRVideo_ERR_DEF

参数 类型 含义
url string 网络摄像头url,支持协议:rtmp,rtsp

添加成功后与本地摄像头处理一致;CRVideo_GetAllVideoInfo接口可以识别哪些是网络摄像头。

CRVideo_DelIPCam(url)

  • 功能: 移除网络摄像头

  • 返回值:无

参数 类型 含义
url string 网络摄像头url,支持协议:rtmp,rtsp

CRVideo_VideoDevChanged.callback = function(UID){}

  • 功能:SDK通知用户的视频设备有变化
  • 参数
    • UID ----- 设备变化的用户ID

CRVideo_VideoStatusChanged.callback = function(UID,oldStatus,newStatus){}

  • 功能:SDK通知打开本地视频状态变化
  • 参数
    • UID ----- 房间中设备的所有者ID
    • oldStatus ----- 旧状态
    • newStatus ----- 新状态

CRVideo_Switchtopage(mainPage, pageID)

  • 功能: 功能切换

  • 返回值:无

参数 类型 含义
mainPage number 功能类型
pageID string 子页面标识(如创建白板时返回的boardID)

CRVideo_Getcurrentmainpage()

CRVideo_Getcurrentsubpage()

  • 功能: 获取当前子页面

  • 返回值:返回pageID(如:创建白板时返回的boardID)

CRVideo_GetMainVideo()

  • 功能: 获取当前哪个用户为主视频

  • 返回值:无

CRVideo_SetMainVideo(UID)

  • 功能: 设置当前哪个用户为主视频

  • 返回值:无

参数 类型 含义
UID string 用户ID

CRVideo_SetDNDStatus(DNDStatus, cookie)

  • 功能: 设置免打扰状态

  • 返回值:无

参数 类型 含义
DNDStatus number 0代表关闭免打扰, 其它值代表开启免打扰,含义自由定义
cookie string 自定义数据 (在回调时,回传给调用者)

操作成功则回调CRVideo_SetDNDStatusSuccess,失败则回调CRVideo_SetDNDStatusFail

  • 如果是使用到了SDK的队列功能,则入会后需调用此接口,设置自己的为免打扰状态,防止系统再次推送自己.

CRVideo_GetUserStatus(cookie)

  • 功能: 获取企业下所有用户在线状态

  • 返回值:无

参数 类型 含义
cookie string 自定义数据(在回调时,回传给调用者,不需要时传空字符串)

操作成功则回调CRVideo_GetUserStatusSuccess,失败则回调CRVideo_GetUserStatusFail

CRVideo_GetOneUserStatus(usrID,cookie)

  • 功能: 获取企业下指定用户的在线状态

  • 返回值:无

参数 类型 含义
usrID string 用户ID
cookie string 自定义数据(在回调时,回传给调用者,不需要时传空字符串)

操作成功则回调CRVideo_GetUserStatusSuccess,失败则回调CRVideo_GetUserStatusFail

CRVideo_StartUserStatusNotify(cookie)

  • 功能: 开启用户的状态推送

  • 返回值:无

参数 类型 含义
cookie number 自定义数据(在回调时,回传给调用者,不需要时传空字符串)

回调函数: CRVideo_StartUserStatusNotifyRslt

企业下所有用户状态有变化时包括呼叫房间状态、免打扰状态),都会收到通知开启后,用户量越大消息量越大,所以请按需开启在CRVideo_StartUserStatusNotify前,应该先通过CRVideo_GetUserStatus获取所有用户状态

CRVideo_StopUserStatusNotify(cookie)

  • 功能: 关闭用户的状态推送

  • 返回值:无

参数 类型 含义
cookie string 自定义数据(在回调时,回传给调用者,不需要时传空字符串)

回调函数: CRVideo_StopUserStatusNotifyRslt

CRVideo_CreateMeeting(meetSubject, needPswd, cookie)

CRVideo_CreateMeeting2(json, cookie)

  • 功能: 创建房间

  • 返回值:无

参数 类型 含义
meetSubject string 房间主题(字符长度最大值50)
needPswd number 是否创建房间密码(=0时:房间无密码,>0时:密码由系统自动生成)
cookie string 自定义数据 (在回调时,回传给调用者)
json CRVideo_CreatInfoObj 创建房间信息,json结构体定义请参见CRVideo_CreatInfoObj

操作成功则回调CRVideo_CreateMeetingSuccess,失败则回调CRVideo_CreateMeetingFail

CRVideo_DestroyMeeting(meetID, cookie)

  • 功能: 销毁房间

  • 返回值:无

参数 类型 含义
meetID number 房间id
cookie string 详细介绍见关键词

回调函数CRVideo_DestroyMeetingRslt

另外,会话中其他用户会收到CRVideo_MeetingStopped通知

CRVideo_GetMeetings(cookie)

CRVideo_GetMeetings2(json,cookie)

  • 功能: 获取房间列表

  • 返回值:无

参数 类型 含义
cookie string 详细介绍见关键词
json CRVideo_GetMeetingsParam 获取视频房间列表的参数,json结构体

响应事件CRVideo_GetMeetingsSuccess,房间被他人结束的回调事件CRVideo_GetMeetingsFail

CRVideo_SetNickNameRsp.callback = function(sdkErr,userid,newname){}

  • 功能:SDK通知设置房间成员昵称的结果
  • 参数
    • sdkErr ----- 操作结果码, 0代表设置成功, 非0代表设置失败
    • userid ----- 用户id
    • newname ----- 新的昵称

CRVideo_NotifyNickNameChanged.callback = function(userid,oldname,newname){}

  • 功能:SDK通知某用户改变了昵称(改昵称的用户自身不会接收到此通知)
  • 参数
    • userid ----- 用户id
    • oldname ----- 改变昵称的某用户昵称(改变之前的昵称)
    • newname ----- 改变昵称的某用户昵称(改变之后的昵称)

CRVideo_NotifyVideoWallMode2.callback = function(model){}

  • 功能:SDK通知视频分屏模式切换
  • 参数
    • model ----- 分屏模式

CRVideo_NotifyMainVideoChanged.callback = function(operId,targetId){}

  • 功能:SDK通知主视频更改

CRVideo_NotifySwitchToPage.callback = function(mainPage,pageID){}

  • 功能:SDK通知功能切换
  • 参数
    • mainPage ----- 功能类型
    • pageID ----- 子页面标识

CRVideo_DefVideoChanged.callback = function(UID,videoID){}

  • 功能:SDK通知用户的视频默认设备有变化
  • 参数
    • UID ----- 设备变化的用户ID
    • videoID ----- 默认设备id

CRVideo_NetStateChanged.callback = function(level){}

  • 功能:SDK通知我的网络变化
  • 参数
    • level ----- 网络状况等级(0~10,10分为最佳网络)

CRVideo_EnterMeeting(meetID, pswd, UID, nickName, cookie)

  • 功能: 进入房间

  • 返回值:无

参数 类型 含义
meetID number 房间ID
pswd string md5处理后的,本次房间中的密码(系统自动生成,在呼叫回调中取得)
UID string 用户id,, 命名规则 详见关键词
nickName string 昵称
cookie string 详细介绍见关键词

双方开始进入房间 操作完成则回调CRVideo_EnterMeetingRslt

CRVideo_ExitMeeting()

  • 功能: 离开房间

  • 返回值:无

CRVideo_EnterMeetingRslt.callback = function(sdkEr){}

  • 功能:进入房间完成响应

CRVideo_StopMeetingRslt.callback = function(sdkEr){}

  • 功能:通知结束视频房间结果

CRVideo_UserEnterMeeting.callback = function(usrID){}

  • 功能某用户进入了房间
  • 参数
    • usrID ----- 进入房间的用户ID

CRVideo_UserLeftMeeting.callback = function(id){}

  • 功能:某用户离开了房间
  • 参数
    • id ----- 离开房间的用户ID

CRVideo_MeetingDropped.callback = function(){}

  • 功能:SDK通知从房间里掉线了

CRVideo_MeetingStopped.callback = function(){}

  • 功能:房间已被结束

他人离开房间的回调事件CRVideo_UserLeftMeeting

CRVideo_StopMeeting(meetID,cookie)

  • 功能: 停止房间

  • 返回值:无

参数 类型 含义
meetID number 房间id
cookie string 详细介绍见关键词

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

CRVideo_SetDNDStatusSuccess.callback = function(cookie){}

  • 功能:客户端设置免打扰状态操作成功响应
  • 参数

CRVideo_SetDNDStatusFail.callback = function(sdkEr,cookie){}

  • 功能:客户端设置免打扰状态操作失败响应

CRVideo_GetUserStatusSuccess.callback = function(userStatus,cookie){}

  • 功能:客获取所有用户在线状态成功响应
  • 参数
    • userStatus ----- 用户在线状态信息列表,UID:用户id,userStatus:用户的在线状态(0离线 ;1在线空闲 ;2在线忙碌;3在线房间中),DNDType:用户免打扰状态(0代表关闭免打扰,其它值代表开启免打扰)
    • cookie ----- 详细介绍见关键词

CRVideo_GetUserStatusFail.callback = function(sdkEr ,cookie){}

  • 功能:获取所有用户在线状态失败响应

CRVideo_StartUserStatusNotifyRslt.callback = function(sdkEr ,cookie){}

  • 功能:启动用户状态推送响应

CRVideo_StopUserStatusNotifyRslt.callback = function(sdkEr ,cookie){}

  • 功能:结束用户状态推送响应

CRVideo_NotifyUserStatus.callback = function(userStatus ,cookie){}

  • 功能:某个用户状态变化通知
  • 参数
    • userStatus ----- userStatus单个用户在线状态信息
    • cookie ----- 详细介绍见关键词

CRVideo_LineOff.callback = function(sdkEr){}

  • 功能:SDK通知自己掉线

CRVideo_CreateMeetingSuccess.callback = function(meetObj,cookie){}

  • 功能:创建房间成功响应

CRVideo_CreateMeetingFail.callback = function(sdkEr ,cookie){}

  • 功能:创建房间失败响应

CRVideo_DestroyMeetingRslt.callback = function(sdkEr ,cookie){}

  • 功能:销毁房间响应

CRVideo_GetMeetingsSuccess.callback = function(jsonMeetings,cookie){}

  • 功能:获取房间列表成功响应

CRVideo_GetMeetingsFail.callback = function(sdkEr,cookie){}

  • 功能:获取房间列表失败响应

CRVideo_SetMediacfg(jsonCfg)

  • 功能: 配置远程影音共享时,图像质量参数

  • 返回值:无

参数 类型 含义
jsonCfg json格式 详见CRVideo_VideoCfg说明

CRVideo_GetMediacfg()

  • 功能: 获取影音共享时的图像质量参数

  • 返回值:json格式的音频参数,详见CRVideo_VideoCfg说明

CRVideo_GetAudioMicNames()

  • 功能: 麦克风设备列表

  • 返回值:返回麦克风设备字符串列表(Array)

CRVideo_GetAudioSpkNames()

  • 功能: 扬声器设备列表

  • 返回值:扬声器设备列表(Array)

CRVideo_SetAudioCfg(cfg)

  • 功能: 设置系统音频参数

  • 返回值:无

参数 类型 含义
cfg CRVideo_AudioCfg 设置参数

CRVideo_GetAudioCfg()

CRVideo_GetMicEnergy(UID)

  • 功能: 麦克风声音大小

  • 返回值:返回音量(0~10)(number)

参数 类型 含义
UID string 用户的ID

CRVideo_OpenMic(UID)

  • 功能: 打开麦克风

  • 返回值:无

参数 类型 含义
UID string 用户的ID

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

CRVideo_CloseMic(UID)

  • 功能: 关闭麦克风

  • 返回值:无

参数 类型 含义
UID string 用户的ID

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

CRVideo_GetAudioStatus(UID)

参数 类型 含义
UID string 用户的ID

双方开始进入本次视频会话。操作完成则回调CRVideo_EnterMeetingRslt

CRVideo_GetMicVolume()

  • 功能: 获取麦克风音量

  • 返回值:返回麦克风音量(0~255)(number)

CRVideo_SetMicVolume(level)

  • 功能: 设置麦克风音量

  • 返回值:设置成功则返回true,否则返回false(bool)

参数 类型 含义
level number 音量等级( 取值范围:0~255)

CRVideo_GetSpeakerVolume()

  • 功能: 获取扬声器音量

  • 返回值:返回扬声器音量(0~255)(number)

CRVideo_SetSpeakerVolume(level)

  • 功能: 设置扬声器音量

  • 返回值:设置成功则返回true,否则返回false(bool)

参数 类型 含义
level number 音量等级( 取值范围:0~255)

CRVideo_GetSpeakerMute()

  • 功能: 获取扬声器是否静音

  • 返回值:扬声器是否静音, 1,静音,0,不静音

CRVideo_SetSpeakerMute(value)

  • 功能: 设置扬声器是否静音

  • 返回值:设置成功则返回true,否则返回false(bool)

参数 类型 含义
value number 1,静音,0,不静音

CRVideo_SetAllAudioClose()

  • 功能: 关闭所有人麦克风

  • 返回值:无

CRVideo_AudioDevChanged.callback = function(){}

  • 功能: 麦克风设备变化

  • 功能:SDK通知本地音频设备有变化

CRVideo_AudioStatusChanged.callback = function(UID,oldStatus,newStatus){}

  • 功能:SDK通知打开本地音频状态变化
  • 参数
    • UID ----- 会话中设备的所有者ID
    • oldStatus ----- 旧状态
    • newStatus ----- 新状态

CRVideo_MicEnergyUpdate.callback = function(UID,oldLevel,newLevel){}

  • 功能:SDK通知用户的说话声音强度更新
  • 参数
    • UID ----- 用户ID
    • oldLevel ----- 原来的说话声音强度
    • newLevel ----- 现在的说话声音强度

CRVideo_StartPlayMedia(filename, locPlay, bPauseWhenFinished)

  • 功能: 开始播放影音

  • 返回值:返回值 整形数值,1:正常,0:失败(number)

参数 类型 含义
filename string 媒体文件名(本地全路径文件名,或网络流媒体,支持的协议有:http, rtmp, rtsp)
locPlay number 是否仅仅本地播放(1:本地播放,0:房间内播放)
bPauseWhenFinished number 是否播放完毕自动暂停在最后一帧

如果播放成功,其他人收到CRVideo_NotifyMediaStart,如果播放失败,请关注通知事件CRVideo_NotifyMediaStop

CRVideo_PausePlayMedia(bPause)

  • 功能: 暂停或恢复播放影音

  • 返回值:无

参数 类型 含义
bPause bool ture为暂停,false为恢复

CRVideo_StopPlayMedia()

  • 功能: 停止播放影音

  • 返回值:无

其他人收到CRVideo_NotifyMediaStop

CRVideo_SetMediaplaypos(pos)

  • 功能: 设置播放进度

  • 返回值:无

参数 类型 含义
pos number 设置播放位置,单位:毫秒

CRVideo_GetAllFilesInMediaPath()

  • 功能: 取得影音文件夹下的所有可播放文件

  • 返回值:文件名列表数组(Array)

影音文件夹位于方法CRVideo_Init2的第一个参数sdkFilePath,sdk会在此文件中建立media的子文件夹,即为影音文件夹

CRVideo_Getmediainfo(UID)

参数 类型 含义
UID string 用户id,详见UID

CRVideo_Getmediaimg(UID)

参数 类型 含义
UID string 用户id

CRVideo_StartGetAudioPCM(aSide, getType, jsonParam)

  • 功能: 开始获取语音pcm数据

  • 返回值:返回值 整形数值,1:正常,0:失败(number)

参数 类型 含义
aSide number 声道类型 0:麦克风,1:扬声器
getType number 获取方式 0:回调方式,1:保存为文件
jsonParam string 当getType=0 表示回调方式,jsonParam可配置回调的数据大小(320-32000),如: {"EachSize":320};当getType=1 表示保存为文件,jsonParam可配置文件名,如: { "FileName" : "e:\test.pcm" }

CRVideo_StopGetAudioPCM(aSide)

  • 功能: 停止获取语音pcm数据

  • 返回值:无

参数 类型 含义
aSide number 声道类型 0:麦克风,1:扬声器

CRVideo_NotifyMediaOpened.callback = function(totalTime,w,h){}

  • 功能SDK通知影音文件打开
  • 参数
    • totalTime ----- 影音时长(秒)
    • w ----- 宽度
    • h ----- 高度

CRVideo_NotifyMediaStart.callback = function(userid){}

  • 功能:SDK通知影音开始播放
  • 参数
    • userid ----- 操作者的用户id

CRVideo_NotifyMediaStop.callback = function(userid,reason){}

  • 功能:SDK通知影音播放停止

CRVideo_NotifyMediaPause.callback = function(userid,pause){}

  • 功能:SDK通知影音播放是否暂停
  • 参数
    • userid ----- 操作者的用户id
    • pause ----- 是否暂停 1暂停 0播放

CRVideo_NotifyPlayPosSetted.callback = function(setPTS){}

  • 功能:SDK通知播放进度已设置完成
  • 参数
    • setPTS ----- 播放进度

CRVideo_NotifyAudioPCMDat.callback = function(aSide,base64PcmDat){}

  • 功能:SDK通知语音PCM数据
  • 参数
    • aSide ----- 声道类型
    • base64PcmDat ----- PCM数据(base64格式)

UI显示组件公用接口

CRVideo.Container()

Methods

  • handler() ------ object对象
  • height() ------ 容器的高度
  • id() ------ id
  • style() ------ 容器的样式
  • width() ------ 容器的宽度
  • shows() ------ 容器的显示
  • hidden() ------ 容器的消失

影音共享UI显示组件

CRVideo_CreatMediaObj()

  • 功能: 创建media对象

  • 返回值:影音共享UI显示组件对象

  • 参数:无

Methods

  • disableToolBar(bDisable) ------ 工具条是否可用
参数 类型 说明
bDisable number 0:可用; 非0:不可用;
参数 类型 说明
value bool true: 保持比例不拉伸, false:不保持比例进行拉伸
  • dblClickFullScreen(value) ------ 设置是否支持双击全屏,默认不支持双击全屏
参数 类型 说明
value bool true: 支持双击全屏, false:不支持双击全屏
  • savePicToBase64(format) ------ 保存播放影音画面到图片文件
    • 返回值:Base64字符串 (string)
参数 类型 说明
format string 支持格式:bmp, png, gif, jpg, jpeg
  • savePicToFile(pathFileName) ------ 保存播放影音画面到图片文件
    • 返回值:0成功,非0失败 (number)
参数 类型 说明
pathFileName string 本地绝对路径文件名(支持格式:bmp, png, gif, jpg, jpeg)
  • setToolBarUIElementVisible(UIElement, isVisible) ------ 显示隐藏播放工具条上的界面元素
    • 返回值:无
参数 类型 说明
UIElement CRVideo_ToolBarUI 界面元素
isVisible bool 是否可见
  • setToolBarSize(size) ------ 设置工具条的高度
    • 返回值:无
参数 类型 说明
size number 工具条高度,范围(24-48)
  • style() ------ UI组件的样式

  • width() ------ UI组件的宽度

  • setFullScreen(bFullScreen) ------ 设置全屏

    • 返回值:无
参数 类型 说明
bFullScreen bool true :全屏
  • getFullScreen() ------ 获取全屏
    • 参数:无

    • 返回值: 表示该控件当前是否全屏,true 表示全屏

屏幕共享UI显示组件

CRVideo_CreatScreenShareObj()

  • 功能: 创建screenShare对象

  • 返回值:屏幕共享UI显示组件对象

  • 参数:无

Methods

  • clear() ------ 清空缓存的图像

  • ctrlOpen(value) ------ 开启控制模式

    • 返回值:无
参数 类型 说明
value bool true: 开启, false:不开启
  • disableFloatToolbar(bDisabled) ------ 禁止出现浮动工具条
    • 返回值:无
参数 类型 说明
bDisabled bool true:禁止出现, false:允许出现(缺省值)
  • isCursorInUI() ------ 鼠标是否在屏幕共享显示控件上

    • 返回值:鼠标是否在控件上,true- 在控件上; false - 不在控件上 (bool)
  • getCursorPosInRemote() ------ 鼠标在本地的屏幕共享UI控件上时,鼠标位置映射到远端的屏幕上的坐标

    • 返回值:映射到远端的屏幕上的坐标。数据格式:json格式,如:{"x"=1,"y"=1}
  • getPicWidth() ------ 获取远端屏幕的实际宽度

    • 返回值:远端屏幕的实际宽度(number)
  • getPicHeight() ------ 获取远端屏幕的实际高度

    • 返回值:远端屏幕的实际高度(number)
  • enableMarked(value) ------ 开启标注模式

    • 返回值:无
参数 类型 说明
value bool 0: 不开启, 1:开启
  • isPicEmpty(num) ------ 检查图像是否为空
    • 返回值:无
参数 类型 说明
value bool 0: 有图像, 1:无图像
  • keepAspectRatio(num) ------ 绘制模式,是否拉伸绘制
    • 返回值:无
参数 类型 说明
value bool true: 保持比例不拉伸, false:不保持比例进行拉伸
  • savePic(pathFileName) ------ 拍照
    • 返回值:0:成功; 非0:保存遇到的错误码(bool)
参数 类型 说明
pathFileName string 本地绝对路径文件名(支持格式:bmp, png, gif, jpg, jpeg)
  • setPenStyle(intRgba:, penWidth) ------ 设置标注画笔样式
    • 返回值:无
参数 类型 说明
intRgba num 颜色,排列方式bgr(8:8:8)
penWidth num 画笔宽度
  • setFullScreen(bFullScreen) ------ 设置全屏
    • 返回值:无
参数 类型 说明
bFullScreen bool true :全屏
  • getFullScreen() ------ 获取全屏

    • 参数:无

    • 返回值: 表示该控件当前是否全屏,true 表示全屏

  • setDblClickFullScreen(bVal) ------ 配置是否允许双击全屏

    • 返回值:无
参数 类型 说明
bVal bool true:允许(缺省值), false:不允许
  • getDblClickFullScreen() ------ 获取是否允许双击全屏
    • 参数:无

    • 返回值: 表示该控件是否允许双击全屏,true 允许, false:不允许

成员视频UI显示组件

CRVideo_CreatVideoObj()

  • 功能: 创建video对象

  • 参数:无

  • 返回值: 成员视频UI显示组件对象。

Methods

  • clear() ------ 清理当前图像

  • getVideoID() ------ 获取当前显示的用户的视频设备

    • 返回值:视频ID (string)
  • getVisibleNickName() ------ 获取是否显示昵称

    • 返回值:否显示昵称 (bool)
  • setMaskPic(base64PNG,bScaleToFitVideoUI) ------ 在视频窗口上显示一个遮罩图片

    • 返回值:无
参数 类型 说明
base64PNG string base64格式的png图像数据
bScaleToFitVideoUI bool true:铺满视频窗口,false:居中显示
  • handler() ------ object对象

  • height() ------ 成员视频UI组件的高度

  • id() ------ id

  • isPicEmpty() ------ 检查图像是否为空

    • 返回值:图像是否为空 (bool)
  • getPicFrameTime() ------ 获取图像时间戳

    • 返回值:当前图像数据对应的时间戳(number)
  • keepAspectRatio(value) ------ 设置显示的视频画面是否保持比例

参数 类型 说明
value bool true: 保持比例不拉伸, false:不保持比例进行拉伸
  • dblClickFullScreen(value) ------ 设置是否支持双击全屏,默认不支持双击全屏
参数 类型 说明
value bool true: 支持双击全屏, false:不支持双击全屏
  • savePic(pathFileName) ------ 拍照

    • 返回值:0:成功; 非0:保存遇到的错误码 (bool)
参数 类型 说明
pathFileName string 本地绝对路径文件名(支持格式:bmp, png, gif, jpg, jpeg)
  • savePicToBase64(format) ------ 拍照

    • 返回值:Base64为图片数据字符串,不成功则为空 (string)
参数 类型 说明
format string 图片格式,支持bmp, png, gif, jpg, jpeg
  • setMaskPic(base64PNG, scaleToFitVideoUI) ------ 在视频窗口上显示一个遮罩图片

    • 返回值:无
参数 类型 说明
base64PNG string base64格式的png图像数据
scaleToFitVideoUI bool true:铺满视频窗口,false:居中显示
  • setToolbarHeight(height) ------ 配置工具条高度

    • 返回值:无
参数 类型 说明
height number 工具条高度
  • setToolButton(id, iconFileName, toolTip) ------ 配置工具条内容

    • 返回值:无
参数 类型 说明
id number 按钮id
iconFileName string 按钮图标路径文件名
toolTip string 按钮的tooltip

同一id多次配置时,将以最后一次配置为准;当iconFileName为空时,则代表移除对应按钮;

  • setSavePicRect(x, y, w, h) ------ 设置拍照区域

    • 返回值:无
参数 类型 说明
x number 相对于VideoUI控件的左上角位置(水平方向)
y number 相对于VideoUI控件的左上角位置(垂直方向)
w number 拍照的图像大小(宽)
h number 拍照的图像大小(高)

注意:此设配置对以下所有保存接口有效, 当x,y,w,h均为0时,代表保存完整图像。

  • getPicWidth() ------ 获取图像宽

    • 返回值:图像宽
  • getPicHeight() ------ 获取图像高

    • 返回值:图像高
  • setFullScreen(bFullScreen) ------ 设置全屏

    • 返回值:无
参数 类型 说明
bFullScreen bool true :全屏
  • getFullScreen() ------ 获取全屏

    • 参数:无

    • 返回值: 表示该控件当前是否全屏,true 表示全屏

  • setVideo(UID, videoID) ------ 设置显示的目标用户视频

    • 返回值:无
参数 类型 说明
UID string 目标用户ID
videoID number 用户的指定视频设备(-1,代表用户的默认视频设备)
  • setVideo2(UID, videoID, qualityLv) ------ 设置显示目标用户的第2档视频

    • 返回值:无
参数 类型 说明
UID string 目标用户ID
videoID number 用户的指定视频设备(-1,代表用户的默认视频设备)
qualityLv number 视频档位(1:默认档位,2:对应quality2,如果2未开启时将显示1档的视频流)

房间内可观看摄像头列表中获取UID和videoID

开启一个摄像头多档视频流,请参见CRVideo_SetLocVideoAttributes

注意:配置后就会建立视频通道并占用带宽。 如果不再观看时,应设为空:setVideo("", -1)。

  • getQualityLv() ------ 获取当前显示的视频档位

    • 返回值: 视频档位
    • 参数:无
  • setVisibleNickName(value) ------ 设置是否显示昵称

    • 返回值:无
参数 类型 说明
value bool 是否显示昵称

白板显示UI显示组件

CloudroomBoardUI 白板显示组件,是由视频房间组件内相关接口的封装而成,如果此组件不满足需求,可以使用视频房间组件内相关的接口自行实现。

CRVideo_CreatBoardObj()

  • 功能: 创建board对象

  • 返回值:白板UI显示组件对象

  • 参数:无

Methods

  • handler() ------ object对象

  • id() ------ id

  • width() ------ 白板显示UI显示组件宽度

  • height() ------ 白板显示UI显示组件高度

  • getBoardIDs() ------ 获取当前房间内的所有白板ID

    • 返回值: 白板的ID,字符串数组 (string[])
  • getBoardInfo(boardID) ------ 获取指定白板的信息

  • getCurBoardID() ------ 获取当前显示的白板

    • 返回值: 白板的ID (string)
  • getCurPageNo() ------ 获取当前白板的当前页

    • 返回值: 页序号(0为第一页) (number)
  • setCurBoard(boardID, pageNo) ------ 设置当前白板

    • 返回值: 无
参数 类型 说明
boardID string 白板的ID
pageNo number 白板的页序号,0为第一页。
  • undo() ------ 撤消我的最后一个标注

    • 返回值: 无
  • redo() ------ 恢复我的最后一次撤消

  • 返回值: 无
  • clear() ------ 清空当前白板所有标注(清空操作不能再恢复)
  • 返回值: 无
  • isScaledContents() ------ 获取白板当前的缩放模式,缩放模式下内容将被缩小或放大以填充有效区域,非缩放模式下图像将按原始尺寸显示并可能出现滚动条

    • 返回值: 无
  • setScaledContents(bScaled) ------ 设置白板的缩放模式

    • 返回值: 无
参数 类型 说明
bScaled bool 是否启用缩放模式
  • setColor(penColorObj) ------ 设置画笔颜色
    • 返回值: 无
参数 类型 说明
penColorObj json格式 画笔颜色值对象,详见CRVideo_PenColorObj
  • getColor() ------ 获取当前画笔颜色

  • setLineWidth(width) ------ 设置画笔粗细

    • 返回值: 无
参数 类型 说明
width number 线条的宽度
  • getLineWidth() ------ 获取当前画笔颜色

    • 返回值: 线条的宽度 (number)
  • setReadOnly(bReadOnly) ------ 设置白板本地只读(本地禁止标注,其他端不受影响)

    • 返回值: 无
参数 类型 说明
bReadOnly bool 是否只读
  • isReadOnly() ------ 获取白板本地只读配置
  • 返回值: 是否只读 (bool), true - 白板本地只读

CRVideo_StartHttpMgr()

  • 功能: 启动http文档上传下载功能

  • 返回值:无

  • 参数:无

CRVideo_StopHttpMgr()

  • 功能: 停止http文档上传下载功能

  • 返回值:无

  • 参数:无

CRVideo_GetAllTransferInfos()

CRVideo_GetTransferInfo(filePathName)

参数 类型 含义
filePathName string 本地路径文件名

CRVideo_StartTransferFile(fileinfo)

  • 功能: 开始下载/上传文件

  • 返回值:无

参数 类型 含义
fileinfo json格式 详见CRVideo_HttpReqInfoObj

CRVideo_CancelFileTransfer(fileName)

  • 功能: 取消传输

  • 返回值:无

参数 类型 含义
fileName string 本地路径文件名

注意:取消时,只是停止了传输任务,不清理记录及断点文件。

CRVideo_RmTransferInfo(fileName,bRemoveLocFile)

  • 功能: 删除传输记录及相关文件

  • 返回值:无

参数 类型 含义
fileName string 文件名
bRemoveLocFile number 是否移除本地文件,为1时,那么上传的源始文件、下载的临时文件或结果文件都将被移除。

注意: 此接口将文件从管理器中移除(CRVideo_GetAllTransferInfos将不再返回相关信息),如果bRemoveLocFile为1时, 那么上传的源始文件、下载的临时文件或结果文件都将被移除。

CRVideo_FileStateChanged.callback = function( fileName, state)){}

  • 功能: 通知用户文件状态更改

CRVideo_FileProgress.callback = function( fileName, finisedSize, totalSize)){}

  • 功能: 通知用户文件的传输进度
  • 参数
    • fileName ----- 文件名
    • finisedSize ----- 已传输大小(number)
    • totalSize ----- 文件总大小(number)

CRVideo_FileFinished.callback = function( fileName, rslt)){}

  • 功能: 通知用户文件传输结束

CRVideo_FileHttpRspHeader.callback = function( fileName, rspHeader)){}

  • 功能: 通知http响应消息的header数据
  • 参数
    • fileName ----- 文件名(string)
    • rspHeader ----- http响应头(string)

CRVideo_FileHttpRspContent.callback = function( fileName, rspContent)){}

  • 功能: 通知上传完成后,http的响应内容
  • 参数
    • fileName ----- 文件名(string)
    • rspContent ----- http上传完成后的响应内容(string)

CRVideo_TryReadFile(diskPathFileName)

  • 功能: 尝试读取文件

  • 返回值:尝试结果,定义见CRVideo_ERR_DEF

参数 类型 含义
diskPathFileName string 本地路径文件名

CRVideo_ReadFileAsBase64(diskPathFileName)

  • 功能: 读取文件

  • 返回值: 以base64编码返回文件内容

参数 类型 含义
diskPathFileName string 本地路径文件名

CRVideo_WriteBase64ToFile(diskPathFileName, base64Dat)

  • 功能: 创建或重写文件(如果目录不存在,则创建目录)

  • 返回值: 结果,定义见CRVideo_ERR_DEF

参数 类型 含义
diskPathFileName string 本地路径文件名
base64Dat string base64编码格式的文件数据

CRVideo_MoveFile(srcDiskFileName, dstDiskFileName)

参数 类型 含义
srcDiskFileName string 本地源文件
dstDiskFileName string 本地目标文件

注意:目标文件如果已存在,将按失败处理,不会覆盖;

CRVideo_GetOpenFileName(title,directory,filter)

  • 功能: 获取用户打开的全路径文件名

  • 返回值: 结果,空串表示用户取消, 否则返回用户选择的文件路径文件名

参数 类型 含义
title string 打开文件框的标题
directory string 打开对话框初始路径,不设初始值时请传空
filter string 文件类型过滤器(可为空),示例:"Images (*.png *.xpm .jpg);;Text files (.txt)"

CRVideo_GetSaveFileName(title,directory,filter)

  • 功能: 获取用户保存的全路径文件名

  • 返回值: 结果,空串表示用户取消, 否则返回用户保存的文件路径文件名

参数 类型 含义
title string 打开文件框的标题
directory string 打开对话框初始路径,不设初始值时请传空
filter string 文件类型过滤器(可为空),示例:"Images (*.png *.xpm .jpg);;Text files (.txt)"

CRVideo_RemoveFromFileMgr(filename)

  • 功能: 删除本地的录制文件

  • 返回值:无

参数 类型 含义
filename string 文件名

上传中的文件会被取消上传,已上传完成的服务器文件不受影响

CRVideo_AddFileToRecordMgr(fileName, filePath)

  • 功能: 添加本地文件到录制文件管理中

  • 返回值: -1:本地文件不存在,0:成功,1:文件已经被添加过

参数 类型 含义
filename string 文件名,不含路径
filePath string 文件路径,不含文件名

第三方录制文件调用此接口后可进行本地回放和上传到视频服务器上,和自己录制的文件一样可以正常在线播放和下载

CRVideo_GetWriteablePathInIEProtectedMode()

  • 功能: 获取ie的保护模式下可读写的路径(获取到的为InternetCache目录,在系统重启或InternetCache目录清理时,此目录下的内容将会丢失)

  • 返回值:路径

CRVideo_IsIEProtectedMode()

  • 功能: 检查插件是否运行在ie的保护模式下

  • 返回值:true - ie保护模式下; false - 非ie或非保护模式{bool}

CRVideo_SetMarkText(videoFilePathName,msecond,markText)

  • 功能: 添加视频打点信息

  • 返回值:无

参数 类型 含义
videoFilePathName string 视频文件路径名
msecond number 视频播放的位置(毫秒)
markText string 打点信息

调用此接口会生成一个和视频文件同名且有.json后缀的打点文本文件

CRVideo_RemoveMarkText(videoFilePathName,msecond)

  • 功能: 移除视频打点信息

  • 返回值:无

参数 类型 含义
videoFilePathName string 视频文件路径名
msecond number 视频播放的位置(毫秒)

CRVideo_GetVideoMarkFile(videoFilePathName)

  • 功能: 获取视频文件对应的打点文件

  • 返回值:打点文件的路径文件名

参数 类型 含义
videoFilePathName string 视频文件路径名

CRVideo_GetAllMarks(videoFilePathName)

  • 功能:获取所有的视频打点信息

  • 返回值:打点信息集合字符串,json格式

参数 类型 含义
videoFilePathName string 视频文件路径名

CRVideo_CallMoreParty(callid,meetObj,usrExtDat,cookie)

  • 功能:2方通话中再呼叫第3方

  • 返回值:本次邀请标识码(邀请ID)

参数 类型 含义
callid string 被叫用户的账户ID
meetObj CRVideo_MeetInfoObj 当前会议信息(json结构体请参见CRVideo_MeetInfoObj)
usrExtDat string 自定义扩展参数
cookie string 自定义数据 (在回调时,回传给调用者)

结果事件CRVideo_CallMorePartyRslt,根据sdkErr判断是否成功

CRVideo_CallMorePartyRslt.callback = function(inviteID,sdkEr,cookie){}

  • 功能:第3方呼叫操作结果
  • 参数
    • inviteID ----- 邀请标识码(邀请ID
    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • cookie ----- 自定义数据 (在回调时,回传给调用者)

CRVideo_CancelCallMorePartyRslt.callback = function(inviteID,sdkEr,cookie){}

  • 功能:取消第3方呼叫操作结果
  • 参数
    • inviteID ----- 邀请标识码(邀请ID)
    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • cookie ----- 自定义数据(在回调时,回传给调用者)

CRVideo_NotifyCallMorePartyStatus.callback = function(inviteID,status){}

  • 功能:SDK通知第3方呼叫状态改变
  • 参数
    • inviteID ----- 邀请标识码(邀请ID)
    • status ----- 第3方呼叫状态码:0-振铃; 1-接通 ;2-拒绝; 3-未应答 ;4-挂断

CRVideo_GetRecordFileInfo(fileName)

参数 类型 含义
fileName string 文件名, 不含路径

CRVideo_Kickout(userId)

  • 功能:剔出用户

  • 返回值:无

参数 类型 含义
userId string 用户id