会议管理API

会议管理API 提供登录、呼叫、会议创建销毁、透明传输等功能.

会议管理函数

登录

CRVideo_Login(appID, appSecret, nickName, userID, userAuthCode, cookie)

• 返回值:无

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

注销

CRVideo_Logout()

• 返回值:无

设置免打扰状态

CRVideo_SetDNDStatus(DNDStatus, cookie)

• 返回值:无

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

获取用户状态信息列表

CRVideo_GetUserStatus(cookie)

• 返回值:无

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

开启用户的状态推送

CRVideo_StartUserStatusNotify(cookie)

• 返回值:无

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

关闭用户的状态推送

CRVideo_StopUserStatusNotify(cookie)

• 返回值:无

创建会议

CRVideo_CreateMeeting(meetSubject)

• 返回值:无

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

进入会话

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

• 返回值:无

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

离开会话

CRVideo_ExitMeeting()

• 返回值:无

他人离开会话的回调事件CRVideo_UserLeftMeeting

进入会议结果

CRVideo_EnterMeetingRslt.callback = function(sdkEr){}

• 功能：进入会议完成响应

• 参数：

  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF

结束会议结果

CRVideo_StopMeetingRslt.callback = function(sdkEr){}

• 功能：通知结束视频会议结果

• 参数：

  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF

有人进入会议通知

CRVideo_UserEnterMeeting.callback = function(usrID){}

• 功能某用户进入了会议

• 参数：

  • usrID ----- 进入会议的用户ID

有人离开会议通知

CRVideo_UserLeftMeeting.callback = function(id){}

• 功能：某用户离开了会议

• 参数：

  • id ----- 离开会议的用户ID

会议掉线通知

CRVideo_MeetingDropped.callback = function(){}

• 功能：SDK通知从会议里掉线了

会议成员列表

CRVideo_GetAllMembers()

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

会议成员信息

CRVideo_GetMemberInfo(userID)

• 返回值:返回用户userID的成员信息（CRVideo_MemberInfo）

会议成员昵称

CRVideo_GetMemberNickName(userID)

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

用户是否在会议中

CRVideo_IsUserInMeeting(userID)

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

发起呼叫

CRVideo_Call(calledUserID, meetObj)

• 返回值:返回本次呼叫标识码（呼叫ID）

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

接受对方发起的呼叫

CRVideo_AcceptCall(callID, meetObj, usrExtDat, cookie)

开始进入视频会话。操作成功则回调CRVideo_AcceptCallSuccess，失败则回调CRVideo_AcceptCallFail

拒绝对方发起的呼叫

CRVideo_RejectCall(callID, usrExtDat, cookie)

• 返回值:无

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

挂断呼叫

CRVideo_HungupCall(callID)

• 返回值:无

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

邀请第三方入会

CRVideo_CallMoreParty(called)

• 返回值:本次邀请标识码（邀请ID）

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

取消第三方入会

CRVideo_CancelCallMoreParty(inviteID,usrExtDat,cookie)

• 返回值:无

结果事件CRVideo_CancelCallMorePartyRslt，根据CRVideo_CancelCallMorePartyRslt里面的sdkEr判断是否成功

发送小块数据

CRVideo_SendCmd(targetUserId, data)

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

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

发送大块数据（分块发送）

CRVideo_SendBuffer(targetUserId, data)

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

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

发送文件（分块发送 ）

CRVideo_SendFile(targetUserId, fileName)

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

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

取消数据发送

CRVideo_CancelSend(taskID)

• 返回值:无

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

会议管理回调

登陆成功

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

• 功能：登录成功响应

• 参数：

  • usrID ----- 用户账户
  • cookie ----- 自定义用户数据

登录失败

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

• 功能：登录失败响应

• 参数：

  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF
  • cookie ----- 自定义用户数据

设置免打扰状态操作成功

CRVideo_SetDNDStatusSuccess.callback = function(cookie){}

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

• 参数：

  • cookie ----- 自定义用户数据

设置免打扰状态操作失败

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

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

• 参数：

  • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
  • cookie ----- 自定义用户数据

获取所有用户在线状态成功

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

• 功能：客获取所有用户在线状态成功响应

• 参数：

  • userStatus ----- 用户在线状态信息列表，userID:用户id，userStatus:用户的在线状态(0离线 ；1在线空闲 ；2在线忙碌；3在线会议中)，DNDType：用户免打扰状态（0代表关闭免打扰，其它值代表开启免打扰）
  • cookie ----- 自定义用户数据

获取所有用户在线状态失败

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

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

• 参数：

  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF
  • cookie ----- 自定义用户数据

开启用户状态推送

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

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

• 参数：

  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF
  • cookie ----- 自定义用户数据

关闭用户状态推送

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

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

• 参数：

  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF
  • cookie ----- 自定义用户数据

用户状态变化通知

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

• 功能：某个用户状态变化通知

• 参数：

  • userStatus ----- userStatus单个用户在线状态信息
  • cookie ----- 自定义用户数据

通知自己掉线

CRVideo_LineOff.callback = function(sdkEr){}

• 功能：SDK通知自己掉线

• 参数：

  • sdkEr ----- 掉线原因，定义见CRVideo_ERR_DEF

创建会议成功

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

• 功能：创建会议成功响应

• 参数：

  • meetObj ----- 会议信息
  • cookie ----- 自定义用户数据

发起呼叫操作成功

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_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_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 ----- 数据来源的用户
  • data ----- 数据类型

通知收到大块数据

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

• 功能：SDK通知收到大块数据

• 参数：

  • sourceUserId ----- 数据来源的用户
  • data ----- 数据类型

通知收到文件数据

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

• 功能：SDK通知收到文件数据（收到的文件生成在系统临时目录下，请尽快移走对应文件）

• 参数：

  • sourceUserId ----- 数据来源的用户
  • tmpFile ----- 临时文件，不需要时，请移除或删除对应文件
  • orgFileName ----- 源始文件名

通知取消发送文件数据

CRVideo_NotifyCancelSend.callback = function(taskID){}

• 功能：SDK通知取消发送文件数据

• 参数：

  • taskID ----- 取消的任务id