API参考

CloudroomVideoSDK接口详情

CloudroomVideoSDK 是基础控件，负责整个SDK的初始化和反初始化操作。整个程序的生命过程中只能有一个实例

String GetCloudroomVideoSDKVer()

• 功能: 获取SDK版本号

• 返回值: SDK版本号

CRVIDEOSDK_ERR_DEF init(Context context, SdkInitDat dat)

• 功能: SDK初始化

• 返回值: CRVIDEOSDK_NOERR为成功操作，其他详见定义CRVIDEOSDK_ERR_DEF

void uninit()

• 功能: SDK反初始化

• 返回值: 无

String serverAddr()

• 功能: 获取服务器地址

• 返回值: 服务器地址（如：www.cloudroom.com）或多个服务器地址串（如：www.cloudroom.com:8080;183.60.47.52:8080;）

void setServerAddr(String serverList)

• 功能: 设置服务器地址

• 返回值: 无

CloudroomVideoMgr接口详情

管理组件，实现登录、呼叫、房间创建销毁、透明传输等功能。 整个程序的生命过程中只能有一个实例。

void registerCallBack(CloudroomVideoMgrCallback callBack)

• 功能: 注册监听回调

• 返回值: 无

void unregisterCallBack(CloudroomVideoMgrCallback callBack)

• 功能: 反注册监听回调

• 返回值: 无

void login(String appID, String appSecret, String userID, String userAuthCode, String cookie)

void loginByAppID(String appID, String appSecret, String userID, String userAuthCode, String cookie)

• 功能: 密码登录

• 返回值: 无

登录成功则触发回调loginSuccess ， 登录失败则触发回调loginFail

• 补充说明:

1. 登陆成功则回调loginSuccess
   
2. 登陆失败则回调loginFail
   

void loginByToken(String token, String userID, String userAuthCode, String cookie)

• 功能: Token登录
• 返回值:无

• 补充说明:

1. 登陆成功则回调loginSuccess
   
2. 登陆失败则回调loginFail
   
3. 在token有效期只有30秒时，sdk将发出notifyTokenWillExpire通知，集成方应尽快通过updateToken更新新的token延长有限时间。
   

void updateToken(String token)

• 功能: 更新Token(在Token即将失效的时候更新Token延长有限时间)

int getUserAuthErrCode()

• 功能: 获取第三方鉴权失败码（只有在登录失败原因为：CRVIDEOSDK_CUSTOMAUTH_FAILED时有效）

• 返回值: 第三方返回的失败码

String getUserAuthErrDesc()

• 功能: 获取第三方鉴权失败原因描述（只有在登录失败原因为：CRVIDEOSDK_CUSTOMAUTH_FAILED时有效）

• 返回值: 第三方返回的描述串

void logout()

• 功能: 注销

• 返回值: 无

void setDNDStatus(int DNDStatus, String cookie)

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

• 返回值: 无

设置免打扰状态成功则触发回调setDNDStatusSuccess ， 设置免打扰状态失败则触发回调setDNDStatusFail

void getUserStatus(String userID, String cookie)

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

• 返回值: 无

回调函数getUserStatusRslt

void getUserStatus(String cookie)

• 功能: 将获取企业下所有用户在线状态（包括呼叫房间状态、免打扰状态）

• 返回值: 无

回调函数getUserStatusRslt

void startUserStatusNotify(String cookie)

• 功能: 开启用户的状态推送 。开启后，企业下所有用户状态有变化时(包括呼叫房间状态、免打扰状态)，都会收到通知。开启后，用户量越大消息量越大，所以请按需开启。

• 返回值: 无

回调函数startStatusPushRslt

void stopUserStatusNotify(String cookie)

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

• 返回值: 无

回调函数stopStatusPushRslt

void createMeeting(String cookie)

• 功能: 创建视频房间

• 返回值: 无

创建房间成功则触发回调createMeetingSuccess，创建房间失败则触发createMeetingFail

void destroyMeeting(int meetID, String cookie)

• 功能: 销毁视频房间

• 返回值: 无

回调函数destroyMeetingRslt

String call(String calledUserID, MeetInfo meetInfo, String userExtDat, String cookie)

• 功能: 发起呼叫，邀请用户参加视频会话， 呼叫时，对方迟迟不响应，30秒后系统自动结束呼叫

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

发起呼叫成功则触发回调callSuccess，发起呼叫失败则触发callFail

void acceptCall(String callID, MeetInfo meetInfo, String usrExtDat, String cookie)

• 功能: 接受对方发起的视频请求，开始进入视频会话

• 返回值: 无

接受对方发起的视频请求成功则触发回调acceptCallSuccess，接受对方发起的视频请求失败则触发acceptCallFail

void rejectCall(String callID, String usrExtDat, String cookie)

• 功能: 拒绝对方的视频请求

• 返回值: 无

拒绝对方发起的视频请求成功则触发回调rejectCallSuccess，拒绝对方发起的视频请求失败则触发rejectCallFail

void hangupCall(String callID, String usrExtDat, String cookie)

• 功能: 挂断正在进行的视频呼叫或视频通话

• 返回值: 无

挂断视频成功则触发回调hangupCallSuccess，挂断视频失败则触发hangupCallFail

String callMoreParty(String calledUserID, MeetInfo meetInfo, String usrExtDat, String cookie)

• 功能：发起多方呼叫（或呼转）

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

• 返回值：String 呼叫ID

• 参数：

void cancelCallMoreParty(String inviteID, String usrExtDat, String cookie)

• 功能：取消多方呼叫

取消结果参见cancelCallMorePartyRslt；

• 返回值：String 呼叫ID

• 参数：

String sendCmd(String targetUserId, String data)

• 功能: 发送小块数据（50K以内），此接口不能被cancelSend, 一次性发送，不会有进度通知

• 返回值: 分配的任务ID

回调函数sendCmdRlst

String sendBuffer(String targetUserId, String data)

• 功能: 发送大块数据 ，分块发送，进度通知事件sendProgress, 调用cancelSend 取消发送

• 返回值: 分配的任务ID

回调函数sendBufferRlst

String sendFile(String targetUserId, String fileName)

• 功能: 发送文件 ，分块发送，进度通知事件sendProgress，调用cancelSend取消发送

• 返回值: 分配的任务ID

回调函数sendFileRlst

void cancelSend(String taskID)

• 功能: 取消数据发送

• 返回值: 无

回调函数cancelSendRlst

void setMarkText(String videoFilePathName, int timestamp, String markText)

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

• 返回值: 无

void removeMarkText(String videoFilePathName, int timestamp)

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

• 返回值: 无

String getAllMarks(String videoFilePathName)

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

• 返回值: 打点信息

String getVideoMarkFile(String videoFilePathName)

• 功能: 获取打点文件的绝对文件路径名

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

CloudroomVideoMgr通知回调接口详情

void loginSuccess(String usrID, String cookie)

• 功能: 登录成功回调

• 返回值:无

void loginFail(CRVIDEOSDK_ERR_DEF sdkErr, String cookie)

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

• 返回值: 无

如果启用了第三方鉴权，并在鉴权失败时（sdkErr为CRVIDEOSDK_CUSTOMAUTH_FAILED），可以通过getUserAuthErrCode、getUserAuthErrDesc获取详细原因。

void setDNDStatusSuccess(String cookie)

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

• 返回值: 无

void setDNDStatusFail(CRVIDEOSDK_ERR_DEF sdkErr, String cookie)

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

• 返回值: 无

void getUserStatusRslt(CRVIDEOSDK_ERR_DEF sdkErr, ArrayList<UserStatus> userStatus, String cookie)

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

• 返回值: 无

void startStatusPushRslt(CRVIDEOSDK_ERR_DEF sdkErr, String cookie)

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

• 返回值: 无

void stopStatusPushRslt(CRVIDEOSDK_ERR_DEF sdkErr, String cookie)

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

• 返回值: 无

void notifyUserStatus(UserStatus userStatus)

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

• 返回值: 无

void lineOff(CRVIDEOSDK_ERR_DEF sdkErr)

• 功能: SDK通知自己掉线

• 返回值: 无

void notifyTokenWillExpire()

• 功能: 通知Token即将失效,有效时间剩余30s左右(可调用updateToken更新Token)

• 返回值: 无

void createMeetingSuccess(MeetInfo meetInfo, String cookie)

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

• 返回值: 无

void createMeetingFail(CRVIDEOSDK_ERR_DEF sdkErr, String cookie)

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

• 返回值: 无

void destroyMeetingRslt(CRVIDEOSDK_ERR_DEF sdkErr, String cookie)

• 功能: 结束房间响应

• 返回值: 无

void callSuccess(String callID, String cookie)

• 功能: 呼叫他人操作成功响应

• 返回值: 无

void callFail(String callID, CRVIDEOSDK_ERR_DEF sdkErr, String cookie)

• 功能: 呼叫他人操作失败响应

• 返回值: 无

void acceptCallSuccess(String callID, String cookie)

• 功能: 接受他人呼叫操作成功响应

• 返回值: 无

void acceptCallFail(String callID, CRVIDEOSDK_ERR_DEF sdkErr, String cookie)

• 功能: 接受他人呼叫操作失败响应

• 返回值: 无

void rejectCallSuccess(String callID, String cookie)

• 功能: 拒绝他人的呼叫成功响应

• 返回值: 无

void rejectCallFail(String callID, CRVIDEOSDK_ERR_DEF sdkErr, String cookie)

• 功能: 拒绝他人的呼叫失败响应

• 返回值: 无

void hangupCallSuccess(String callID, String cookie)

• 功能: 挂断呼叫操作成功响应

• 返回值: 无

void hangupCallFail(String callID, CRVIDEOSDK_ERR_DEF sdkErr, String cookie)

• 功能: 拒绝他人呼叫操作失败响应

• 返回值: 无

void notifyCallIn(String callID, MeetInfo meetInfo, String callerID, String usrExtDat)

• 功能: 服务端通知被邀请

• 返回值: 无

void notifyCallAccepted(String callID, MeetInfo meetInfo, String usrExtDat)

• 功能: 服务端通知呼叫邀请被接受回调

• 返回值: 无

void notifyCallRejected(String callID, CRVIDEOSDK_ERR_DEF reason, String usrExtDat)

• 功能: 服务端通知呼叫邀请被拒绝回调

• 返回值: 无

void notifyCallhangup(String callID, String usrExtDat)

• 功能: SDK通知呼叫被挂断

• 返回值: 无

callMorePartyRslt(String callID, CRVIDEOSDK_ERR_DEF sdkErr, String cookie);

• 功能：发起多方呼叫结果

• 返回值：无

• 参数：

cancelCallMorePartyRslt(String callID, CRVIDEOSDK_ERR_DEF sdkErr, String cookie)

• 功能：取消多方呼叫结果

• 返回值：无

• 参数：

notifyCallMorePartyStatus(String callID, INVITE_STATUS status)

• 功能：通知多方呼叫状态

• 返回值：无

• 参数：

void sendCmdRlst(String taskID, CRVIDEOSDK_ERR_DEF sdkErr, String cookie)

• 功能: 发送数据时，SDK通知发送结果

• 返回值: 无

void sendBufferRlst(String taskID, CRVIDEOSDK_ERR_DEF sdkErr, String cookie)

• 功能: 发送数据时，SDK通知发送结果

• 返回值: 无

void sendFileRlst(String taskID, String fileName, CRVIDEOSDK_ERR_DEF sdkErr, String cookie)

• 功能: 发送数据时，SDK通知发送结果

• 返回值: 无

void sendProgress(String taskID, int sendedLen, int totalLen, String cookie)

• 功能: 发送数据时，SDK通知发送进度

• 返回值: 无

void cancelSendRlst(String taskID, CRVIDEOSDK_ERR_DEF sdkErr, String cookie)

• 功能: 取消发送操作响应

• 返回值: 无

void notifyCmdData(String sourceUserId, String data)

• 功能: SDK通知收到小块数据

• 返回值: 无

void notifyBufferData(String sourceUserId, String data)

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

• 返回值: 无

void notifyFileData(String sourceUserId, String tmpFile, String orgFileName)

• 功能: SDK通知收到文件数据

• 返回值: 无

void notifyCancelSend(String taskID)

• 功能: 通知发来的数据/文件被取消

• 返回值: 无

String invite(String invitedUserID, String usrExtDat, String cookie)

• 功能：发送邀请

• 返回值:返回inviteID(每个邀请对应的唯一ID)

• 参数：

void acceptInvite(String inviteID, String usrExtDat, String cookie)

• 功能：接受对方的邀请

• 参数：

void rejectInvite(String inviteID, String usrExtDat, String cookie)

• 功能：拒绝对方的邀请

• 参数：

void cancelInvite(String inviteID, String usrExtDat, String cookie)

• 功能：取消自己发送的邀请

• 参数：

void inviteSuccess(String inviteID, String cookie)

• 功能：发送邀请成功

• 参数：

void inviteFail(String inviteID, CRVIDEOSDK_ERR_DEF sdkErr, String cookie)

• 功能：发送邀请失败

• 参数：

void cancelInviteSuccess(String inviteID, String cookie)

• 功能：取消自己发送的邀请成功

• 参数：

void cancelInviteFail(String inviteID, CRVIDEOSDK_ERR_DEF sdkErr, String cookie)

• 功能：取消自己发送的邀请失败

• 参数：

void acceptInviteSuccess(String inviteID, String cookie)

• 功能：接受对方的邀请成功

• 参数：

void acceptInviteFail(String inviteID, CRVIDEOSDK_ERR_DEF sdkErr, String cookie)

• 功能：接受对方的邀请失败

• 参数：

void rejectInviteSuccess(String inviteID, String cookie)

• 功能：拒绝对方的邀请成功

• 参数：

void rejectInviteFail(String inviteID, CRVIDEOSDK_ERR_DEF sdkErr, String cookie)

• 功能：拒绝对方的邀请失败

• 参数：

void notifyInviteIn(String inviteID, String inviterUsrID, String usrExtDat)

• 功能：通知有人邀请

• 参数：

void notifyInviteAccepted(String inviteID, String usrExtDat)

• 功能：通知邀请被接受

• 参数：

void notifyInviteRejected(String inviteID, CRVIDEOSDK_ERR_DEF reason, String usrExtDat)

• 功能：通知邀请被拒绝

• 参数：

void notifyInviteCanceled(String inviteID, CRVIDEOSDK_ERR_DEF reason, String usrExtDat)

• 功能：通知邀请被取消

• 参数：

CloudroomVideoMeeting接口详情

房间核心组件，实现通话建立、音频采集播入、视频采集编解码、屏幕共享、录制、影音播放等功能。整个程序的生命过程中只能有一个实例。

void registerCallBack(CloudroomVideoCallback callBack)

• 功能: 注册监听回调

• 返回值: 无

void unregisterCallBack(CloudroomVideoCallback callBack)

• 功能: 反注册监听回调

• 返回值: 无

void enterMeeting(int meetID, String nickname)

• 功能: 使用房间ID和昵称进入指定的视频房间

• 返回值: 无

回调函数enterMeetingRslt

void exitMeeting()

• 功能: 离开房间 ，调用此接口离开会话时，其他会话用户会收到userLeftMeeting的消息通知

• 返回值: 无

回调函数userLeftMeeting

void kickout(String userID)

• 功能: 把某个房间成员踢出房间

• 返回值: 无

ArrayList<MemberInfo> getAllMembers()

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

• 返回值: ArrayList<MemberInfo>-所有用户的信息

MemberInfo getMemberInfo(String userId)

• 功能: 获取某个用户的信息

• 返回值: MemberInfo - 用户的信息

String getNickName(String userId)

• 功能: 获取某个用户的昵称

• 返回值: 用户的昵称

void setNickName(String userID, String nickName)

• 功能: 设置某个用户的昵称， 调用此接口如果设置成功，其他会话用户会收到 notifyNickNameChanged

• 返回值: 无

回调函数setNickNameRsp

boolean isUserInMeeting(String userID)

• 功能: 判断某个用户是否在房间中

• 返回值: 用户是否在房间中

void setAudioCfg(AudioCfg cfg)

• 功能: 设置麦克风音频参数

• 返回值: 无

AudioCfg getAudioCfg()

• 功能: 获取音频参数

• 返回值: AudioCfg-音频参数

boolean setMicVolumeScaling(float scale)

• 功能: 设置麦克风音量增益

• 返回值: 是否成功

int getMicEnergy(String userID)

• 功能: 获取用户说话声音大小

• 返回值: 音量大小（0~10）

void openMic(String userID)

• 功能: 打开用户的麦克风， 打开麦克风会触发音频状态变化的回调函数audioStatusChanged 新状态参数先会进入到AOPENING状态，
  等服务器处理后才会进入AOPEN状态，此时说话才能被采集到

• 返回值: 无

回调函数audioStatusChanged

void closeMic(String userID)

• 功能: 关闭用户的麦克风 ，关麦克风会触发音频状态变化的回调函数audioStatusChanged 新状态参数会变为ACLOSE 关麦操作是立即生效的，会立即停止采集

• 返回值: 无

回调函数audioStatusChanged

ASTATUS getAudioStatus(String userID)

• 功能: 获取用户的麦状态

• 返回值: ASTATUS-麦克风设备状态

boolean setMicVolume(int level)

• 功能: 设置本地麦音量

• 返回值: 是否成功

int getMicVolume()

• 功能: 获取本地麦音量 ，读写属性，音量等级类型 0-255

• 返回值: 本地麦音量

boolean setSpeakerVolume(int level)

• 功能: 设置本地扬声器音量

• 返回值: 是否成功

int getSpeakerVolume()

• 功能: 获取本地扬声器音量 ，读写属性，音量等级类型 0-255

• 返回值: 本地扬声器音量

void setSpeakerMute(boolean bMute)

• 功能: 设置播放是否静音

• 返回值: 是否静音

boolean getSpeakerMute()

• 功能: 获取播放是否静音

• 返回值: 是否静音

boolean setSpeakerOut(boolean speakerOut)

• 功能: 设置外放状态

• 返回值: 是否成功

boolean getSpeakerOut()

• 功能: 获取外放状态

• 返回值: 是否外放

void setAllAudioClose()

• 功能: 关闭所有用户的麦克风 ， 调用此接口后会话内其他人的麦克风会关闭，同时收到消息audioStatusChanged
• 返回值: 无

回调函数audioStatusChanged

ArrayList<UsrVideoInfo> getAllVideoInfo(String userId)

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

• 返回值: ArrayList<UsrVideoInfo>-用户所有的摄像头信息

void setAudioFrameObserver(AudioFrameObserver p)

• 功能：设置语音观测器

传入NULL，代表移除观测器；
此接口线程安全；

• 返回值： 无

• 参数：

void setAudioSubscribeMode(ASUBSCRIB_MODE mode)

• 功能：设置音频订阅模式

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

• 返回值： 无

• 参数：

void setAudioSubscribeListForSeparateMode(ASUBSCRIB_LISTTYPE type, List<String< userIds)

• 功能：设置独立音频订阅名单

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

• 返回值： 无

• 参数：

CRVIDEOSDK_ERR_DEF startEchoTest()

• 功能: 开始本地语音环回测试

• 返回值: 无

void stopEchoTest()

• 功能: 停止本地语音环回测试

• 返回值: 无

boolean isEchoTesting()

• 功能: 检测是否在本地语音环回测试

• 返回值: 无

• 返回值: 是否测试中

- (int)getLocMicDevEnergy

• 功能: 获取本地麦克风设备能量等级

• 返回值: 无

• 返回值: 能量等级0~9, (9为最大能量等级）

void setVoiceChange(String userID, int type)

• 功能: 设置指定人变声

• 返回值: 无

• 返回值: 无

int getVoiceChangeType(String userID)

• 功能: 获取目标用户变声类型

• 返回值: 无

• 返回值: 预定义变声类型，参考CRVOICECHANGE_TYPE

CRVIDEOSDK_ERR_DEF setCustomAudioCapture(boolean enable, String param)

• 功能: 自定义音频采集

• 返回值: 无

• 返回值: 调用结果，CRVIDEOSDK_NOERR 代表调用成功，详情见CRVIDEOSDK_ERR_DEF

CRVIDEOSDK_ERR_DEF pushCustomAudioDat(ByteBuffer pcmDat)

• 功能: 向sdk送入自定义音频采集数据

• 返回值: 无

• 返回值: 调用结果，CRVIDEOSDK_NOERR 代表调用成功，详情见CRVIDEOSDK_ERR_DEF

CRVIDEOSDK_ERR_DEF setCustomAudioPlayback(boolean enable, String param)

• 功能: 自定义音频渲染

• 返回值: 无

• 返回值: 调用结果，CRVIDEOSDK_NOERR 代表调用成功，详情见CRVIDEOSDK_ERR_DEF

ByteBuffer pullCustomAudioDat()

• 功能: 从sdk获取音频数据用于自渲染

• 返回值: 音频帧数据

- (StreamInfo *)getVideoStreamInfo:(UsrVideoId *)cam

• 功能: 获取摄像头流信息

• 返回值: 流信息StreamInfo

short createCustomVideoDev(String camName, VIDEO_FORMAT pixFmt, int width, int height, String extParams)

• 功能: 创建自定义摄像头（sdk最大支持5个)， 添加成功后与本地摄像头处理一致；getAllVideoInfo接口可以识别摄像头类型

• 返回值: 返回值小于0， 则代表创建失败， 返回值大于等于0， 则代表摄像头编号

void destroyCustomVideoDev(short videoID)

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

• 返回值: 无

void inputCustomVideoDat(short videoID, byte[] data, int timeStamp)

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

• 返回值: 无

void inputCustomVideoDat(short videoID, byte[] data, int timeStamp)

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

• 返回值: 无

void setVideoCfg(VideoCfg cfg)

• 功能: 设置摄像头参数

• 返回值: 无

VideoCfg getVideoCfg()

• 功能: 获取设置的摄像头参数

• 返回值: VideoCfg-摄像头参数

void setVideoEffects(VideoEffects effects)

• 功能: 配置视频效果

• 返回值: 无

VideoCfg getVideoEffects()

• 功能: 获取视频效果配置

• 返回值: VideoEffects-视频效果配置

void setLocVideoAttributes(short videoID, VideoAttributes attributes)

• 功能: 设置某个摄像头私有参数

• 返回值: 无

VideoAttributes getLocVideoAttributes(short videoID)

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

• 返回值: VideoAttributes-摄像头私有参数

ArrayList<UsrVideoId> getWatchableVideos()

• 功能: 获取房间内所有可观看的摄像头

• 返回值: ArrayList<UsrVideoId>-房间内所有可观看的摄像头

void openVideo(String userID)

• 功能: 打开用户的摄像头，以便本地、远端显示视频图像

• 返回值: 无

回调函数openVideoRslt, 调用打开和关闭麦克风接口都会触发对应用户的回调videoStatusChanged

void closeVideo(String userID)

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

• 返回值: 无

调用打开和关闭麦克风接口都会触发对应用户的回调videoStatusChanged

VSTATUS getVideoStatus(String userID)

• 功能: 获取用户的摄像头状态

• 返回值: VSTATUS-麦克风摄像头状态

short getDefaultVideo(String userID)

• 功能: 获取指定用户的默认摄像头 ，如果用户没有摄像头，返回0

• 返回值: 摄像头ID

void setDefaultVideo(String userID, short videoID)

• 功能: 设置默认的摄像头 ，videoID 应该从getAllVideoInfo返回值中获取

• 返回值: 无

VideoFrame getVideoImg(UsrVideoId usrVideoID)

VideoFrame getVideoImg(UsrVideoId usrVideoID, VIDEO_FORMAT fmt)

VideoFrame getVideoImg(UsrVideoId usrVideoID, Size size)

VideoFrame getVideoImg(UsrVideoId usrVideoID, Size size, VIDEO_FORMAT fmt)

• 功能: 获取指定用户摄像头的最新图像

• 返回值: 指定用户摄像头的最新图像,详见VideoFrame

String getLocalVideoParams(short videoID)

• 功能: 获取指定本地摄像头参数

• 返回值: 指定本地摄像头参数,json格式，如{"摄像头参数名称":[可用参数列表]}

void setLocalVideoParam(short videoID, String param, String value)

• 功能: 设置指定本地摄像头参数

• 返回值: 指定本地摄像头参数,json格式，如{"摄像头参数名称":[可用参数列表]}

CRVSDK_ERR_DEF startBeauty(String params)

• 功能：开启美颜功能

开启美颜成功后，将带来不少gpu开销，且视频分辨率越高开销将越大；
支持多种美颜滤镜叠加，但叠加的越多，gpu开销越大；（当滤镜强度为0时，对应滤镜将不再带来开销）
当前美颜功能，只对默认摄像头生效，切换默认摄像头时内部自动对新的默认摄像头进行美颜处理；

• 返回值： CRVSDK_ERR_DEF，CRVSDKERR_NOERR代表调用成功

• 参数：

void stopBeauty()

• 功能：停止美颜功能

• 返回值：无

boolean isBeautyStarted()

• 功能：获取美颜功能是否开启

• 返回值： boolean

CRVSDK_ERR_DEF updateBeautyParams(String params)

• 功能：更新美颜参数

• 返回值： CRVSDK_ERR_DEF，CRVSDKERR_NOERR代表调用成功

• 参数：

String getBeautyParams()

• 功能：获取当前美颜参数

• 返回值：美颜配置，json格式，请参见CRBeautyCfg

boolean isScreenShareStarted()

• 功能: 获取屏幕共享是否已开启

• 返回值: 屏幕共享是否已开启

string getScreenShareCfg()

• 功能: 获取屏幕共享配置

• 返回值:屏幕共享配置，参见ScreenShareCfg

void setScreenShareCfg(ScreenShareCfg cfg)

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

• 返回值:无

void startScreenShare()

• 功能: 开启屏幕共享

• 返回值:无

• 注意事项:

  + 共享屏幕需要相应授权，请添加下面权限申请界面声明到主配置文件

	<activity
	  android:name="com.rtc.screencapture.PermissionActivity"
	  android:configChanges="orientation|uiMode|screenLayout|screenSize|smallestScreenSize|locale|fontScale|keyboard|keyboardHidden|navigation"
	  android:launchMode="singleTop" 
	  android:screenOrientation="sensor" >
	</activity>

void setCustomizeCatchScreen(boolean newVal)

• 功能: 开启/关闭自定义的抓屏

• 返回值:无

void setCustomizeScreenImg(final View view)

void setCustomizeScreenImg(final Bitmap bitmap)

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

• 返回值:无

void stopScreenShare()

• 功能: 停止屏幕共享

• 返回值:无

void startScreenMark()

• 功能: 开始屏幕共享标注

• 返回值: 无

void stopScreenMark()

• 功能: 停止屏幕共享标注

• 返回值: 无

void enableOtherMark(boolean enable)

• 功能：允许他人标注屏幕

• 返回值:无

• 参数:

boolean isEnableOtherMark()

• 功能：获取是否允许他人标注屏幕

• 返回值: 是否允许他人标注

• 参数:

CRVIDEOSDK_ERR_DEF createLocMixer(String mixerID, MixerCfg mixerCfg, ArrayList< MixerCotent> mixerContent)

• 功能: 创建本地混图器（用于本地录制、本地推流），当需要多个不同内容的录制、或直播时，就要创建多个混图器 。混图器开消比较大，多个同样图像的输出应该有一个混图器加上多个输出实现

• 返回值: CRVIDEOSDK_ERR_DEF-操作结果码

CRVIDEOSDK_ERR_DEF updateLocMixerContent(String mixerID, ArrayList< MixerCotent> mixerContents>

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

• 返回值: CRVIDEOSDK_ERR_DEF-操作结果码

void destroyLocMixer(String mixerID)

• 功能: 消毁本地混图器 , 消毁本地混图器后， 基于此混图器的录制输出、直播推流输出将自动结束

• 返回值: 无

MIXER_STATE getLocMixerState(String mixerID)

• 功能: 获取本地混图器状态

• 返回值: MIXER_STATE-混图器状态

CRVIDEOSDK_ERR_DEF addLocMixerOutput(String mixerID, ArrayList<MixerOutPutCfg> mixerOutput)

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

• 返回值: CRVIDEOSDK_ERR_DEF-操作结果码

• 注意事项:

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

void rmLocMixerOutput(String mixerID, ArrayList<String> nameOrUrls)

• 功能: 停止本地录制、直播推流 , 所有输出停止后并不会消毁混图器，如果混图器不再需要请手工消毁

• 返回值: 无

String createCloudMixer(string cfg)

• 功能：创建云端混图器

可以开启多个云端混图器，具体个数和企业购买的授权相关；

开启云端混图器后，房间内所有人都将收到cloudMixerStateChanged通知进入MIXER_STARTING（启动中状态）；

云端混图器部署有少量耗时，如果在部署过程遇到异常，将收到createCloudMixerFailed回调；

云端混图器启动完成并进入录制或推流状态时，将收到cloudMixerStateChanged通知，进入MIXER_RUNNING（工作中状态）；

开启云端混图器在进入MIXER_STARTING状态后，可以通过updateCloudMixerContent更新内容；

混图器如果在工作中遇到异常而停止时，将收到cloudMixerStateChanged通知，进入MIXER_NULL并携带错误原因；

• 返回值： 云端混图器ID

• 参数：

CRVIDEOSDK_ERR_DEF updateCloudMixerContent(String mixerID, String cfg)

• 功能：更新云端混图器

更新混图器内容时，只能更新内容和布局，不能更改混图器规格、输出目标；

更新混图器内容时，房间内所有人都将收到cloudMixerInfoChanged通知；

• 返回值： CRVIDEOSDK_ERR_DEF，CRVIDEOSDK_NOERR代表调用成功

• 参数：

void destroyCloudMixer(String mixerID)

• 功能：消毁云端混图器

消毁云端混图器时，调用者将收到cloudMixerStateChanged通知进入MIXER_STOPPING状态，在停止完成后，房间内所有人都将收到cloudMixerStateChanged通知进入MIXER_NULL状态；

• 返回值： 无

• 参数：

string getAllCloudMixerInfo()

• 功能：得到所有云端混图器信息

• 返回值： json格式字符串， 参见CloudMixerInfoList

String getCloudMixerInfo(String mixerID)

• 功能：得到云端混图器信息

• 返回值： json格式字符串， 参见CloudMixerInfo

• 参数：

void setMediaCfg(VideoCfg cfg)

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

• 返回值: 无

VideoCfg getMediaCfg()

• 功能: 获取影音共享配置参数

• 返回值: VideoCfg-影音共享配置参数

void startPlayMedia(String filename, boolean bLocPlay)

• 功能: 播放影音文件

• 返回值: 无

void startPlayMedia(String filename, int bLocPlay, boolean bPauseWhenFinished)

• 功能: 播放影音文件

• 返回值: 无

播放视频则触发回调notifyMediaOpened， 停止播放则触发回调notifyMediaStop

void pausePlayMedia(boolean bPause)

• 功能: 暂停播放影音

• 返回值: 无

void stopPlayMedia()

• 功能: 停止影音播放

• 返回值: 无

回调函数notifyMediaStop

void setMediaPlayPos(int pos)

• 功能: 设置播放进度

• 返回值: 无

ArrayList<String> getAllFilesInMediaPath()

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

• 返回值: 文件名列表

• 注意事项:

• 影音文件夹位于方法init的第二个参数sdkFilePath，sdk会在此文件中建立media的子文件夹，即为影音文件夹

MediaInfo getMediaInfo()

• 功能: 正在播放的影音信息

• 返回值: MediaInfo-影音文件信息

void setMediaVolume(int level)

• 功能: 设置影音播放的音量

• 返回值: 无

int getMediaVolume()

• 功能: 读取影音播放的音量

• 返回值: 影音播放的音量，类型范围（0-255）

void setPicResource(String resID, Bitmap bitmap)

• 功能: 将图片资源设置给sdk

• 返回值: 无

void setPicResource(String resID, String picFile)

• 功能: 将图片资源设置给sdk

• 返回值: 无

boolean setPicResource(String resID, View view)

• 功能: 将图片资源设置给sdk

• 返回值: 无

boolean setPicResource(String resID, View view, Size size)

• 功能: 将图片资源设置给sdk

• 返回值: 无

void getMeetingAllAttrs(String cookie)

• 功能:获取房间所有属性

• 返回值:无

• 参数：

void getMeetingAttrs(List<String> keys, String cookie)

• 功能:获取房间部份属性

• 返回值:无

• 参数：

void setMeetingAttrs(HashMap<String, String> attrs, HashMap<String, Object> options, String cookie)

• 功能:重置房间属性集

• 返回值:无

• 参数：

void addOrUpdateMeetingAttrs(HashMap<String, String> attrs, HashMap<String, Object> options, String cookie)

• 功能:增加或者更新房间属性

• 返回值:无

• 参数：

void delMeetingAttrs(List<String> keys, HashMap<String, Object> options, String cookie)

• 功能:删除房间属性

• 返回值:无

• 参数：

void clearMeetingAttrs(HashMap<String, Object> options, String cookie)

• 功能:清除房间所有属性

• 返回值:无

• 参数：

void getUserAttrs(String userIds, List<String> keys, String cookie)

• 功能:获取指定用户的指定属性

• 返回值:无

• 参数：

void setUserAttrs(String userId, string attrs, HashMap<String, Object> options, String cookie)

• 功能:重置用户属性

• 返回值:无

• 参数：

void addOrUpdateUserAttrs(String userId, string attrs, HashMap<String, Object> options, String cookie)

• 功能:增加或更新用户属性

• 返回值:无

• 参数：

void delUserAttrs(String userId, List<String> keys, HashMap<String, Object> options, String cookie)

• 功能:删除用户的特定属性

• 返回值:无

• 参数：

void clearAllUserAttrs(HashMap<String, Object> options, String cookie)

• 功能:清除所有用户的所有属性

• 返回值:无

• 参数：

void clearUserAttrs(String userId, HashMap<String, Object> options, String cookie)

• 功能:清除特定用户的所有属性

• 返回值:无

• 参数：

void sendMeetingCustomMsg(String text, String cookie)

• 功能:发送房间内自定义广播消息

• 返回值:无

• 参数：

回调函数sendMeetingCustomMsgRslt

CloudroomVideoMeeting通知回调接口详情

void enterMeetingRslt(CRVIDEOSDK_ERR_DEF sdkErr)

• 功能: 自己进入房间的结果

• 返回值: 无

void setNickNameRsp(CRVIDEOSDK_ERR_DEF sdkErr, String userid, String newName)

• 功能: 设置昵称的结果

• 返回值: 无

void notifyNickNameChanged(String userID, String oldName, String newName)

• 功能: 某用户改变了昵称(改昵称的用户自身不会接收到此通知)

• 返回值: 无

void userEnterMeeting(String userID)

• 功能: 某用户进入了房间

• 返回值: 无

void userLeftMeeting(String userID)

• 功能: 某用户离开了房间

• 返回值: 无

void meetingDropped(CRVIDEOSDK_MEETING_DROPPED_REASON reason)

• 功能: 通知从房间里掉线了，收到该通知后可以调用enterMeeting尝试重新进入房间

• 返回值: 无

• 注意事项:

• 如果用到了呼叫队列，掉线后不重新进入房间就必须调用hangupCall释放本次呼叫

void meetingStoped()

• 功能: 房间已被结束

• 返回值: 无

void netStateChanged(int level)

• 功能: 网络变化通知

• 返回值: 无

void audioDevChanged()

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

• 返回值: 无

void audioStatusChanged(String userID, ASTATUS oldStatus, ASTATUS newStatus)

• 功能: 通知音频状态变化

• 返回值: 无

void micEnergyUpdate( String userID, int oldLevel, int newLevel)

• 功能: 通知用户的说话声音强度更新

• 返回值: 无

void openVideoRslt(String devID, boolean bSuccess)

• 功能: 打开摄像头设备操作结果

• 返回值: 无

void videoStatusChanged(String userID, VSTATUS oldStatus, VSTATUS newStatus)

• 功能: 视频状态变化

• 返回值: 无

void videoDevChanged(String userID)

• 功能: 通知用户的视频设备有变化

• 返回值: 无

void notifyVideoData(UsrVideoId usrVideoID, long frameTime)

• 功能: 通知用户有新的视频数据

• 返回值: 无

void defVideoChanged(String userID, short videoID)

• 功能: 通知用户的视频默认设备有变化

• 返回值: 无

void uploadRecordFileErr(String fileName, int err)

• 功能: 上传录制文件错误通知

• 返回值: 无

void locMixerStateChanged(String mixerID, MIXER_STATE state)

• 功能: 本地混图器状态变化通知

• 返回值: 无

void locMixerOutputInfo(String mixerID, String nameOrUrl, MixerOutputInfo outputInfo)

• 功能: 本地录制文件、本地直播信息通知

• 返回值: 无

void startScreenShareRslt(CRVIDEOSDK_ERR_DEF sdkErr)

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

• 参数：

void stopScreenShareRslt(int sdkErr)

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

• 参数：

void notifyScreenShareStarted(String userID)

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

• 返回值: 无

• 参数：

void notifyScreenShareStopped(String oprUserID)

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

• 返回值: 无

• 参数：

void startScreenMarkRslt(CRVIDEOSDK_ERR_DEF sdkErr)

• 功能: 开始屏幕标注结果

• 参数：

void stopScreenMarkRslt(int sdkErr)

• 功能: 停止屏幕标注结果

• 参数：

void notifyScreenMarkStarted()

• 功能: 通知屏幕标注开始

• 返回值: 无

void notifyScreenMarkStopped()

• 功能: 通知屏幕标注停止

• 返回值: 无

int startGetAudioPCM(int aSide, int getType, String jsonParam)

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

• 返回值:返回值 整形数值，1：正常，0：失败(int)

void stopGetAudioPCM(aSide)

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

• 返回值:无

void notifyMediaOpened(int totalTime, Size picSZ)

• 功能: 通知影音文件打开

• 返回值: 无

void notifyMediaStart(String userid)

• 功能: 通知影音开始播放

• 返回值: 无

void notifyMediaPause(String userid, boolean bPause)

• 功能: 通知设置鼠标热点消息

• 返回值: 无

void notifyMediaStop(String userid, int reason)

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

• 返回值: 无

void notifyPlayPosSetted(int setPTS)

• 功能: 通知播放进度已设置完成

• 返回值: 无

void notifyMemberMediaData(String userid, int curPos)

• 功能: 通知影音帧数据已解码完毕

• 返回值: 无

• 注意事项:

• 收到此通知消息后，可通过getMediaImg获取图像显示；但如果之前显示的帧时戳更大，说明此通知消息已过时，直接忽略即可 如果使用了影音共享UI显示方式，不再需要自已关注此事件和进行显示处理

void notifyAudioPCMDat(int aSide, byte[] audioDat)

• 功能: 通知语音PCM数据

• 返回值: 无

void notifyAudioErr(CRVSDK_ERR_DEF sdkErr)

• 功能：通知本地音频相关错误

• 返回值：无

• 参数：

void getMeetingAllAttrsSuccess(string attrs, String cookie)

• 功能:成功获取到房间所有属性

• 参数：

void getMeetingAllAttrsFail(CRVIDEOSDK_ERR_DEF err, String cookie)

• 功能:获取房间属性失败

• 参数：

void getMeetingAttrsSuccess(string attrs, String cookie)

• 功能:成功获取到房间指定属性

• 参数：

void getMeetingAttrsFail(CRVIDEOSDK_ERR_DEF err, String cookie)

• 功能:获取房间指定属性失败

• 参数：

void setMeetingAttrsRslt(CRVIDEOSDK_ERR_DEF err, String cookie)

• 功能:设置用户属性结果

• 参数：

void addOrUpdateMeetingAttrsRslt(CRVIDEOSDK_ERR_DEF err, String cookie)

• 功能:增加或更新房间属性结果

• 参数：

void delMeetingAttrsRslt(CRVIDEOSDK_ERR_DEF err, String cookie)

• 功能:删除房间属性结果

• 参数：

void clearMeetingAttrsRslt(CRVIDEOSDK_ERR_DEF err, String cookie)

• 功能:清除房间属性结果

• 参数：

void getUserAttrsSuccess(HashMap<String, HashMap<String, MeetingAttr>> attrsMap, String cookie)

• 功能:获取房间内用户属性结果

• 参数：

void getUserAttrsFail(CRVIDEOSDK_ERR_DEF err, String cookie)

• 功能:获取房间内用户属性失败

• 参数：

void setUserAttrsRslt(CRVIDEOSDK_ERR_DEF err, String cookie)

• 功能:设置用户属性结果

• 参数：

void addOrUpdateUserAttrsRslt(CRVIDEOSDK_ERR_DEF err, String cookie)

• 功能:增加或者更新用户属性结果

• 参数：

void delUserAttrsRslt(CRVIDEOSDK_ERR_DEF err, String cookie)

• 功能:删除特定用户属性结果

• 参数：

void clearAllUserAttrsRslt(CRVIDEOSDK_ERR_DEF err, String cookie)

• 功能:清除所有用户属性结果

• 参数：

void clearUserAttrsRslt(CRVIDEOSDK_ERR_DEF err, String cookie)

• 功能:清除特定用户属性结果

• 参数：

void notifyMeetingAttrsChanged(HashMap<String, MeetingAttr> adds, HashMap<String, MeetingAttr> updates, List<String> delKeys)

• 功能:通知房间属性发生改变

• 参数：

void notifyUserAttrsChanged(String userId, HashMap<String, MeetingAttr> adds, HashMap<String, MeetingAttr> updates, List<String> delKeys)

• 功能:通知用户属性发生改变

• 参数：

void sendMeetingCustomMsgRslt(CRVIDEOSDK_ERR_DEF sdkErr, String cookie)

• 功能:通知发送房间内自定义广播消息结果

• 参数：

void notifyMeetingCustomMsg(String fromUserID, String text)

• 功能:通知收到房间内自定义广播消息

• 参数：

void createCloudMixerFailed(String mixerID, CRVIDEOSDK_ERR_DEF sdkErr)

• 功能：启动云端录制、云端直播失败通知

• 返回值：无

• 参数：

void cloudMixerStateChanged(String mixerID, MIXER_STATE state, String exParam, String operUserID)

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

• 返回值：无

• 参数：

void cloudMixerOutputInfoChanged(String mixerID, String jsonStr)

• 功能：云端录制文件、云端直播输出变化通知

• 返回值：无

• 参数：

void cloudMixerInfoChanged(String mixerID)

• 功能：云端录制、云端直播配置变化通知

可调用：getCloudMixerInfo获取相关信息

• 返回值：无

• 参数：

boolean isVirtualBackgroundStarted()

• 功能: 检查是否支持虚拟背景功能

• 返回值: true:支持，false:不支持

CRVIDEOSDK_ERR_DEF startVirtualBackground(String params)

• 功能: 启动虚拟背景

• 返回值: CRVIDEOSDK_NOERR代表成功，其它值代表失败的具体原因

CRVIDEOSDK_ERR_DEF updateVirtualBackgroundParams(String params)

• 功能: 更新虚拟背景参数

• 返回值: CRVIDEOSDK_NOERR代表成功，其它值代表失败的具体原因

String getVirtualBackgroundParams()

• 功能: 获取虚拟背景参数

• 返回值: 虚拟背景参数，参见：CRVirtualBkCfg

void stopVirtualBackground()

• 功能: 停止虚拟背景

• 返回值: 无

CloudroomQueue接口详情

队列组件，实现队列功能，目的是为了实现用户自动分配。整个程序的生命过程中只能有一个实例。

void registerCallBack(CloudroomQueueCallback callBack)

• 功能: 注册监听回调

• 返回值: 无

void unregisterCallBack(CloudroomQueueCallback callBack)

• 功能: 反注册监听回调

• 返回值: 无

void initQueue(String cookie)

• 功能: 初始化用户队列功能数据

• 返回值: 无

回调函数initQueueDatRslt

• 注意事项:

• 在响应回调initQueueDatRslt初始化成功后，才可获取队列队列相关信息

void refreshAllQueueStatus()

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

• 返回值: 无

回调函数queueStatusChanged

• 注意事项:

• 当前排队的队列或服务的队列，sdk自动有状态变化回调；其它队列则需要此函数来查询

ArrayList<QueueInfo> getAllQueueInfo()

• 功能: 获取队列信息

• 返回值: ArrayList<QueueInfo>-队列信息列表

QueueStatus getQueueStatus(int queID)

• 功能: 获指定取队列状态

• 返回值: QueueStatus-队列状态

QueuingInfo getQueuingInfo()

• 功能: 功能获取我的排队信息

• 返回值: QueuingInfo-我的排队信息

ArrayList<Integer> getServiceQueues()

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

• 返回值: 队列ID列表

VideoSessionInfo getSessionInfo()

• 功能: 获取我的会话信息

• 返回值: VideoSessionInfo-我的会话信息

void startQueuing(int queID, String usrExtDat, String cookie)

• 功能: 客户开始排队

• 返回值: 无

回调函数startQueuingRslt

void stopQueuing(String cookie)

• 功能: 客户停止排队

• 返回值: 无

回调函数stopQueuingRslt

void startService(int queID, String cookie)

• 功能: 开始服务某个队列(可以多次调用，开启对多个队列的服务)

• 返回值: 无

回调函数startServiceRslt

void startService(int queID, int priority, String cookie)

• 功能: 开始服务某个队列(可以多次调用，开启对多个队列的服务)

• 返回值: 无

回调函数startServiceRslt

• 注意事项:

• 如果没有开启免打扰，那么系统会自动分配客户：将收到事件autoAssignUser

• 如果开启免打扰，系统就不会分配客户，如需服务客户可调用reqAssignUser

• 座席优先级描述

  • 座席优先级只在服务的队列内部有效；
  • 客户优先分配给服务此队列优先级最高的，且空闲的座席；
  • 优先级相同时，则分配给最先空闲的座席；
  • 优先级高的座席变空闲时，不抢夺已分配的客户；

void stopService(int queID, String cookie)

• 功能: 停止服务某个队列

• 返回值: 无

回调函数stopServiceRslt

void reqAssignUser(String cookie)

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

• 返回值: 无

回调函数reqAssignUserRslt

• 注意事项:

• 当关闭免打扰时，系统将自动分配客户，无需调用此函数

• 当开启免打扰时，系统不再自动分配客户，座席如需服务客户可使用此函数分配

void acceptAssignUser(int queID, String userID, String cookie)

• 功能: 接受系统安排的客户

• 返回值: 无

回调函数reqAssignUserRslt

void rejectAssignUser(int queID, String userID, String cookie)

• 功能: 拒绝系统安排的客户

• 返回值: 无

回调函数reqAssignUserRslt

CloudroomQueue通知回调接口详情

void initQueueDatRslt(CRVIDEOSDK_ERR_DEF sdkErr, String cookie)

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

• 返回值: 无

void queueStatusChanged(QueueStatus queStatus)

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

• 返回值: 无

• 注意事项:

• 在排队的队列、或服务的队列发生变化时，将有队列状态变化通知到来

• 在调用refreshAllQueueStatus时，查询到的队列数据有变化时，会有通知到来

void queuingInfoChanged(QueuingInfo queuingInfo)

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

• 返回值: 无

void startQueuingRslt(CRVIDEOSDK_ERR_DEF sdkErr, String cookie)

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

• 返回值: 无

void stopQueuingRslt(CRVIDEOSDK_ERR_DEF sdkErr, String cookie)

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

• 返回值: 无

void startServiceRslt(int queID, CRVIDEOSDK_ERR_DEF sdkErr, String cookie)

• 功能: 开始服务队列操作结果

• 返回值: 无

void stopServiceRslt(int queID, CRVIDEOSDK_ERR_DEF sdkErr, String cookie)

• 功能: 停止服务队列操作结果

• 返回值: 无

void reqAssignUserRslt(CRVIDEOSDK_ERR_DEF sdkErr, UserInfo usr, String cookie)

• 功能: 停止服务队列操作结果

• 返回值: 无

void autoAssignUser(UserInfo usr)

• 功能: 队列系统自动分配客户

• 返回值: 无

• 注意事项:

• 如果想停止系统的自动分配，请调用CloudroomVideoMgr中的 setDNDStatus 设置免打扰功能。

void cancelAssignUser(int queID, String userID)

• 功能: 队列系统取消之前自动分配的的客户

• 返回值: 无

void responseAssignUserRslt(CRVIDEOSDK_ERR_DEF sdkErr, String cookie)

• 功能: 拒绝、接受分配的用户

• 返回值: 无

• 注意事项:

• 队列系统通过接口autoAssignUser给开始队列服务的人自动推送用户，收到系统分配的用户后，
  如果队列服务者还未决定接受acceptAssignUser还是拒绝rejectAssignUser推送的用户，系统可用取消本次推送，
  并通过本接口通知队列服务者。

可视化组件接口详情

1. 成员视频UI显示组件

com.cloudroom.cloudroomvideosdk.VideoUIView 是视频显示控件，它显示设定的用户的视频，
是由视频房间组件内相关接口的封装而成，如果此方式不满足需求，可以使用视频房间组件内相关的接口自行实现。
多实例方式，在会话中可以为每一个视频用户创建一个用来显示其画面

void setUsrVideoId(UsrVideoId usrVideoId)

• 功能： 设置显示的目标用户视频

• 返回值： 无

void setUsrVideoId(UsrVideoId usrVideoId, int qualityLv)

• 功能： 设置显示的目标用户视频

• 返回值： 无

• 注意事项:

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

UsrVideoId getUsrVideoId()

• 功能： 获取当前显示的用户

• 返回值： 用户视频ID

int getPicFrameTime()

• 功能： 获取图像时间戳
• 返回值： 当前图像数据对应的时间戳

boolean isPicEmpty()

• 功能： 检查图像是否为空
• 返回值： 图像是否为空

int getPicWidth()

• 功能： 获取图像宽

• 返回值： 宽

int getPicHeight()

• 功能： 获取图像高

• 返回值： 高

void clear()

• 功能： 清空显示

• 返回值： 无

void setScaleType(int scaleType)

• 功能： 设置图像显示模式

• 返回值： 无

int getScaleType()

• 功能： 获取视频显示模式

• 返回值： int

  0：等比缩放留空居中显示；

  1：等比缩放裁剪铺满显示；

  2：不等比缩放铺满显示（可能导致图像拉伸）；

void setMirrorType(int showMirror)

• 功能： 设置图像镜像模式

• 返回值： 无

int getScaleType()

• 功能： 获取视频镜像模式

• 返回值： int

  0：自动镜像（前置摄像头左右镜像）；

  1：不镜像；

  2：左右镜像；

Bitmap getShowPic()

• 功能： 获取当前显示图像

• 返回值： 当前显示图像

2. 屏幕共享UI显示组件

com.cloudroom.cloudroomvideosdk.ScreenShareUIView 是屏幕共享开启后远端显示控件，
是由视频房间组件内相关接口的封装而成，如果此方式不满足需求，可以使用视频房间组件内相关的接口自行实现。

int getPicFrameTime()

• 功能： 获取图像时间戳

• 返回值： 当前图像数据对应的时间戳

boolean isPicEmpty()

• 功能： 检查图像是否为空

• 返回值： 图像是否为空

int getPicWidth()

• 功能： 获取图像宽

• 返回值： 宽

int getPicHeight()

• 功能： 获取图像高

• 返回值： 高

void clear()

• 功能： 清空显示

• 返回值： 无

void setScaleType(int scaleType)

• 功能： 设置图像显示模式

• 返回值： 无

int getScaleType()

• 功能： 获取视频显示模式

• 返回值： int

  0：等比缩放留空居中显示；

  1：等比缩放裁剪铺满显示；

  2：不等比缩放铺满显示（可能导致图像拉伸）；

Bitmap getShowPic()

• 功能： 获取当前显示图像

• 返回值： 当前显示图像

3. 影音共享UI显示组件

com.cloudroom.cloudroomvideosdk.MediaUIView 影音显示控件，
是由视频房间组件内相关接口的封装而成，如果此方式不满足需求，可以使用视频房间组件内相关的接口自行实现功能。

int getPicFrameTime()

• 功能： 获取图像时间戳

• 返回值： 当前图像数据对应的时间戳

boolean isPicEmpty()

• 功能： 检查图像是否为空

• 返回值： 图像是否为空

int getPicWidth()

• 功能： 获取图像宽

• 返回值： 宽

int getPicHeight()

• 功能： 获取图像高

• 返回值： 高

void clear()

• 功能： 清空显示

• 返回值： 无

void setScaleType(int scaleType)

• 功能： 设置图像显示模式

• 返回值： 无

int getScaleType()

• 功能： 获取视频显示模式

• 返回值： int

  0：等比缩放留空居中显示；

  1：等比缩放裁剪铺满显示；

  2：不等比缩放铺满显示（可能导致图像拉伸）；

Bitmap getShowPic()

• 功能： 获取当前显示图像

• 返回值： 当前显示图像

class AudioFrameObserver

音频帧观测器对象；
不能进行耗时处理，将会影响声音的流畅性；

void onRecordAudioFrame(AudioFrame frm)

• 功能：采集的原始音频数据。在子线程回调，需要注意线程安全。

• 返回值：无

• 参数：

void onPlaybackAudioFrame(AudioFrame frm)

• 功能：播放的原始音频数据。在子线程回调，需要注意线程安全。

• 返回值：无

• 参数：

void onPlaybackAudioFrameBeforeMixing(String userID, AudioFrame frm)

• 功能：用户的混音前原始音频数据。在子线程回调，需要注意线程安全。

• 返回值：无

• 参数：

void onMixedAudioFrame(AudioFrame frm)

• 功能：采集+播放混音后数据。在子线程回调，需要注意线程安全。

• 返回值：无

• 参数：