API概述
房间外主要模块包括:基础函数、登录、透明通道、队列管理、呼叫、邀请、房间管理、工具函数
房间内主要模块包括:进出房间、房间成员管理、房间属性、用户属性、音频管理、音频自采集自渲染、视频管理、视频自采集自渲染、虚拟摄像头设备、美颜、虚拟背景、影音共享、本地录制/本地直播、云端录制/互动直播、屏幕共享
基础函数
| 方法 | 描述 | 所属文件 |
|---|---|---|
| getVersion | 获取SDK版本号 | CRVideoSDKMain.h |
| create | 创建CRVideoSDKMain对象 | CRVideoSDKMain.h |
| destroy | 销毁CRVideoSDKMain对象 | CRVideoSDKMain.h |
| getSDKQueue | 获取CRVideoSDKQueue对象 | CRVideoSDKMain.h |
| getSDKCall | 获取CRVideoSDKCall对象 | CRVideoSDKMain.h |
| getSDKMeeting | 获取CRVideoSDKMeeting对象 | CRVideoSDKMain.h |
| AddCallBack | 增加CRVideoSDKMain的回调对象 | CRVideoSDKMain.h |
| RmCallBack | 移除CRVideoSDKMain的回调对象 | CRVideoSDKMain.h |
| setHardwareEncode | 硬编配置 | CRVideoSDKMain.h |
| setHardwareDecode | 硬解配置 | CRVideoSDKMain.h |
| setPicResource | 设置图片资源给SDK | CRVideoSDKMain.h |
登录(主调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| setNetworkProxy | 设置网络代理 | CRVideoSDKMain.h |
| login | 登录 | CRVideoSDKMain.h |
| logout | 登出 | CRVideoSDKMain.h |
| updateToken | 更新token | CRVideoSDKMain.h |
| getUserAuthErrCode | 第三方鉴权错误码获取 | CRVideoSDKMain.h |
| getUserAuthErrDesc | 第三方鉴权错误原因获取 | CRVideoSDKMain.h |
| setDNDStatus | 设置免打扰 | CRVideoSDKMain.h |
| getUserStatus | 获取本appID下的所有已登录用户 | CRVideoSDKMain.h |
| getOneUserStatus | 获取本appID下指定用户的登录状态 | CRVideoSDKMain.h |
| startUserStatusNotify | 开启appID下的用户登录状态消息推送 | CRVideoSDKMain.h |
| stopUserStatusNotify | 关闭appID下的用户登录状态消息推送 | CRVideoSDKMain.h |
登录(回调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| loginRslt | 登录结果 | CRVideoSDKMain.h |
| notifyTokenWillExpire | 通知token授权即将到期 | CRVideoSDKMain.h |
| notifyLineOff | 通知掉线 | CRVideoSDKMain.h |
| setDNDStatusRslt | 设置免打扰结果 | CRVideoSDKMain.h |
| getUserStatusSuccess | 获取用户登录状态信息成功 | CRVideoSDKMain.h |
| getUserStatusFail | 获取用户登录状态信息失败 | CRVideoSDKMain.h |
| notifyUserStatus | 通知某用户登录状态变化 | CRVideoSDKMain.h |
| startUserStatusNotifyRslt | 开启用户状态通知结果 | CRVideoSDKMain.h |
| stopUserStatusNotifyRslt | 关闭用户状态通知结果 | CRVideoSDKMain.h |
透明通道(主调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| sendCmd | 发送点对点消息 | CRVideoSDKMain.h |
| sendBuffer | 发送点对点大数据 | CRVideoSDKMain.h |
| sendFile | 发送点对点文件 | CRVideoSDKMain.h |
| cancelSend | 取消大数据、文件的发送 | CRVideoSDKMain.h |
| sendMeetingCustomMsg | 发送房间内群消息 | CRVideoSDKMeeting.h |
透明通道(回调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| sendCmdRlst | 发送点对点消息结果 | CRVideoSDKMain.h |
| sendBufferRlst | 发送点对点大数据结果 | CRVideoSDKMain.h |
| sendFileRlst | 发送点对点文件结果 | CRVideoSDKMain.h |
| cancelSendRlst | 取消发送结果 | CRVideoSDKMain.h |
| notifySendProgress | 通知大数据、文件的发送进度 | CRVideoSDKMain.h |
| notifyCmdData | 通知收到点对点透明通道消息 | CRVideoSDKMain.h |
| notifyBufferData | 通知收到点对点大数据 | CRVideoSDKMain.h |
| notifyFileData | 通知收到点对点文件 | CRVideoSDKMain.h |
| sendMeetingCustomMsgRslt | 发送房间内广播消息结果 | CRVideoSDKMeeting.h |
| notifyMeetingCustomMsg | 通知收到房间内广播消息 | CRVideoSDKMeeting.h |
队列管理(主调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| AddCallBack | 增加CRVideoSDKQueue回调对象 | CRVideoSDKQueue.h |
| RmCallBack | 移除CRVideoSDKQueue回调对象 | CRVideoSDKQueue.h |
| initQueueDat | 初始化队列功能 | CRVideoSDKQueue.h |
| getAllQueueInfo | 获取AppID下的所有队列基础信息 | CRVideoSDKQueue.h |
| getQueueStatus | 获取指定队列的排队状况 | CRVideoSDKQueue.h |
| startQueuing | 客户开始排队 | CRVideoSDKQueue.h |
| stopQueuing | 客户停止排队 | CRVideoSDKQueue.h |
| getQueuingInfo | 获取我的排队信息 | CRVideoSDKQueue.h |
| startService | 座席开始服务某队列 | CRVideoSDKQueue.h |
| stopService | 座席停止服务某队列 | CRVideoSDKQueue.h |
| getServingQueues | 获取我服务的所有队列 | CRVideoSDKQueue.h |
| reqAssignUser | 座席手动分配客户(免打扰开启后使用) | CRVideoSDKQueue.h |
| acceptAssignUser | 接受系统分配的客户 | CRVideoSDKQueue.h |
| rejectAssignUser | 拒绝系统分配的客户 | CRVideoSDKQueue.h |
队列管理(回调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| initQueueDatRslt | 初始化队列功能结果 | CRVideoSDKQueue.h |
| notifyQueueStatusChanged | 队列排队状态更新 | CRVideoSDKQueue.h |
| notifyQueuingInfoChanged | 我的排队信息更新 | CRVideoSDKQueue.h |
| startQueuingRslt | 客户开始排队结果 | CRVideoSDKQueue.h |
| stopQueuingRslt | 客户停止排队结果 | CRVideoSDKQueue.h |
| startServiceRslt | 座席开始服务结果 | CRVideoSDKQueue.h |
| stopServiceRslt | 座席停止服务结果 | CRVideoSDKQueue.h |
| acceptAssignUserRslt | 接受系统分配的客户结果 | CRVideoSDKQueue.h |
| rejectAssignUserRslt | 拒绝系统分配的客户结果 | CRVideoSDKQueue.h |
| reqAssignUserRslt | 座席手动分配客户结果 | CRVideoSDKQueue.h |
| notifyAutoAssignUser | 通知系统自动分配的客户 | CRVideoSDKQueue.h |
| notifyAssignUserCanceled | 通知分配的客户取消了 | CRVideoSDKQueue.h |
| notifyUserEnterQueue | 通知客户进入了某队列 | CRVideoSDKQueue.h |
| notifyUserLeaveQueue | 通知客户离开了某队列 | CRVideoSDKQueue.h |
呼叫(主调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| AddCallBack | 增加CRVideoSDKCall回调对象 | CRVideoSDKCall.h |
| RmCallBack | 移除CRVideoSDKCall回调对象 | CRVideoSDKCall.h |
| call | 发起呼叫 | CRVideoSDKCall.h |
| acceptCall | 接受他人的呼叫 | CRVideoSDKCall.h |
| rejectCall | 拒接他人的呼叫 | CRVideoSDKCall.h |
| hangupCall | 挂断通话 | CRVideoSDKCall.h |
| callMoreParty | 发起多方呼叫(或呼转) | CRVideoSDKCall.h |
| cancelCallMoreParty | 取消多方呼叫 | CRVideoSDKCall.h |
呼叫(回调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| callRslt | 发起的呼叫结果 | CRVideoSDKCall.h |
| acceptCallRslt | 接受他人呼叫的结果 | CRVideoSDKCall.h |
| rejectCallRslt | 拒绝他人呼叫的结果 | CRVideoSDKCall.h |
| hangupCallRslt | 挂断通话结果 | CRVideoSDKCall.h |
| notifyCallIn | 通知呼入 | CRVideoSDKCall.h |
| notifyCallAccepted | 通知呼叫被接受 | CRVideoSDKCall.h |
| notifyCallRejected | 通知呼叫被拒接 | CRVideoSDKCall.h |
| notifyCallHungup | 通知呼叫被挂断 | CRVideoSDKCall.h |
| callMorePartyRslt | 发起多方呼叫结果 | CRVideoSDKCall.h |
| cancelCallMorePartyRslt | 取消多方呼叫结果 | CRVideoSDKCall.h |
| notifyCallMorePartyStatus | 通知多方呼叫状态 | CRVideoSDKCall.h |
邀请(主调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| invite | 邀请他人 | CRVideoSDKCall.h |
| acceptInvite | 接受邀请 | CRVideoSDKCall.h |
| rejectInvite | 拒接邀请 | CRVideoSDKCall.h |
| cancelInvite | 取消邀请 | CRVideoSDKCall.h |
邀请(回调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| inviteRslt | 邀请他人结果 | CRVideoSDKCall.h |
| cancelInviteRslt | 取消邀请结果 | CRVideoSDKCall.h |
| acceptInviteRslt | 接受邀请结果 | CRVideoSDKCall.h |
| rejectInviteRslt | 拒接邀请结果 | CRVideoSDKCall.h |
| notifyInviteIn | 通知收到邀请 | CRVideoSDKCall.h |
| notifyInviteAccepted | 通知邀请被接受 | CRVideoSDKCall.h |
| notifyInviteRejected | 通知邀请被拒接 | CRVideoSDKCall.h |
| notifyInviteCanceled | 通知邀请被取消 | CRVideoSDKCall.h |
房间管理(主调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| createMeeting | 创建房间 | CRVideoSDKMain.h |
| destroyMeeting | 销毁房间 | CRVideoSDKMain.h |
房间管理(回调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| createMeetingSuccess | 创建房间成功 | CRVideoSDKMain.h |
| createMeetingFail | 创建房间失败 | CRVideoSDKMain.h |
| destroyMeetingRslt | 销毁房间结果 | CRVideoSDKMain.h |
工具函数
| 方法 | 描述 | 所属文件 |
|---|---|---|
| videoFrameCover | 图像格式转换及缩放处理 | CRVideoSDKMain.h |
| mirrorVideoFrame | 图像镜像处理 | CRVideoSDKMain.h |
| coverToVideoFrame | 将图片解码成图像帧 | CRVideoSDKMain.h |
| CRAudioCover | pcm声音数据重采样 | CRVideoSDK_Objs.h |
| customHttpReq | 通用http/https请求 | CRVideoSDKMain.h |
| writeLog | 向SDK的日志文件写入日志 | CRVideoSDKMain.h |
进出房间(主调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| AddCallBack | 添加CRVideoSDKMeeting回调对象 | CRVideoSDKMeeting.h |
| RmCallBack | 移除CRVideoSDKMeeting回调对象 | CRVideoSDKMeeting.h |
| enterMeeting | 进入房间 | CRVideoSDKMeeting.h |
| exitMeeting | 离开房间 | CRVideoSDKMeeting.h |
| stopMeeting | 结束房间 | CRVideoSDKMeeting.h |
| getNetState | 获取当前网络状态 | CRVideoSDKMeeting.h |
| getNetState2 | 获取当前网络状态详情 | CRVideoSDKMeeting.h |
进出房间(回调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| enterMeetingRslt | 进入房间结果 | CRVideoSDKMeeting.h |
| notifyMeetingStopped | 通知房间已结束 | CRVideoSDKMeeting.h |
| notifyMeetingDropped | 与房间断开 | CRVideoSDKMeeting.h |
| notifyNetStateChanged | 通知本端与房间服务器的网络状态变化 | CRVideoSDKMeeting.h |
房间成员管理(主调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| isUserInMeeting | 检查用户是否在房间中 | CRVideoSDKMeeting.h |
| getAllMembers | 获取房间中所有成员信息 | CRVideoSDKMeeting.h |
| getMemberInfo | 获取房间中指定成员信息 | CRVideoSDKMeeting.h |
| setNickName | 修改房间中成员昵称 | CRVideoSDKMeeting.h |
| kickout | 将他人请出房间 | CRVideoSDKMeeting.h |
房间成员管理(回调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| notifyUserEnterMeeting | 通知有人进入房间 | CRVideoSDKMeeting.h |
| notifyUserLeftMeeting | 通知有人离开房间 | CRVideoSDKMeeting.h |
| setNickNameRslt | 修改房间中成员昵称结果 | CRVideoSDKMeeting.h |
| notifyNickNameChanged | 通知房间有人昵称变化 | CRVideoSDKMeeting.h |
| kickoutRslt | 将他人请出房间结果 | CRVideoSDKMeeting.h |
房间属性(主调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| getMeetingAllAttrs | 获取所有房间属性 | CRVideoSDKMeeting.h |
| getMeetingAttrs | 获取部分房间属性 | CRVideoSDKMeeting.h |
| setMeetingAttrs | 重置所有房间属性 | CRVideoSDKMeeting.h |
| addOrUpdateMeetingAttrs | 添加或更新房间属性 | CRVideoSDKMeeting.h |
| delMeetingAttrs | 删除房间属性 | CRVideoSDKMeeting.h |
| clearMeetingAttrs | 清空所有房间属性 | CRVideoSDKMeeting.h |
房间属性(回调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| getMeetingAllAttrsSuccess | 获取所有房间属性成功 | CRVideoSDKMeeting.h |
| getMeetingAllAttrsFail | 获取所有房间属性失败 | CRVideoSDKMeeting.h |
| getMeetingAttrsSuccess | 获取部分房间属性成功 | CRVideoSDKMeeting.h |
| getMeetingAttrsFail | 获取部分房间属性失败 | CRVideoSDKMeeting.h |
| setMeetingAttrsRslt | 重置所有房间属性结果 | CRVideoSDKMeeting.h |
| addOrUpdateMeetingAttrsRslt | 添加或更新房间属性结果 | CRVideoSDKMeeting.h |
| delMeetingAttrsRslt | 删除房间属性结果 | CRVideoSDKMeeting.h |
| clearMeetingAttrsRslt | 清空所有房间属性结果 | CRVideoSDKMeeting.h |
| notifyMeetingAttrsChanged | 通知房间属性改变 | CRVideoSDKMeeting.h |
用户属性(主调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| getUserAttrs | 获取指定用户的所有属性 | CRVideoSDKMeeting.h |
| setUserAttrs | 重置指定用户的属性 | CRVideoSDKMeeting.h |
| addOrUpdateUserAttrs | 添加或更新指定用户的属性 | CRVideoSDKMeeting.h |
| delUserAttrs | 删除指定用户的属性 | CRVideoSDKMeeting.h |
| clearUserAttrs | 清空指定用户的属性 | CRVideoSDKMeeting.h |
| clearAllUserAttrs | 清空所有用户的属性 | CRVideoSDKMeeting.h |
用户属性(回调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| getUserAttrsSuccess | 获取指定用户的所有属性成功 | CRVideoSDKMeeting.h |
| getUserAttrsFail | 获取指定用户的所有属性失败 | CRVideoSDKMeeting.h |
| setUserAttrsRslt | 重置指定用户的属性结果 | CRVideoSDKMeeting.h |
| addOrUpdateUserAttrsRslt | 添加或更新指定用户的属性结果 | CRVideoSDKMeeting.h |
| delUserAttrsRslt | 删除指定用户的属性结果 | CRVideoSDKMeeting.h |
| clearUserAttrsRslt | 清空指定用户的属性结果 | CRVideoSDKMeeting.h |
| clearAllUserAttrsRslt | 清空所有用户的属性结果 | CRVideoSDKMeeting.h |
| notifyUserAttrsChanged | 通知用户属性改变 | CRVideoSDKMeeting.h |
音频管理(主调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| getAudioMics | 获取系统麦克风设备列表 | CRVideoSDKMeeting.h |
| getAudioSpks | 获取系统扬声器设备列表 | CRVideoSDKMeeting.h |
| getAudioCfg | 获取当前音频配置 | CRVideoSDKMeeting.h |
| setAudioCfg | 设置当前音频配置 | CRVideoSDKMeeting.h |
| setMicVolume | 配置系统麦克风音量 | CRVideoSDKMeeting.h |
| getMicVolume | 获取系统麦克风音量 | CRVideoSDKMeeting.h |
| setSpkVolume | 配置系统扬声器音量 | CRVideoSDKMeeting.h |
| getSpkVolume | 获取系统扬声器音量 | CRVideoSDKMeeting.h |
| setMicMute | 配置麦克风静音 | CRVideoSDKMeeting.h |
| getMicMute | 获取麦克风静音状态 | CRVideoSDKMeeting.h |
| setSpeakerMute | 配置扬声器静音 | CRVideoSDKMeeting.h |
| getSpeakerMute | 获取扬声器静音状态 | CRVideoSDKMeeting.h |
| setMicVolumeScaling | 配置麦克风音量附加的缩放系数 | CRVideoSDKMeeting.h |
| getMicVolumeScaling | 获取麦克风音量附加的缩放系数 | CRVideoSDKMeeting.h |
| setSpkVolumeScaling | 配置扬声器音量附加的缩放系数 | CRVideoSDKMeeting.h |
| getSpkVolumeScaling | 获取扬声器音量附加的缩放系数 | CRVideoSDKMeeting.h |
| startEchoTest | 开始本地语音环回测试 | CRVideoSDKMeeting.h |
| stopEchoTest | 停止本地语音环回测试 | CRVideoSDKMeeting.h |
| isEchoTesting | 检查是否在本地语音环回测试 | CRVideoSDKMeeting.h |
| openMic | 开麦(将麦克风声音送入房间) | CRVideoSDKMeeting.h |
| closeMic | 关麦(麦克风声音停止送入房间) | CRVideoSDKMeeting.h |
| closeAllMic | 全体关麦 | CRVideoSDKMeeting.h |
| getMicStatus | 获取指定人员的麦克风状态 | CRVideoSDKMeeting.h |
| getLocMicDevEnergy | 获取本地麦克风设备能量等级 | CRVideoSDKMeeting.h |
| getUserMicEnergy | 获取房间中指定人员麦克风能量等级 | CRVideoSDKMeeting.h |
| setVoiceChange | 设置目标用户变声 | CRVideoSDKMeeting.h |
| getVoiceChangeType | 获取目标用户变声类型 | CRVideoSDKMeeting.h |
| setAudioFrameObserver | 设置语音观测器 | CRVideoSDKMeeting.h |
| setAudioEncDatObserver | 设置语音编码数据观测器 | CRVideoSDKMeeting.h |
| setAudioSubscribeMode | 设置语音订阅模式 | CRVideoSDKMeeting.h |
| setAudioSubscribeListForSeparateMode | 设置独立音频订阅名单 | CRVideoSDKMeeting.h |
音频管理(回调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| notifyAudioDevChanged | 通知本地音频设备变化 | CRVideoSDKMeeting.h |
| notifyAudioErr | 通知本地音频相关错误 | CRVideoSDKMeeting.h |
| notifyMicStatusChanged | 通知房间中有人麦克风状态变化 | CRVideoSDKMeeting.h |
| notifyMicEnergy | 通知房间有人麦克风能量变化 | CRVideoSDKMeeting.h |
| notifyCloseAllMic | 通知全体关麦 | CRVideoSDKMeeting.h |
| notifySetVoiceChange | 通知房间中有人变声状态变化 | CRVideoSDKMeeting.h |
| onRecordAudioFrame | 安装语音观测器后本地采集的原始音频数据回调 | CRVideoSDK_Objs.h |
| onPlaybackAudioFrame | 安装语音观测器后本地播放的原始音频数据 | CRVideoSDK_Objs.h |
| onPlaybackAudioFrameBeforeMixing | 安装语音观测器后的用户的音频数据回调 | CRVideoSDK_Objs.h |
| onMixedAudioFrame | 安装语音观测器后的采集+播放混音后数据回调 | CRVideoSDK_Objs.h |
音频自采集自渲染
| 方法 | 描述 | 所属文件 |
|---|---|---|
| setCustomAudioCapture | 自定义音频采集 | CRVideoSDKMeeting.h |
| pushCustomAudioDat | 向SDK送入自定义音频采集数据 | CRVideoSDKMeeting.h |
| setCustomAudioPlayback | 自定义音频渲染 | CRVideoSDKMeeting.h |
| pullCustomAudioDat | 从SDK获取音频数据用于自渲染 | CRVideoSDKMeeting.h |
视频管理(主调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| getAllVideoInfo | 获取视频设备列表 | CRVideoSDKMeeting.h |
| showVideoAdvCfgDlg | 显示系统摄像头高级配置(仅windows有效) | CRVideoSDKMeeting.h |
| setVideoCfg | 本地视频全局配置 | CRVideoSDKMeeting.h |
| getVideoCfg | 获取本地视频全局配置 | CRVideoSDKMeeting.h |
| setLocVideoAttributes | 本地指定设备配置 | CRVideoSDKMeeting.h |
| getLocVideoAttributes | 获取本地指定设备配置 | CRVideoSDKMeeting.h |
| openVideo | 打开视频(他人订阅后开始发流) | CRVideoSDKMeeting.h |
| closeVideo | 关闭视频 | CRVideoSDKMeeting.h |
| getVideoStatus | 房间中视频状态 | CRVideoSDKMeeting.h |
| setDefaultVideo | 配置默认视频设备 | CRVideoSDKMeeting.h |
| getDefaultVideo | 获取默认视频设备 | CRVideoSDKMeeting.h |
| setMutiVideos | 开启关闭多视频设备功能 | CRVideoSDKMeeting.h |
| getMutiVideos | 获取开启的多视频设备 | CRVideoSDKMeeting.h |
| setVideoEffects | 配置视频效果参数 | CRVideoSDKMeeting.h |
| getVideoEffects | 获取视频效果参数 | CRVideoSDKMeeting.h |
| addCanvas | 开启视频渲染 | CRVideoSDKMeeting.h |
| rmCanvas | 关闭视频渲染 | CRVideoSDKMeeting.h |
| setVideoFrameObserver | 设置视频帧观测器 | CRVideoSDKMeeting.h |
| setVideoEncDatObserver | 设置视频编码数据观测器 | CRVideoSDKMeeting.h |
| GetVideoImg | 获取渲染中的指定人员视频的图像帧 | CRVideoSDKMeeting.h |
| getVideoStreamInfo | 获取视频视频流信息 | CRVideoSDKMeeting.h |
| setVideoWatermark | 配置视频水印 | CRVideoSDKMeeting.h |
| getVideoWatermark | 获取视频水印配置 | CRVideoSDKMeeting.h |
视频管理(回调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| notifyVideoDevChanged | 通知房间中用户视频设备变化 | CRVideoSDKMeeting.h |
| notifyDefaultVideoChanged | 通知房间中用户默认视频设备变化 | CRVideoSDKMeeting.h |
| openVideoDevRslt | 本地视频设备打开结果 | CRVideoSDKMeeting.h |
| notifyVideoStatusChanged | 通知房间中用户视频状态变化 | CRVideoSDKMeeting.h |
视频自采集自渲染(主调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| createCustomVideoDev | 创建自定义摄像头 | CRVideoSDKMeeting.h |
| destroyCustomVideoDev | 销毁自定义摄像头 | CRVideoSDKMeeting.h |
| inputCustomVideoDat | 送入自定义摄像头数据 | CRVideoSDKMeeting.h |
| addCustomRender | 添加自定义渲染对象 | CRVideoSDKMeeting.h |
| rmCustomRender | 移除自定义渲染对象 | CRVideoSDKMeeting.h |
虚拟摄像头设备(主调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| addIPCam | 添加网络摄像头 | CRVideoSDKMeeting.h |
| delIPCam | 删除网络摄像头 | CRVideoSDKMeeting.h |
| createScreenCamDev | 添加桌面摄像头 | CRVideoSDKMeeting.h |
| updateScreenCamDev | 调整桌面摄像头参数 | CRVideoSDKMeeting.h |
| destroyScreenCamDev | 删除桌面摄像头 | CRVideoSDKMeeting.h |
美颜
| 方法 | 描述 | 所属文件 |
|---|---|---|
| startBeauty | 开启美颜 | CRVideoSDKMeeting.h |
| stopBeauty | 停止美颜 | CRVideoSDKMeeting.h |
| isBeautyStarted | 获取美颜是否开启 | CRVideoSDKMeeting.h |
| updateBeautyParams | 更新美颜参数 | CRVideoSDKMeeting.h |
| getBeautyParams | 获取当前美颜参数 | CRVideoSDKMeeting.h |
虚拟背景
| 方法 | 描述 | 所属文件 |
|---|---|---|
| startVirtualBackground | 开启虚拟背景 | CRVideoSDKMeeting.h |
| stopVirtualBackground | 停止虚拟背景 | CRVideoSDKMeeting.h |
| isVirtualBackgroundStarted | 获取虚拟背景是否开启 | CRVideoSDKMeeting.h |
| updateVirtualBackgroundParams | 更新虚拟背景参数 | CRVideoSDKMeeting.h |
| getVirtualBackgroundParams | 获取当前虚拟背景参数 | CRVideoSDKMeeting.h |
影音共享(主调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| setMediaCfg | 设置影音共享配置 | CRVideoSDKMeeting.h |
| getMediaCfg | 获取影音共享配置 | CRVideoSDKMeeting.h |
| startPlayMedia | 开始影音共享 | CRVideoSDKMeeting.h |
| stopPlayMedia | 停止影音共享 | CRVideoSDKMeeting.h |
| pausePlayMedia | 暂停影音共享 | CRVideoSDKMeeting.h |
| setMediaPlayPos | 设置播放位置 | CRVideoSDKMeeting.h |
| getMediaInfo | 获取当前影音共享信息 | CRVideoSDKMeeting.h |
| getMediaImg | 获取当前影音共享图像 | CRVideoSDKMeeting.h |
| getMediaStreamInfo | 获取当前影音共享流信息 | CRVideoSDKMeeting.h |
| setMediaVolume | 配置影音音量 | CRVideoSDKMeeting.h |
| getMediaVolume | 获取影音音量 | CRVideoSDKMeeting.h |
| addCanvas | 开启图像渲染 | CRVideoSDKMeeting.h |
| rmCanvas | 关闭图像渲染 | CRVideoSDKMeeting.h |
| addCustomRender | 添加自定义渲染 | CRVideoSDKMeeting.h |
| rmCustomRender | 移除自定义渲染 | CRVideoSDKMeeting.h |
影音共享(回调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| startPlayMediaFail | 影音共享开启失败 | CRVideoSDKMeeting.h |
| notifyMediaStart | 通知影音共享开启 | CRVideoSDKMeeting.h |
| notifyMediaOpened | 本地影音共享文件打开成功通知 | CRVideoSDKMeeting.h |
| notifyMediaStop | 通知影音共享停止 | CRVideoSDKMeeting.h |
| notifyMediaPause | 通知影音共享暂停 | CRVideoSDKMeeting.h |
本地录制/本地直播(主调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| createLocMixer | 创建本地混图器 | CRVideoSDKMeeting.h |
| updateLocMixerContent | 更新本地混图内容 | CRVideoSDKMeeting.h |
| addLocMixerOutput | 添加混图器输出(本地文件或推流地址) | CRVideoSDKMeeting.h |
| rmLocMixerOutput | 移除混图器输出 | CRVideoSDKMeeting.h |
| destroyLocMixer | 销毁本地混图器 | CRVideoSDKMeeting.h |
| getLocMixerState | 获取混图器状态 | CRVideoSDKMeeting.h |
| setMarkText | 本地视频文件打点 | CRVideoSDKMeeting.h |
| removeMarkText | 移除本地视频文件的某个打点 | CRVideoSDKMeeting.h |
| getAllMarks | 获取本地视频文件的所有打点信息 | CRVideoSDKMeeting.h |
| getMarkFile | 获取本地打点文件的绝对文件路径名 | CRVideoSDKMeeting.h |
本地录制/本地直播(回调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| notifyLocMixerStateChanged | 通知本地录制/推流状态变化 | CRVideoSDKMeeting.h |
| notifyLocMixerOutputInfo | 通知本地录制/推流输出信息 | CRVideoSDKMeeting.h |
云端录制/互动直播(主调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| createCloudMixer | 创建云端混图器 | CRVideoSDKMeeting.h |
| updateCloudMixerContent | 更新云端混图器 | CRVideoSDKMeeting.h |
| destroyCloudMixer | 销毁云端混图器 | CRVideoSDKMeeting.h |
| getCloudMixerInfo | 获取云端混图器信息 | CRVideoSDKMeeting.h |
| getAllCloudMixerInfo | 获取所有云端混图器 | CRVideoSDKMeeting.h |
云端录制/互动直播(回调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| createCloudMixerFailed | 创建云端录制/推流失败 | CRVideoSDKMeeting.h |
| notifyCloudMixerInfoChanged | 通知云端录制/推流信息变化 | CRVideoSDKMeeting.h |
| notifyCloudMixerStateChanged | 通知云端录制/推流状态变化 | CRVideoSDKMeeting.h |
| notifyCloudMixerEvent | 云端录制/推流事件通知 | CRVideoSDKMeeting.h |
屏幕共享(主调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| getScreenCaptureSources | 获取屏幕采集源列表 | CRVideoSDKMeeting.h |
| setScreenShareCfg | 设置屏幕共享配置 | CRVideoSDKMeeting.h |
| getScreenShareCfg | 获取屏幕共享配置 | CRVideoSDKMeeting.h |
| getScreenShareInfo | 获取共享信息 | CRVideoSDKMeeting.h |
| getScreenShareImg | 获取屏幕共享的图像 | CRVideoSDKMeeting.h |
| getScreenShareStreamInfo | 获取屏幕共享流信息 | CRVideoSDKMeeting.h |
| startScreenShare | 开始屏幕共享 | CRVideoSDKMeeting.h |
| stopScreenShare | 停止屏幕共享 | CRVideoSDKMeeting.h |
| pauseScreenShare | 暂停共享 | CRVideoSDKMeeting.h |
| setCustomizeCatchScreen | 开启/关闭自定义采屏 | CRVideoSDKMeeting.h |
| setCustomizeScreenImg | 将自采集屏幕图像送入SDK | CRVideoSDKMeeting.h |
| giveCtrlRight | 授予目标用户远程控制权限 | CRVideoSDKMeeting.h |
| releaseCtrlRight | 放弃或收回目标用户控制权限 | CRVideoSDKMeeting.h |
| sendMouseCtrlMsg | 发送远控鼠标消息 | CRVideoSDKMeeting.h |
| sendKeyCtrlMsg | 发送远控键盘消息 | CRVideoSDKMeeting.h |
| addCanvas | 开启图像渲染 | CRVideoSDKMeeting.h |
| rmCanvas | 关闭图像渲染 | CRVideoSDKMeeting.h |
| addCustomRender | 添加自定义渲染 | CRVideoSDKMeeting.h |
| rmCustomRender | 移除自定义渲染 | CRVideoSDKMeeting.h |
| startScreenMark | 开始屏幕共享标注 | CRVideoSDKMeeting.h |
| stopScreenMark | 停止屏幕共享标注 | CRVideoSDKMeeting.h |
| isScreenMarkedState | 获取当前屏幕共享标注状态 | CRVideoSDKMeeting.h |
| sendScreenMarkData | 发送屏幕共享标注数据 | CRVideoSDKMeeting.h |
| delScreenMarkData | 删除指定屏共享幕标注 | CRVideoSDKMeeting.h |
| clearScreenMarks | 清空屏幕共享标注 | CRVideoSDKMeeting.h |
| setCustomScreenCtlHandler | 自定义屏幕远程控制处理 | CRVideoSDKMeeting.h |
屏幕共享(回调)
| 方法 | 描述 | 所属文件 |
|---|---|---|
| startScreenShareRslt | 开启屏幕共享结果 | CRVideoSDKMeeting.h |
| stopScreenShareRslt | 停止屏幕共享结果 | CRVideoSDKMeeting.h |
| notifyScreenShareStarted | 通知屏幕共享开始 | CRVideoSDKMeeting.h |
| notifyScreenShareStopped | 通知屏幕共享停止 | CRVideoSDKMeeting.h |
| notifyGiveCtrlRight | 通知给予某人控制权限 | CRVideoSDKMeeting.h |
| notifyReleaseCtrlRight | 通知释放了控制权限 | CRVideoSDKMeeting.h |
| startScreenMarkRslt | 开始屏幕共享标注结果 | CRVideoSDKMeeting.h |
| stopScreenMarkRslt | 停止屏幕共享标注结果 | CRVideoSDKMeeting.h |
| notifyScreenMarkStarted | 通知屏幕共享标注开始 | CRVideoSDKMeeting.h |
| notifyScreenMarkStopped | 通知屏幕共享标注停止 | CRVideoSDKMeeting.h |
| notifySendScreenMarkData | 通知屏幕共享标注数据 | CRVideoSDKMeeting.h |
| notifyDelScreenMarkData | 通知屏幕共享标注被删除的数据 | CRVideoSDKMeeting.h |
| notifyClearScreenMarks | 通知屏幕共享标注被清空 | CRVideoSDKMeeting.h |