视频会议API

视频会议API 是会议核心api接口,实现通话建立、音频采集播入、视频采集编解码、屏幕共享、录制、影音播放等。


摄像头开关

打开用户的摄像头

OpenVideo(userID)

  • 返回值:无
参数 类型 含义
userID string 用户的ID

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

关闭用户的摄像头

CloseVideo(userID)

  • 返回值:无
参数 类型 含义
userID string 用户ID

设置默认摄像头

SetDefaultVideo(userID, videoID)

  • 返回值:无
参数 类型 含义
userID string 用户ID
videoID number 摄像头ID。移动端传入1表示前置摄像头,2表示后置摄像头

获取默认摄像头

GetDefaultVideo(userID)

  • 返回值:返回摄像头ID (number)
参数 类型 含义
userID string 用户ID

视频管理回调函数

视频状态变化

VideoStatusChanged.callback = function(userID,oldStatus,newStatus){}

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

  • 参数

    • userID ----- 会话中设备的所有者ID
    • oldStatus ----- 旧状态
    • newStatus ----- 新状态

麦克风开关

打开麦克风

OpenMic(userID)

  • 返回值:无
参数 类型 含义
userID string 用户的ID

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

关闭麦克风

CloseMic(userID)

  • 返回值:无
参数 类型 含义
userID string 登录成功后分配的userID

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

麦克风管理回调函数

麦克风状态变化

AudioStatusChanged.callback = function(userID,oldStatus,newStatus){}

  • 功能:SDK通知用户麦克风状态变化

  • 参数

    • userID ----- 会话中设备的所有者ID
    • oldStatus ----- 旧状态
    • newStatus ----- 新状态

主视频管理函数

获取哪个用户是主视频

GetMainVideo()

  • 返回值:userID
参数 类型 含义
userID string 用户ID

主视频管理回调

主视频变化通知

NotifyMainVideoChanged.callback = function(userId){}

  • 功能:SDK通知用户的主视频有变化

  • 参数

    • userID ----- 主视频变化的用户ID

云端录制

开始云端录制、云端直播

StartSvrMixer(mutiMixerCfgs, mutiMixerContents,mutiMixerOutputs)

  • 返回值: 无
参数 类型 含义
mutiMixerCfgs MutiMixerCfgsObj 服务器混图配置
mutiMixerContents MutiMixerContentsObj 服务器混图内容
mutiMixerOutputs MutiMixerOutputsObj 服务器输出

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

更新云端录制、云端直播内容

UpdateSvrMixerContent(mutiMixerContents)

  • 返回值: 无
参数 类型 含义
mutiMixerContents MutiMixerContentsObj 服务器混图内容

停止云端录制、云端直播

StopSvrMixer()

  • 返回值: 无

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

获取云端录制、云端直播状态

GetSvrMixerState()

云端录制回调函数

云端录制状态变化通知

SvrRecordStateChanged.callback = function(state,err){}

  • 功能 云端录制状态通知

  • 参数

云端录制内容变化通知

SvrRecVideosChanged.callback = function(jsonContents)

  • 功能 云端录制内容变化通知

  • 参数

发送IM消息函数

发送IM消息

SendIMmsg(text, UserID, cookie)

  • 返回值:任务id(string)
参数 类型 含义
text string 发送的文本消息
UserID string 目标用户,如果用户ID为空,消息发送给会议内所有用户
cookie string 自定义用户数据

响应事件CRVideo_SendIMmsgRlst

发送IM消息回调函数

发送IM消息结果

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

  • 功能:发送IM消息,SDK通知使用者发送结果

  • 参数

    • taskID ----- 发送任务id
    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • cookie ----- 自定义用户数据

通知收到IM消息

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

  • 功能:SDK通知收到IM消息

  • 参数

    • fromUserID ----- 消息来源
    • text ----- 消息内容
    • sendTime ----- 消息发送时间戳,从1970开始算起
© Carter all right reserved,powered by Gitbook文件修订时间: 2019-08-08 14:24:37

results matching ""

    No results matching ""