音视频通话

API参考

global API

string getVersion()

  • 功能:获取sdk版本号

  • 返回值:版本号字符串

class CRVSDKMain

static CRVSDKMain create(string sdkDatSavePath)

  • 功能:创建CRVSDKMain对象

  • 返回值:CRVSDKMain对象

  • 参数:

参数 类型 含义
sdkDatSavePath string SDK工作目录,用于存储配置文件、临时文件、日志等文件;
如果传空值,则默认为sdk的安装目录;
  • jsonParam说明:
参数 取值 含义
Timeout 10000~120000 网络通信超时时间,单位是毫秒, 缺省值:60000
DatEncType 0/1 数据加密类型(缺省值:1):
0:不加密(http、udp)
1:加密(https、udp数据aes加密)

void uninitSDK()

  • 功能:注销CRVSDKMain对象

  • 返回值:无

CRVSDKMeeting getSDKMeeting()

  • 功能:得到sdk的Meeting对象

  • 返回值:CRVSDKMeeting对象

void login(sdkLoginDat loginDat, string cookie = "")

  • 功能:sdk登录

  • 返回值:无, 登录结果参见loginRslt

  • 参数:

参数 类型 含义
loginDat sdkLoginDat 登录相关参数
cookie string 上下文参数,详细介绍参见关键词

void logout()

  • 功能:sdk登出

  • 返回值:无

void updateToken(string token)

  • 功能:更新Token, 防止token因过期而掉线。

Token即将到期前30秒左右,将收到通知:notifyTokenWillExpire
Token过期后,将引发掉线notifyLineOff,原因值为CRVSDKERR_TOKEN_TIMEOUT

  • 返回值:无

  • 参数:

参数 类型 含义
token string Token鉴权码,参见token鉴权方案说明

int getUserAuthErrCode()

  • 功能:获取第三方鉴权错误码

  • 返回值:错误码,值含义第三方鉴权方提供

string getUserAuthErrDesc()

  • 功能:获取第三方鉴权错描述串

  • 返回值:string字符串,值由第三方鉴权方自由定义。

void createMeeting()

  • 功能:创建房间

创建结果参见createMeetingSuccess / createMeetingFail;
房间创建后,此房间ID将一直存在,直到调用destroyMeeting销毁它;
没有人使用房间时,系统会在一定时间后释放资源,并在下次使用是再临时分配,房间ID是保持不变的;

  • 返回值:无

void destroyMeeting(int meetID, string cookie = "")

  • 功能:销毁房间

创建结果参见destroyMeetingRslt
房间被销毁后,房间中的其他人将收到notifyMeetingStopped

  • 返回值:无

  • 参数:

参数 类型 含义
meetID int 房间号
cookie string 上下文参数,详细介绍参见关键词

void writeLog(CRVSDK_LOG_LEVEL level, string log)

  • 功能:向sdk的日志文件写入日志

  • 返回值:无

  • 参数:

参数 类型 含义
level CRVSDK_LOG_LEVEL 日志等级
log string 日志内容(长度超过2K时,将被截断)

class CRVSDKMainCallBack

private void loginRslt(CRVSDK_ERR_DEF sdkErr, string cookie)

  • 功能:登录结果回调

  • 返回值:无

  • 参数:

参数 类型 含义
sdkErr CRVSDK_ERR_DEF CRVSDK_NOERR代表登录成功,其它值代表登录失败的具体原因
cookie string 登录时传入的cookie参数

private void notifyTokenWillExpire()

  • 功能:token授权即将到期通知

采用Token模式登录,才会收到此回调;
Token到期前30秒左右回调,应尽快调用updateToken将授权更久的Token设置给SDK;

  • 返回值:无

private void notifyLineOff(CRVSDK_ERR_DEF sdkErr)

  • 功能:通知本端SDK掉线

掉线的原因参见CRVSDK_ERR_DEF;
掉线时,如果正在房间中也将自动离开房间;
掉线时,之前的所有未完成的请求都将失败;
掉线之后,可以按业务需求稍后重新登录;

  • 返回值:无

  • 参数:

参数 类型 含义
sdkErr CRVSDK_ERR_DEF 掉线的原因

private void createMeetingSuccess(int meetid, string cookie)

  • 功能:创建房间成功

  • 返回值:无

  • 参数:

参数 类型 含义
meetid int 房间ID
cookie string 请求接口传入的cookie参数

private void createMeetingFail(CRVSDK_ERR_DEF sdkErr, string cookie)

  • 功能:创建房间失败

  • 返回值:无

  • 参数:

参数 类型 含义
sdkErr CRVSDK_ERR_DEF 失败的具体原因
cookie string 请求接口传入的cookie参数

private void destroyMeetingRslt(CRVSDK_ERR_DEF sdkErr, string cookie)

  • 功能:销毁房间结果

  • 返回值:无

  • 参数:

参数 类型 含义
sdkErr CRVSDK_ERR_DEF CRVSDK_NOERR代表成功,其它值代表失败的具体原因
cookie string 请求接口传入的cookie参数

class CRVSDKMeeting

void enterMeeting(int meetID)

  • 功能:进入房间

进入房间结果:enterMeetingRslt
进入房间成功时,房间中其他人员将收到通知:notifyUserEnterMeeting

  • 返回值:无

  • 参数:

参数 类型 含义
meetID int 房间ID

void exitMeeting()

  • 功能:离开房间

离开房间不需要等待服务器响应(网络不好,或网络断开时不会影响离开房间),调用之后即代表离开房间了;
离开房间后,不会再收房间中任何消息;
离开房间时,如果网络正常,房间中其他人会立即收到notifyUserLeftMeeting通知,如果网络不正常,服务器会在sdk内部握手超时后发出notifyUserLeftMeeting通知;
需要销毁房间,请参见destroyMeeting;

  • 返回值:无

bool isUserInMeeting(string userID)

  • 功能:检查用户是否在房间中

  • 返回值: true:在房间中, false:不在房间中

  • 参数:

参数 类型 含义
userID string 用户ID

MeetingMemberList getAllMembers()

bool getMemberInfo(string userID, sdkMeetingMember info)

  • 功能:获取房间中指定成员信息

  • 返回值:true: 获取成功, false: 获取失败(用户不在房间中)

  • 参数:

参数 类型 含义
userID string 用户ID
info sdkMeetingMember 返回的成员信息

void kickout(string userID)

  • 功能:将他人请出房间

请出结果请参见kickoutRslt;
被请出人将收到notifyMeetingDropped通知,原因值是:CRVSDK_DROPPED_KICKOUT;
房间中剩余人员(包括操作者)将收到notifyUserLeftMeeting通知;

  • 返回值: 无

  • 参数:

参数 类型 含义
userID string 用户ID

void sendMeetingCustomMsg(string msg, string cookie = "")

  • 功能:发送房间内群消息

发送结果请参见sendMeetingCustomMsgRslt;
只有当前在房间内的人员才能收到此消息;

  • 返回值: 无

  • 参数:

参数 类型 含义
msg string 自定义消息内容,最大8KB字节
cookie string 上下文参数,详细介绍参见关键词

AudioDevInfoList getAudioMics()

AudioDevInfoList getAudioSpks()

sdkAudioCfg getAudioCfg()

  • 功能:得到当前音频配置

  • 返回值: sdkAudioCfg

void setAudioCfg(sdkAudioCfg cfg)

  • 功能:设置音频参数

  • 返回值: 无

  • 参数:

参数 类型 含义
cfg sdkAudioCfg 音频参数

void setMicVolume(int volume)

  • 功能:配置麦克风音量

  • 返回值: 无

  • 参数:

参数 类型 含义
volume int 音量,0~255

int getMicVolume()

  • 功能:获取麦克风音量

  • 返回值: 音量,0~255

void setSpkVolume(int volume)

  • 功能:配置扬声器音量

  • 返回值: 无

  • 参数:

参数 类型 含义
volume int 音量,0~255

int getSpkVolume()

  • 功能:获取扬声器音量

  • 返回值: 音量,0~255

int getLocMicDevEnergy()

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

房间中关麦仍能获取当前麦设备的能量值;
如果想获取在房间中的能量值,请使用getUserMicEnergy;

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

int getUserMicEnergy(string userID)

  • 功能:获取房间中指定人员麦克风能量等级

房间中关麦后,获取的麦能量值将为0
如果想获取当前麦设备实际能量值,请使用getLocMicDevEnergy;

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

  • 参数:

参数 类型 含义
userID string 用户ID

void openMic(string userID)

  • 功能:开麦(将麦克风声音送入房间)

打开自已的麦克风时,先会进入到CRVSDK_AST_OPENING状态,等服务器处理后才会进入CRVSDK_AST_OPEN状态;
当用户的麦克风状态变为CRVSDK_AST_OPEN状态时,说话才能被采集到;
一个房间最大开麦数为8,超出的开麦人将保持在CRVSDK_AST_OPENING状态;
CRVSDK_AST_OPENING状态的麦不会在有人关麦时自动打开,需要按需再次执行openMic;
麦克风状态改变时,房间中所有人将收到notifyMicStatusChanged通知;

  • 返回值: 无

  • 参数:

参数 类型 含义
userID string 用户ID

void closeMic(string userID)

  • 功能:关麦(麦克风声音停止送入房间)

关麦操作是立即生效的,本地会立即停止采集;
房间中所有人将收到notifyMicStatusChanged通知;

  • 返回值: 无

  • 参数:

参数 类型 含义
userID string 用户ID

CRVSDK_ASTATUS getMicStatus(string userID)

  • 功能:获取指定人员的麦克风状态

  • 返回值: CRVSDK_ASTATUS

  • 参数:

参数 类型 含义
userID string 用户ID

void closeAllMic()

  • 功能:全体关麦

全体关麦时,不关闭操作者自已的麦;

  • 返回值: 无

CRVSDK_ERR_DEF startEchoTest()

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

环回测试时,将听不到其房间中的声音,房间中其他人也听不到本端的声音;

void stopEchoTest()

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

  • 返回值: 无

bool isEchoTesting()

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

  • 返回值: 是否测试中

void setVoiceChange(string userID, int type)

  • 功能:设置指定人变声

变声功能为服务器实现,所以本地录制、本地声音环回测试,声音都是不变声过的;

  • 返回值: 无

  • 参数:

参数 类型 含义
userID string 用户ID
type int 详细介绍参见 CRVSDK_VOICECHANGE_TYPE 变声类型

int getVoiceChangeType(string userID)

参数 类型 含义
userID string 用户ID

VideoDevInfoList getAllVideoInfo(string userID)

  • 功能:获取指定人员的摄像头信息

  • 返回值: 摄像头信息列表 List<sdkVideoDevInfo>

  • 参数:

参数 类型 含义
userID string 用户ID

CRVSDK_ERR_DEF setVideoCfg(string jsonCfg)

  • 功能:设置本地视频全局配置

  • 返回值: CRVSDK_ERR_DEF,CRVSDKERR_NOERR代表调用成功

  • 参数:

参数 类型 含义
jsonCfg string json格式,请参见sdkVideoCfg

string getVideoCfg()

  • 功能:获取本地视频全局配置

  • 返回值: 视频全局配置string,json格式,请参见sdkVideoCfg

void setDefaultVideo(int videoID)

  • 功能:配置本地默认摄像头

sdk内部会自动产生默认摄像头,除非系统没有任何真实摄像头、自定义摄像头、网络摄像头等;
当默认摄像头被移除时,sdk内部会自动产生一个新的默认摄像头;
sdk内部产生默认摄像头时,优先将将打开的多摄像头上选择;

  • 返回值: 无

  • 参数:

参数 类型 含义
videoID int 摄像头ID

int getDefaultVideo(string userID)

  • 功能:获取本地或他人的默认摄像头

  • 返回值: 摄像头ID, 0代表没有默认摄像头;

  • 参数:

参数 类型 含义
userID string 用户ID

void setMutiVideos(const int moreVideoIDs[], int count)

  • 功能:配置本地多摄像头

  • 返回值: 无

  • 参数:

参数 类型 含义
moreVideoIDs int[] 开启更多摄像头(不应该包含默认摄像头,即使传入也会被忽略)
count int moreVideoIDs个数,0代表关闭多摄像头功能

List<int> getMutiVideos(string userID)

  • 功能:获取本地的或他人的多摄像头

  • 返回值: 摄像头ID列表 List<int>

  • 参数:

参数 类型 含义
userID string 用户ID

void openVideo(string userID)

  • 功能:打开指定人的摄像头

打开用户的摄像头,以便本地、远端显示视频图像;
打开多个摄像头,参见setMutiVideos;

  • 返回值: 无

  • 参数:

参数 类型 含义
userID string 用户ID

void closeVideo(string userID)

  • 功能:关闭指定人的摄像头

  • 返回值: 无

  • 参数:

参数 类型 含义
userID string 用户ID

CRVSDK_VSTATUS getVideoStatus(string userID)

  • 功能:获取房间中视频状态

  • 返回值: CRVSDK_VSTATUS

  • 参数:

参数 类型 含义
userID string 用户ID

void setVideoEffects(string efs)

  • 功能:本地视频效果配置

  • 返回值: 无

  • 参数:

参数 类型 含义
efs string 视频效果配置,json字符串,请参见CRVideoEffectsObj

string getVideoEffects()

  • 功能:本地视频效果配置

  • 返回值: 视频效果配置json字符串,请参见CRVideoEffectsObj

sdkVideoFrame getUserVideoFrame(sdkUserVideoID vID)

  • 功能:获取渲染中的指定人员摄像头的图像帧

只能获取已经观看中的摄像头的图像帧;
如果获取图像还未到来,或解码不成功,获取的结果将为空;

参数 类型 含义
vID sdkUserVideoID 图像标识

int addIPCam(string url, string jsonParam)

  • 功能:添加网络摄像头

最多支持添加5个;
添加成功后与本地摄像头处理一致;本地通过getAllVideoInfo接口可以识别哪些是网络摄像头;
添加的摄像头在CRVideoSDKMain被销毁时被删除;
此接口线程安全;

  • 返回值: 返回值>=0代表添加成功,返回值为videoID(摄像头ID); 返回值<0代表添加失败,参见CRVSDK_ERR_DEF

  • 参数:

参数 类型 含义
url string 网络摄像头url,支持协议:rtmp,rtsp
jsonParam string json格式参数, 支持:
name:摄像头名称,不配置则为url
maxRetry:连接失败或中断连时重试连接次数,<0代表无限重试,默认值-1

void delIPCam(int videoID)

  • 功能:删除网络摄像头, 此接口线程安全

  • 返回值: 无

  • 参数:

参数 类型 含义
videoID int 摄像头ID

int createScreenCamDev(string camName, string jsonParam="")

  • 功能:添加桌面摄像头

最多支持添加5个;
添加成功后与本地摄像头处理一致;
本地通过getAllVideoInfo接口可以识别哪些是桌面摄像头;
创建时对应monitorID不存在时将失败,运行中monitorID对应的屏关闭时显示全黑,开启后恢复正常工作;
添加的摄像头在CRVideoSDKMain被销毁时被删除;
此接口线程安全;

  • 返回值: 返回值>=0代表添加成功,返回值为videoID(摄像头ID); 返回值<0代表添加失败,参见CRVSDK_ERR_DEF

  • 参数:

参数 类型 含义
camName string 摄像头名称
jsonParam string 屏幕参数,json格式,支持以下可选参数:
屏幕编号:"monitorID":-1, -1代表主屏,序号从0开始,顺序与系统一致,无此参数时代表不限定屏幕。
屏幕区域:"catchRect":{"left":0,"top":0,"width":640,"height":360}, 全局绝对坐标

不支持空参数,多个参数时取交集

void destroyScreenCamDev(int videoID)

  • 功能:删除桌面摄像头, 此接口线程安全

  • 返回值: 无

  • 参数:

参数 类型 含义
videoID int 摄像头ID

void startPlayMedia(string filename, bool bLocPlay=false, bool bPauseWhenFinished=false)

  • 功能:开始影音共享

支持本地完整路径文件,支持mp4、flv、avi、wmv、mkv、mov、3gp、wma、mp3、m4a、wav等常见文件格式;
支持网络媒体流,支持的协议有:rtmp、rtsp、http(http的媒体文件,并非网页);
一个房间同一时间只能一个影音共享(本地播放除外);
开启共享失败时,将有startPlayMediaFail回调;
开启共享成功时,房间内所有人都将收到notifyMediaStart通知;
开启共享成功后,共享端开始向房间内播放文件,共享者在文件打开成功时将收回notifyMediaOpened回调;
共享中,如果文件打开失败、或中途读取失败、或播放结果, sdk内部将自动停止影音共享,房间内所有人都将收到notifyMediaStop通知;

  • 返回值: 无

  • 参数:

参数 类型 含义
filename string 媒体文件名
bLocPlay bool 是否本地播放。本地播放时,声音图像不会送入房间,适用于本地录像检测
bPauseWhenFinished bool 文件正常播放完成时,暂停在文件未尾

void pausePlayMedia(bool bPause)

  • 功能:暂停影音共享

共享暂停后,房间内所有人将收到notifyMediaPause通知;

  • 返回值: 无

  • 参数:

参数 类型 含义
bPause bool 暂停共享/恢复共享

void setMediaPlayPos(int ms)

  • 功能:设置播放位置

  • 返回值: 无

  • 参数:

参数 类型 含义
ms int 设置播放位置,单位:毫秒

void stopPlayMedia()

  • 功能:停止影音共享

可以停止本地或他人的影音共享;
影音共享被停止时,房间内所有人将收到notifyMediaStop通知;

  • 返回值: 无

sdkMediaInfo getMediaInfo()

  • 功能:获取当前影音共享信息

  • 返回值: sdkMediaInfo

void setMediaVolume(int volume)

  • 功能:配置影音播放音量

此调整同时影响本地影音的播放音量,也影晌他人的影音播放音量;
此调整不影响他人的说话声音大小;

  • 返回值: 无

  • 参数:

参数 类型 含义
volume int 影音音量,取值:0~255

int getMediaVolume()

  • 功能:获取影音播放音量

  • 返回值: 当前的影音播放音量

  • 参数:无

sdkVideoFrame getMediaImg()

  • 功能:获取影音播放的图像帧

如果影音播放未开始,或解码不成功,获取的结果将为空;

CRVSDK_ERR_DEF createLocMixer(string mixerID, string mixerCfg, string mixerContent)

  • 功能:创建本地混图器

开启成功后,可以通过updateLocMixerContent更新内容;
开启成功后,可以通过addLocMixerOutput添加输出目标,如输出到文件,或输出到网络直播流;
混图器如果异常停止时,将通过notifyLocMixerStateChanged回调用户;

  • 返回值: CRVSDK_ERR_DEF,CRVSDKERR_NOERR代表调用成功

  • 参数:

参数 类型 含义
mixerID string 混图器ID
mixerCfg string 混图器规格配置,json格式,参见CRLocMixerCfgObj
mixerContent string 混图器内容配置,json格式,list<CRMixerContentObj>

CRVSDK_ERR_DEF updateLocMixerContent(string mixerID, string mixerContent)

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

  • 返回值: CRVSDK_ERR_DEF,CRVSDKERR_NOERR代表调用成功

  • 参数:

参数 类型 含义
mixerID string 混图器ID, 请确保通过createLocMixer创建了有效的混图器
mixerContent string 混图器内容配置,json格式,list<CRMixerContentObj>

CRVSDK_ERR_DEF addLocMixerOutput(string mixerID, string mixerOutput)

  • 功能:添加混图器输出

添加输出节点后,可以通过notifyLocMixerOutputInfo关注输出信息

  • 返回值: CRVSDK_ERR_DEF,CRVSDKERR_NOERR代表调用成功

  • 参数:

参数 类型 含义
mixerID string 混图器ID, 请确保通过createLocMixer创建了有效的混图器
mixerOutput string 混图器输出配置,json格式,list<CRLocMixerOutputObj>

void rmLocMixerOutput(string mixerID, string nameOrUrls)

  • 功能:移除混图器输出

移除输出时,内部将结束文件录制,或结束直播推流;

  • 返回值: 无

  • 参数:

参数 类型 含义
mixerID string 混图器ID, 请确保通过createLocMixer创建了有效的混图器
nameOrUrls string 要移除的输出的filename或liveUrl, 支持多值,以";"分隔;

void destroyLocMixer(string mixerID)

  • 功能:销毁本地混图器

销毁本地混图器时,内部将自动正常移除所有输出;

  • 返回值: 无

  • 参数:

参数 类型 含义
mixerID string 混图器ID, 请确保通过createLocMixer创建了有效的混图器

CRVSDK_MIXER_STATE getLocMixerState(string mixerID)

参数 类型 含义
mixerID string 混图器ID, 请确保通过createLocMixer创建了有效的混图器

string createCloudMixer(string cfg);

  • 功能:创建云端混图器

可以开启多个云端混图器,具体个数和企业购买的授权相关;
开启云端混图器后,房间内所有人都将收到notifyCloudMixerStateChanged通知进入CRVSDK_MIXER_STARTING(启动中状态);
云端混图器部署有少量耗时,如果在部署过程遇到异常,将收到createCloudMixerFailed回调;
云端混图器启动完成并进入录制或推流状态时,将收到notifyCloudMixerStateChanged通知,进入CRVSDK_MIXER_RUNNING(工作中状态);
开启云端混图器在进入CRVSDK_MIXER_STARTING状态后,可以通过updateCloudMixerContent更新内容;
混图器如果在工作中遇到异常而停止时,将收到notifyCloudMixerStateChanged通知,进入CRVSDK_MIXER_NULL并携带错误原因;

  • 返回值: 云端混图器ID

  • 参数:

参数 类型 含义
cfg string 云端混图器配置,josn格式,参见CRCloudMixerCfgObj

CRVSDK_ERR_DEF updateCloudMixerContent(string mixerID, string cfg)

  • 功能:更新云端混图器

更新混图器内容时,只能更新内容和布局,不能更改混图器规格、输出目标;
更新混图器内容时,房间内所有人都将收到notifyCloudMixerInfoChanged通知;

  • 返回值: CRVSDK_ERR_DEF,CRVSDKERR_NOERR代表调用成功

  • 参数:

参数 类型 含义
mixerID string 混图器ID, 参见createCloudMixer
cfg string 混图器内容配置,josn格式,参见CRCloudMixerCfgObj

void destroyCloudMixer(string mixerID)

  • 功能:销毁云端混图器

销毁云端混图器时,调用者将收到notifyCloudMixerStateChanged通知进入CRVSDK_MIXER_STOPPING状态,在停止完成后,房间内所有人都将收到notifyCloudMixerStateChanged通知进入CRVSDK_MIXER_NULL状态;

  • 返回值: 无

  • 参数:

参数 类型 含义
mixerID string 混图器ID, 参见createCloudMixer

string getAllCloudMixerInfo()

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

  • 返回值: json格式字符串, 参见CRCloudMixerInfoList

string getCloudMixerInfo(string mixerID)

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

  • 返回值: json格式字符串, 参见CRCloudMixerInfo

  • 参数:

参数 类型 含义
mixerID string 混图器ID, 参见createCloudMixer

void getMeetingAllAttrs(string cookie = "")

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

获取结果请参见:getMeetingAllAttrsSuccess 或 getMeetingAllAttrsFail

  • 返回值: 无

  • 参数:

参数 类型 含义
cookie string 上下文参数,详细介绍参见关键词

void getMeetingAttrs(string jsonKeys, string cookie = "")

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

获取结果请参见:getMeetingAttrsSuccess 或 getMeetingAttrsFail

  • 返回值: 无

  • 参数:

参数 类型 含义
jsonKeys string 需要查询的房间属性key,json格式,如:["key1", "key2"]
cookie string 上下文参数,详细介绍参见关键词

void setMeetingAttrs(string jsonAttrs, string options = "", string cookie = "")

  • 功能:重置所有房间属性

设置结果请参见:setMeetingAttrsRslt

  • 返回值: 无

  • 参数:

参数 类型 含义
jsonAttrs string 房间属性集,json格式,如:{"key1":"value1", "key2":"value2"} (key最大长度为64B,value最大长度为8KB)
options string 操作选项,json格式参见CRMeetingAttrOptions
cookie string 上下文参数,详细介绍参见关键词

void addOrUpdateMeetingAttrs(string jsonAttrs, string options = "", string cookie = "")

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

结果请参见:addOrUpdateMeetingAttrsRslt

  • 返回值: 无

  • 参数:

参数 类型 含义
jsonAttrs string 房间属性集,json格式,如:{"key1":"value1", "key2":"value2"} (key最大长度为64B,value最大长度为8KB)
options string 操作选项,json格式参见CRMeetingAttrOptions
cookie string 上下文参数,详细介绍参见关键词

void delMeetingAttrs(string jsonKeys, string options = "", string cookie = "")

  • 功能:删除房间属性

结果请参见:delMeetingAttrsRslt

  • 返回值: 无

  • 参数:

参数 类型 含义
jsonKeys string 需要删除的房间属性key,json格式,如:["key1", "key2"]
options string 操作选项,json格式参见CRMeetingAttrOptions
cookie string 上下文参数,详细介绍参见关键词

void clearMeetingAttrs(string options = "", string cookie = "")

  • 功能:清空房间属性

结果请参见:clearMeetingAttrsRslt

  • 返回值: 无

  • 参数:

参数 类型 含义
options string 操作选项,json格式参见CRMeetingAttrOptions
cookie string 上下文参数,详细介绍参见关键词

void getUserAttrs(string jsonUserIds, string jsonKeys = "", string cookie = "")

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

结果请参见:getUserAttrsSuccess 或 getUserAttrsFail

  • 返回值: 无

  • 参数:

参数 类型 含义
jsonUserIds string 目标用户id列表,一次最多包含50个用户,json格式, 如:["userId1","userId2"]
jsonKeys string 将要获取的用户属性key列表(空串代表获取全部),json格式,如:["key1","key2"]
cookie string 上下文参数,详细介绍参见关键词

void setUserAttrs(string userId, string jsonAttrs, string options = "", string cookie = "")

  • 功能:重置指定用户的属性

结果请参见:setUserAttrsRslt

  • 返回值: 无

  • 参数:

参数 类型 含义
userId string 目标用户id
jsonAttrs string 用户属性集, json格式,如:{"key1":"value1", "key2":"value2"} (key最大长度为64B,value最大长度为8KB)
options string 操作选项,json格式参见CRMeetingAttrOptions
cookie string 上下文参数,详细介绍参见关键词

void addOrUpdateUserAttrs(string userId, string jsonAttrs, string options = "", string cookie = "")

  • 功能:添加或更新指定用户的属性

结果请参见:addOrUpdateUserAttrsRslt

  • 返回值: 无

  • 参数:

参数 类型 含义
userId string 目标用户id
jsonAttrs string 用户属性集, json格式,如:{"key1":"value1", "key2":"value2"} (key最大长度为64B,value最大长度为8KB)
options string 操作选项,json格式参见CRMeetingAttrOptions
cookie string 上下文参数,详细介绍参见关键词

void delUserAttrs(string userId, string jsonKeys, string options = "", string cookie = "")

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

结果请参见:delUserAttrsRslt

  • 返回值: 无

  • 参数:

参数 类型 含义
userId string 目标用户id
jsonKeys string 需要删除的用户属性key列表,json格式,如:["key1","key2"]
options string 操作选项,json格式参见CRMeetingAttrOptions
cookie string 上下文参数,详细介绍参见关键词

void clearUserAttrs(string userId, string options = "", string cookie = "")

  • 功能:清空指定用户的属性

结果请参见:clearUserAttrsRslt

  • 返回值: 无

  • 参数:

参数 类型 含义
userId string 目标用户id
options string 操作选项,json格式参见CRMeetingAttrOptions
cookie string 上下文参数,详细介绍参见关键词

void clearAllUserAttrs(string options = "", string cookie = "")

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

结果请参见:clearAllUserAttrsRslt

  • 返回值: 无

  • 参数:

参数 类型 含义
options string 操作选项,json格式参见CRMeetingAttrOptions
cookie string 上下文参数,详细介绍参见关键词

sdkScreenShareInfo getScreenShareInfo()

ScreenCaptureSourceInfoList getScreenCaptureSources(int thumbWidth, int thumbHeight, int iconWidth, int iconHeihgt, int types = CRVSDK_CAPSOURCE_ALL)

  • 功能:获取屏幕采集源列表,该方法仅适用于 Windows 和 macOS。

  • 参数:

参数 类型 含义
thumbWidth
thumbHeight
int 采集源的缩略图的目标尺寸(宽高单位为像素)。SDK 会在保证原图不变形的前提下,缩放原图,使图片最长边和目标尺寸的最长边的长度一致。例如,原图宽高为 400x300,thumbSize 为 100x100,缩略图实际尺寸为 100x75。如果目标尺寸大于原图尺寸,缩略图即为原图,SDK 不进行缩放操作
iconWidth
iconHeight
int 采集源的图标的目标尺寸(宽高单位为像素)。SDK 会在保证原图不变形的前提下,缩放原图,使图片最长边和目标尺寸的最长边的长度一致。例如,原图宽高为 400x300,iconSize 为 100x100,图标实际尺寸为 100x75。如果目标尺寸大于原图尺寸,图标即为原图,SDK 不进行缩放操作。
types int 获取的源类型,一个或多个CRVSDK_SCREENCAPTURESOURCE_TYPE按位组成的值

void setScreenShareCfg(string cfg)

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

  • 返回值: 无

  • 参数:

参数 类型 含义
cfg string 屏幕共享配置, josn格式参见CRScreenShareCfg

void startScreenShare()

  • 功能:开始屏幕共享

开始结果请参见:startScreenShareRslt
开始成功后,sdk内部将自动完成抓屏共享处理

  • 返回值: 无

void stopScreenShare()

  • 功能:停止屏幕共享

结果请参见:stopScreenShareRslt

  • 返回值: 无

sdkVideoFrame getScreenShareImg()

  • 功能:获取屏幕共享的图像帧

如果屏幕共享未开始,或解码不成功,获取的结果将为空;

private void enterMeetingRslt(CRVSDK_ERR_DEF sdkErr)

  • 功能:进入房间结果

  • 返回值:无

  • 参数:

参数 类型 含义
sdkErr CRVSDK_ERR_DEF CRVSDK_NOERR代表成功,其它值代表失败的具体原因

private void notifyNetStateChanged(int level)

  • 功能:通知网络状态变化

  • 返回值:无

  • 参数:

参数 类型 含义
level int 网络评分0~10(10分为最佳网络)

private void notifyMeetingStopped()

  • 功能:通知房间被结束

  • 返回值:无

private void notifyMeetingDropped(CRVSDK_MEETING_DROPPED_REASON reason)

  • 功能:通知与房间断开

  • 返回值:无

  • 参数:

参数 类型 含义
reason CRVSDK_MEETING_DROPPED_REASON 断开原因

private void notifyUserEnterMeeting(string userID)

  • 功能:通知有人进入房间

  • 返回值:无

  • 参数:

参数 类型 含义
userID string 用户ID

private void notifyUserLeftMeeting(string userID)

  • 功能:通知有人离会

  • 返回值:无

  • 参数:

参数 类型 含义
userID string 用户ID

private void setNickNameRslt(string userID, CRVSDK_ERR_DEF sdkErr)

  • 功能:修改昵称结果

  • 返回值:无

  • 参数:

参数 类型 含义
userID string 用户ID
sdkErr CRVSDK_ERR_DEF CRVSDK_NOERR代表成功,其它值代表失败的具体原因

private void notifyNickNameChanged(string userID, string oldName, string newName, string oprUserID)

  • 功能:通知昵称变化

  • 返回值:无

  • 参数:

参数 类型 含义
userID string 用户ID
oldName string 旧昵称
newName string 新昵称
oprUserID string 操作者用户ID

private void kickoutRslt(CRVSDK_ERR_DEF sdkErr, string userID)

  • 功能:请出房间结果

  • 返回值:无

  • 参数:

参数 类型 含义
userID string 用户ID
sdkErr CRVSDK_ERR_DEF CRVSDK_NOERR代表成功,其它值代表失败的具体原因

private void sendMeetingCustomMsgRslt(CRVSDK_ERR_DEF sdkErr, string cookie)

  • 功能:发送房间内广播消息结果

  • 返回值:无

  • 参数:

参数 类型 含义
sdkErr CRVSDK_ERR_DEF CRVSDK_NOERR代表成功,其它值代表失败的具体原因
cookie string 上下文参数,详细介绍参见关键词

private void notifyMeetingCustomMsg(string fromUserID, string msg)

  • 功能:通知房间内广播消息

  • 返回值:无

  • 参数:

参数 类型 含义
fromUserID string 发送者用户ID
msg string 自定义消息内容

private void notifyAudioDevChanged()

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

  • 返回值:无

private void notifyMicStatusChanged(string userID, CRVSDK_ASTATUS oldStatus, CRVSDK_ASTATUS newStatus, string oprUserID)

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

  • 返回值:无

  • 参数:

参数 类型 含义
userID string 用户ID
oldStatus CRVSDK_ASTATUS 旧的麦克风状态
newStatus CRVSDK_ASTATUS 新的麦克风状态
oprUserID string 操作者用户ID

private void notifyMicEnergy(string userID, int oldLevel, int newLevel)

  • 功能:通知用户房间内声音能量变化

  • 返回值:无

  • 参数:

参数 类型 含义
userID string 用户ID
oldLevel int 之前的说话声音强度(0~10)
newLevel int 现在的说话声音强度(0~10)

private void notifyCloseAllMic(string oprUserID)

  • 功能:通知有人发起了全体关麦操作

  • 返回值:无

  • 参数:

参数 类型 含义
oprUserID string 操作者用户ID

private void notifySetVoiceChange(string userID, int type, string oprUserID)

  • 功能:通知变声类型改变

  • 返回值:无

  • 参数:

参数 类型 含义
userID string 用户ID
type int 详细介绍参见 CRVSDK_VOICECHANGE_TYPE 变声类型
oprUserID string 操作者用户ID

private void notifyVideoDevChanged(string userID)

  • 功能:通知用户视频设备变化(设备个数、设备能力参数、默认设备、启停多摄像头等)

  • 返回值:无

  • 参数:

参数 类型 含义
userID string 用户ID

private void notifyDefaultVideoChanged(string userID, int videoID)

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

  • 返回值:无

  • 参数:

参数 类型 含义
userID string 用户ID
videoID int 默认设备id

private void openVideoDevRslt(int videoID, bool isSucceed)

  • 功能:本地视频设备打开结果

  • 返回值:无

  • 参数:

参数 类型 含义
videoID int 默认设备id
isSucceed bool 打开结果

private void notifyVideoStatusChanged(string userID, int oldStatus, int newStatus, string oprUserID)

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

  • 返回值:无

  • 参数:

参数 类型 含义
userID string 用户ID
oldStatus CRVSDK_VSTATUS 之前的状态
newStatus CRVSDK_VSTATUS 当前的状态
oprUserID string 操作者用户ID

private void startPlayMediaFail(CRVSDK_ERR_DEF sdkErr)

  • 功能:开启影音共享功能失败

  • 返回值:无

  • 参数:

参数 类型 含义
sdkErr CRVSDK_ERR_DEF CRVSDK_NOERR代表成功,其它值代表失败的具体原因

private void notifyMediaStart(string userID)

  • 功能:通知影音共享开启

  • 返回值:无

  • 参数:

参数 类型 含义
userID string 用户ID

private void notifyMediaOpened(int totalTime, int w, int h)

  • 功能:通知本端影音共享文件打开成功

  • 返回值:无

  • 参数:

参数 类型 含义
totalTime int 文件总时长(ms), -1代表没有总时长(通常为网络摄像头、直播流等)
w int 图像宽
h int 图像高

private void notifyMediaStop(string userID, CRVSDK_MEDIA_STOPREASON reason)

  • 功能:通知影音共享停止

  • 返回值:无

  • 参数:

参数 类型 含义
userID string 用户ID
reason CRVSDK_MEDIA_STOPREASON 停止的原因

private void notifyMediaPause(string userID, bool bPause)

  • 功能:通知影音共享停止

  • 返回值:无

  • 参数:

参数 类型 含义
userID string 用户ID
bPause bool 是否暂停

private void notifyLocMixerStateChanged(string mixerID, CRVSDK_MIXER_STATE state)

  • 功能:通知本地录制/推流状态变化

  • 返回值:无

  • 参数:

参数 类型 含义
mixerID string 混图器ID
state CRVSDK_MIXER_STATE 状态

private void notifyLocMixerOutputInfo(string mixerID, string nameOrUrl, string outputInfo)

  • 功能:通知本地录制/推流状态变化

  • 返回值:无

  • 参数:

参数 类型 含义
mixerID string 混图器ID
nameOrUrl string 输出的目标
outputInfo string json格式,请参见CRLocMixerOutputInfoObj

private void createCloudMixerFailed(string mixerID, CRVSDK_ERR_DEF sdkErr)

  • 功能:创建云端录制/推流失败

  • 返回值:无

  • 参数:

参数 类型 含义
mixerID string 混图器ID
sdkErr CRVSDK_ERR_DEF CRVSDK_NOERR代表成功,其它值代表失败的具体原因

private void notifyCloudMixerStateChanged(string mixerID, CRVSDK_MIXER_STATE state, string exParam, string operUserID)

  • 功能:通知云端录制/推流状态变化

  • 返回值:无

  • 参数:

参数 类型 含义
mixerID string 混图器ID
state CRVSDK_MIXER_STATE 录制状态
exParam string json格式扩展参数,state状态及参数定义:
MIXER_NULL:包含err(CRVSDK_ERR_DEF), errDesc字段;
MIXER_STARTING:包含jsonCfg字段
operUserID string 操作者用户ID

private void notifyCloudMixerOutputInfoChanged(string mixerID, string jsonStr)

  • 功能:通知云端录制/推流输出信息

  • 返回值:无

  • 参数:

参数 类型 含义
mixerID string 混图器ID
jsonStr string json格式,请参见CRCloudMixerOutputInfo

private void notifyCloudMixerInfoChanged(string mixerID)

  • 功能:通知云端录制/推流信息变化

可调用:getCloudMixerInfo获取相关信息

  • 返回值:无

  • 参数:

参数 类型 含义
mixerID string 混图器ID

private void getMeetingAllAttrsSuccess(string attrs, string cookie)

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

  • 返回值:无

  • 参数:

参数 类型 含义
attrs string 房间属性集,json结构体请参见CRAttrObjs
cookie string 上下文参数,详细介绍参见关键词

private void getMeetingAllAttrsFail(CRVSDK_ERR_DEF sdkErr, string cookie)

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

  • 返回值:无

  • 参数:

参数 类型 含义
sdkErr CRVSDK_ERR_DEF 失败的具体原因
cookie string 上下文参数,详细介绍参见关键词

private void getMeetingAttrsSuccess(string attrs, string cookie)

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

  • 返回值:无

  • 参数:

参数 类型 含义
attrs string 房间属性集,json结构体请参见CRAttrObjs
cookie string 上下文参数,详细介绍参见关键词

private void getMeetingAttrsFail(CRVSDK_ERR_DEF sdkErr, string cookie)

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

  • 返回值:无

  • 参数:

参数 类型 含义
sdkErr CRVSDK_ERR_DEF 失败的具体原因
cookie string 上下文参数,详细介绍参见关键词

private void setMeetingAttrsRslt(CRVSDK_ERR_DEF sdkErr, string cookie)

  • 功能:重置所有房间属性结果

  • 返回值:无

  • 参数:

参数 类型 含义
sdkErr CRVSDK_ERR_DEF CRVSDK_NOERR代表成功,其它值代表失败的具体原因
cookie string 上下文参数,详细介绍参见关键词

private void addOrUpdateMeetingAttrsRslt(CRVSDK_ERR_DEF sdkErr, string cookie)

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

  • 返回值:无

  • 参数:

参数 类型 含义
sdkErr CRVSDK_ERR_DEF CRVSDK_NOERR代表成功,其它值代表失败的具体原因
cookie string 上下文参数,详细介绍参见关键词

private void delMeetingAttrsRslt(CRVSDK_ERR_DEF sdkErr, string cookie)

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

  • 返回值:无

  • 参数:

参数 类型 含义
sdkErr CRVSDK_ERR_DEF CRVSDK_NOERR代表成功,其它值代表失败的具体原因
cookie string 上下文参数,详细介绍参见关键词

private void clearMeetingAttrsRslt(CRVSDK_ERR_DEF sdkErr, string cookie)

  • 功能:清空所有房间属性结果

  • 返回值:无

  • 参数:

参数 类型 含义
sdkErr CRVSDK_ERR_DEF CRVSDK_NOERR代表成功,其它值代表失败的具体原因
cookie string 上下文参数,详细介绍参见关键词

private void notifyMeetingAttrsChanged(string adds, string updates, string delKeys)

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

  • 返回值:无

  • 参数:

参数 类型 含义
adds string 增加房间属性集,json格式,请参见CRAttrObjs
updates string 变化的用户属性集,json格式,请参见CRAttrObjs
delKeys string 被删除的用户属性列表,json格式,如:["key1", "key2"]

private void getUserAttrsSuccess(string attrs, string cookie)

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

  • 返回值:无

  • 参数:

参数 类型 含义
attrs string 用户属性集,json结构体请参见CRUsrAttrObjs
cookie string 上下文参数,详细介绍参见关键词

private void getUserAttrsFail(CRVSDK_ERR_DEF sdkErr, string cookie)

  • 功能:获取指定用户的所有属性失败

  • 返回值:无

  • 参数:

参数 类型 含义
sdkErr CRVSDK_ERR_DEF 失败的具体原因
cookie string 上下文参数,详细介绍参见关键词

private void setUserAttrsRslt(CRVSDK_ERR_DEF sdkErr, string cookie)

  • 功能:重置指定用户的属性结果

  • 返回值:无

  • 参数:

参数 类型 含义
sdkErr CRVSDK_ERR_DEF 失败的具体原因
cookie string 上下文参数,详细介绍参见关键词

private void addOrUpdateUserAttrsRslt(CRVSDK_ERR_DEF sdkErr, string cookie)

  • 功能:添加或更新指定用户的属性结果

  • 返回值:无

  • 参数:

参数 类型 含义
sdkErr CRVSDK_ERR_DEF 失败的具体原因
cookie string 上下文参数,详细介绍参见关键词

private void delUserAttrsRslt(CRVSDK_ERR_DEF sdkErr, string cookie)

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

  • 返回值:无

  • 参数:

参数 类型 含义
sdkErr CRVSDK_ERR_DEF 失败的具体原因
cookie string 上下文参数,详细介绍参见关键词

private void clearAllUserAttrsRslt(CRVSDK_ERR_DEF sdkErr, string cookie)

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

  • 返回值:无

  • 参数:

参数 类型 含义
sdkErr CRVSDK_ERR_DEF 失败的具体原因
cookie string 上下文参数,详细介绍参见关键词

private void clearUserAttrsRslt(CRVSDK_ERR_DEF sdkErr, string cookie)

  • 功能:清空指定用户的属性结果

  • 返回值:无

  • 参数:

参数 类型 含义
sdkErr CRVSDK_ERR_DEF 失败的具体原因
cookie string 上下文参数,详细介绍参见关键词

private void notifyUserAttrsChanged(string userId, string adds, string updates, string delKeys)

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

  • 返回值:无

  • 参数:

参数 类型 含义
userId string 用户ID
adds string 增加的用户属性集,json格式,请参见CRAttrObjs
updates string 变化的用户属性集,json格式,请参见CRAttrObjs
delKeys string 被删除的用户属性列表,json格式,如:["key1", "key2"]

private void startScreenShareRslt(CRVSDK_ERR_DEF sdkErr)

  • 功能:开启屏幕共享结果

  • 返回值:无

  • 参数:

参数 类型 含义
sdkErr CRVSDK_ERR_DEF 失败的具体原因

private void stopScreenShareRslt(CRVSDK_ERR_DEF sdkErr)

  • 功能:停止屏幕共享结果

  • 返回值:无

  • 参数:

参数 类型 含义
sdkErr CRVSDK_ERR_DEF 失败的具体原因

private void notifyScreenShareStarted(string userID)

  • 功能:通知屏幕共享开始

  • 返回值:无

  • 参数:

参数 类型 含义
userID string 共享开启人

private void notifyScreenShareStopped(string oprUserID)

  • 功能:通知屏幕共享结束

  • 返回值:无

  • 参数:

参数 类型 含义
oprUserID string 共享停止人