音视频通话

API概述

API主要模块包括:基础函数、登录、房间属性、用户属性、进出房间、房间成员管理、音频管理、视频管理、虚拟视频设备、影音共享、本地录制/本地直播、云端录制/互动直播、屏幕共享

基础函数

方法 描述 所属文件
getVersion 获取sdk版本号 CRVSDKMain.cs
create 创建CRVSDKMain对象 CRVSDKMain.cs
uninitSDK 注销CRVSDKMain对象 CRVSDKMain.cs
getSDKMeeting 得到CRVSDKMeeting对象 CRVSDKMain.cs
writeLog 向sdk的日志文件写入日志 CRVSDKMain.cs

登录(主调)

方法 描述 所属文件
login 登录 CRVSDKMain.cs
logout 登出 CRVSDKMain.cs
updateToken 更新token CRVSDKMain.cs
getUserAuthErrCode 第三方鉴权错误码获取 CRVSDKMain.cs
getUserAuthErrDesc 第三方鉴权错误原因获取 CRVSDKMain.cs

登录(回调)

方法 描述 所属文件
loginRslt 登录结果 CRVSDKMain.cs
notifyTokenWillExpire 通知token授权即将到期 CRVSDKMain.cs
notifyLineOff 通知掉线 CRVSDKMain.cs

房间属性(主调)

方法 描述 所属文件
getMeetingAllAttrs 获取所有房间属性 CRVSDKMeeting.cs
getMeetingAttrs 获取部份房间属性 CRVSDKMeeting.cs
setMeetingAttrs 重置所有房间属性 CRVSDKMeeting.cs
addOrUpdateMeetingAttrs 添加或更新房间属性 CRVSDKMeeting.cs
delMeetingAttrs 删除房间属性 CRVSDKMeeting.cs
clearMeetingAttrs 清空所有房间属性 CRVSDKMeeting.cs

房间属性(回调)

方法 描述 所属文件
getMeetingAllAttrsSuccess 获取所有房间属性成功 CRVSDKMeeting.cs
getMeetingAllAttrsFail 获取所有房间属性失败 CRVSDKMeeting.cs
getMeetingAttrsSuccess 获取部份房间属性成功 CRVSDKMeeting.cs
getMeetingAttrsFail 获取部份房间属性失败 CRVSDKMeeting.cs
setMeetingAttrsRslt 重置所有房间属性结果 CRVSDKMeeting.cs
addOrUpdateMeetingAttrsRslt 添加或更新房间属性结果 CRVSDKMeeting.cs
delMeetingAttrsRslt 删除房间属性结果 CRVSDKMeeting.cs
clearMeetingAttrsRslt 清空所有房间属性结果 CRVSDKMeeting.cs
notifyMeetingAttrsChanged 通知房间属性改变 CRVSDKMeeting.cs

用户属性(主调)

方法 描述 所属文件
getUserAttrs 获取指定用户的所有属性 CRVSDKMeeting.cs
setUserAttrs 重置指定用户的属性 CRVSDKMeeting.cs
addOrUpdateUserAttrs 添加或更新指定用户的属性 CRVSDKMeeting.cs
delUserAttrs 删除指定用户的属性 CRVSDKMeeting.cs
clearUserAttrs 清空指定用户的属性 CRVSDKMeeting.cs

用户属性(回调)

方法 描述 所属文件
getUserAttrsSuccess 获取指定用户的所有属性成功 CRVSDKMeeting.cs
getUserAttrsFail 获取指定用户的所有属性失败 CRVSDKMeeting.cs
setUserAttrsRslt 重置指定用户的属性结果 CRVSDKMeeting.cs
addOrUpdateUserAttrsRslt 添加或更新指定用户的属性结果 CRVSDKMeeting.cs
delUserAttrsRslt 删除指定用户的属性结果 CRVSDKMeeting.cs
clearUserAttrsRslt 清空指定用户的属性结果 CRVSDKMeeting.cs
notifyUserAttrsChanged 通知用户属性改变 CRVSDKMeeting.cs

房间管理(主调)

方法 描述 所属文件
createMeeting 创建房间 CRVSDKMain.cs
destroyMeeting 销毁房间 CRVSDKMain.cs

房间管理(回调)

方法 描述 所属文件
createMeetingSuccess 创建房间成功 CRVSDKMain.cs
createMeetingFail 创建房间失败 CRVSDKMain.cs
destroyMeetingRslt 销毁房间结果 CRVSDKMain.cs

进出房间(主调)

方法 描述 所属文件
enterMeeting 进入房间 CRVSDKMeeting.cs
exitMeeting 离开房间 CRVSDKMeeting.cs

进出房间(回调)

方法 描述 所属文件
enterMeetingRslt 进入房间结果 CRVSDKMeeting.cs
notifyMeetingStopped 通知房间已结束 CRVSDKMeeting.cs
notifyMeetingDropped 与房间断开 CRVSDKMeeting.cs
notifyNetStateChanged 通知本端与房间服务器的网络状态变化 CRVSDKMeeting.cs

房间成员管理(主调)

方法 描述 所属文件
isUserInMeeting 检查用户是否在房间中 CRVSDKMeeting.cs
getAllMembers 获取房间中所有成员信息 CRVSDKMeeting.cs
getMemberInfo 获取房间中指定成员信息 CRVSDKMeeting.cs
kickout 将他人请出房间 CRVSDKMeeting.cs

房间成员管理(回调)

方法 描述 所属文件
notifyUserEnterMeeting 通知有人进入房间 CRVSDKMeeting.cs
notifyUserLeftMeeting 通知有人离开房间 CRVSDKMeeting.cs
setNickNameRslt 修改房间中成员昵称结果 CRVSDKMeeting.cs
notifyNickNameChanged 通知房间有人昵称变化 CRVSDKMeeting.cs
kickoutRslt 将他人请出房间结果 CRVSDKMeeting.cs

音频管理(主调)

方法 描述 所属文件
getAudioMics 得到系统麦克风设备列表 CRVSDKMeeting.cs
getAudioSpks 得到系统扬声器设备列表 CRVSDKMeeting.cs
getAudioCfg 得到当前音频配置 CRVSDKMeeting.cs
setAudioCfg 设置音频参数 CRVSDKMeeting.cs
setMicVolume 配置麦克风音量 CRVSDKMeeting.cs
getMicVolume 获取麦克风音量 CRVSDKMeeting.cs
setSpkVolume 配置扬声器音量 CRVSDKMeeting.cs
getSpkVolume 获取扬声器音量 CRVSDKMeeting.cs
startEchoTest 开始本地语音环回测试 CRVSDKMeeting.cs
stopEchoTest 停止本地语音环回测试 CRVSDKMeeting.cs
isEchoTesting 检查是否在本地语音环回测试 CRVSDKMeeting.cs
openMic 开麦(将麦克风声音送入房间) CRVSDKMeeting.cs
closeMic 关麦(麦克风声音停止送入房间) CRVSDKMeeting.cs
getMicStatus 获取指定人员的麦克风状态 CRVSDKMeeting.cs
getLocMicDevEnergy 获取本地麦克风设备能量等级 CRVSDKMeeting.cs
getUserMicEnergy 获取房间中指定人员麦克风能量等级 CRVSDKMeeting.cs
setVoiceChange 设置目标用户变声 CRVSDKMeeting.cs
getVoiceChangeType 获取目标用户变声类型 CRVSDKMeeting.cs

音频管理(回调)

方法 描述 所属文件
notifyAudioDevChanged 通知本地音频设备变化 CRVSDKMeeting.cs
notifyMicStatusChanged 通知房间中有人麦克风状态变化 CRVSDKMeeting.cs
notifyMicEnergy 通知房间有人麦克风能量变化 CRVSDKMeeting.cs
notifyCloseAllMic 通知全体关麦 CRVSDKMeeting.cs
notifySetVoiceChange 通知房间中有人变声状态变化 CRVSDKMeeting.cs

视频管理(主调)

方法 描述 所属文件
getAllVideoInfo 得到视频设备列表 CRVSDKMeeting.cs
setVideoCfg 本地视频全局配置 CRVSDKMeeting.cs
getVideoCfg 获取本地视频全局配置 CRVSDKMeeting.cs
openVideo 打开摄像头(他人观看后开始发流) CRVSDKMeeting.cs
closeVideo 关闭摄像头 CRVSDKMeeting.cs
setDefaultVideo 配置默认摄像头 CRVSDKMeeting.cs
getDefaultVideo 获取默认摄像头 CRVSDKMeeting.cs
setMutiVideos 开启关闭多摄头功能 CRVSDKMeeting.cs
getMutiVideos 获取多摄像头 CRVSDKMeeting.cs
setVideoEffects 配置视频效果参数 CRVSDKMeeting.cs
getVideoEffects 获取视频效果参数 CRVSDKMeeting.cs
getUserVideoFrame 获取渲染中的指定人员摄像头的图像帧 CRVSDKMeeting.cs

视频管理(回调)

方法 描述 所属文件
notifyVideoDevChanged 通知房间中用户视频设备变化 CRVSDKMeeting.cs
notifyDefaultVideoChanged 通知房间中用户默认视频设备变化 CRVSDKMeeting.cs
openVideoDevRslt 本地视频设备打开结果 CRVSDKMeeting.cs
notifyVideoStatusChanged 通知房间中用户视频状态变化 CRVSDKMeeting.cs

虚拟视频设备(主调)

方法 描述 所属文件
addIPCam 添加网络摄像头 CRVSDKMeeting.cs
delIPCam 删除网络摄像头 CRVSDKMeeting.cs
createScreenCamDev 添加桌面摄像头 CRVSDKMeeting.cs
destroyScreenCamDev 删除桌面摄像头 CRVSDKMeeting.cs

影音共享(主调)

方法 描述 所属文件
startPlayMedia 开始影音共享 CRVSDKMeeting.cs
stopPlayMedia 停止影音共享 CRVSDKMeeting.cs
pausePlayMedia 暂停影音共享 CRVSDKMeeting.cs
setMediaPlayPos 设置播放位置 CRVSDKMeeting.cs
getMediaInfo 获取当前影音共享信息 CRVSDKMeeting.cs
setMediaVolume 配置影音音量 CRVSDKMeeting.cs
getMediaVolume 获取影音音量 CRVSDKMeeting.cs
getMediaImg 获取影音播放的图像帧 CRVSDKMeeting.cs

影音共享(回调)

方法 描述 所属文件
startPlayMediaFail 影音共享开启失败 CRVSDKMeeting.cs
notifyMediaStart 通知影音共享开启 CRVSDKMeeting.cs
notifyMediaOpened 本地影音共享文件打开成功通知 CRVSDKMeeting.cs
notifyMediaStop 通知影音共享停止 CRVSDKMeeting.cs
notifyMediaPause 通知影音共享暂停 CRVSDKMeeting.cs

本地录制/本地直播(主调)

方法 描述 所属文件
createLocMixer 创建本地混图器 CRVSDKMeeting.cs
updateLocMixerContent 更新本地混图内容 CRVSDKMeeting.cs
addLocMixerOutput 添加混图器输出(本地文件或推流地址) CRVSDKMeeting.cs
rmLocMixerOutput 移除混图器输出 CRVSDKMeeting.cs
destroyLocMixer 销毁本地混图器 CRVSDKMeeting.cs
getLocMixerState 得到混图器状态 CRVSDKMeeting.cs

本地录制/本地直播(回调)

方法 描述 所属文件
notifyLocMixerStateChanged 通知本地录制/推流状态变化 CRVSDKMeeting.cs
notifyLocMixerOutputInfo 通知本地录制/推流输出信息 CRVSDKMeeting.cs

云端录制/互动直播(主调)

方法 描述 所属文件
createCloudMixer 创建云端混图器 CRVSDKMeeting.cs
updateCloudMixerContent 更新云端混图器 CRVSDKMeeting.cs
destroyCloudMixer 销毁云端混图器 CRVSDKMeeting.cs
getCloudMixerInfo 得到云端混图器信息 CRVSDKMeeting.cs
getAllCloudMixerInfo 得到所有云端混图器 CRVSDKMeeting.cs

云端录制/互动直播(回调)

方法 描述 所属文件
createCloudMixerFailed 创建云端录制/推流失败 CRVSDKMeeting.cs
notifyCloudMixerInfoChanged 通知云端录制/推流信息变化 CRVSDKMeeting.cs
notifyCloudMixerStateChanged 通知云端录制/推流状态变化 CRVSDKMeeting.cs
notifyCloudMixerOutputInfoChanged 通知云端录制/推流输出信息变化 CRVSDKMeeting.cs

屏幕共享(主调)

方法 描述 所属文件
getScreenCaptureSources 获取屏幕采集源列表 CRVSDKMeeting.cs
setScreenShareCfg 设置屏幕共享配置 CRVSDKMeeting.cs
getScreenShareInfo 获取共享信息 CRVSDKMeeting.cs
startScreenShare 开始屏幕共享(仅windows有效) CRVSDKMeeting.cs
stopScreenShare 停止屏幕共享 CRVSDKMeeting.cs
getScreenShareImg 获取屏幕共享的图像帧 CRVSDKMeeting.cs

屏幕共享(回调)

方法 描述 所属文件
startScreenShareRslt 开启屏幕共享结果 CRVSDKMeeting.cs
stopScreenShareRslt 停止屏幕共享结果 CRVSDKMeeting.cs
notifyScreenShareStarted 通知屏幕共享开始 CRVSDKMeeting.cs
notifyScreenShareStopped 通知屏幕共享停止 CRVSDKMeeting.cs