数据结构体定义
sdkLoginDat 登录数据
| 参数 | 类型 | 说明 |
|---|---|---|
| _sdkAuthType | CRVSDK_AUTHTYPE | 鉴权类型,请参见SDK登录鉴权方案 |
| _appID | string | _sdkAuthType为CRVSDK_AUTHTP_SECRET时为必选参数; App ID的相关说明,请参见关键词 |
| _md5_appSecret | string | appSecret的md5值,_sdkAuthType为CRVSDK_AUTHTP_SECRET为必选参数 |
| _token | string | 登录鉴权token,_sdkAuthType为CRVSDK_AUTHTP_TOKEN时为必选参数 |
| _webProtocol | CRVSDK_WEBPROTOCOL | 访问web服务协义类型 |
| _serverAddr | string | 服务器地址,_webProtocol不同取值,请带正确的网络端口 |
| _networkProxy | string | 网络代理, 无代理时传空 |
| _userID | string | 用户ID,长度不能大于128。业务方自由填写,保证同一appID下具有唯一性 |
| _userAuthCode | string | 默认填空。只有开启第三方认证才需要填写。(开启第三方认证时,SDK服务器将连接提前配好的业务方服务器进行实时验证。) |
sdkMeetingMember 房间成员信息
| 参数 | 类型 | 说明 |
|---|---|---|
| _userId | string | 用户ID |
| _nickName | string | 姓名 |
| _audioStatus | CRVSDK_ASTATUS | 音频状态 |
| _videoStatus | CRVSDK_VSTATUS | 视频状态 |
MeetingMemberList 房间成员列表
sdkMeetingMember列表,参见sdkMeetingMember
sdkAudioDevInfo 音频设备信息
| 参数 | 类型 | 说明 |
|---|---|---|
| _id | string | 设备id |
| _name | string | 设备名称 |
AudioDevInfoList 音频设备列表
sdkAudioDevInfo列表,参见sdkAudioDevInfo
sdkVideoDevInfo 视频设备信息
| 参数 | 类型 | 说明 |
|---|---|---|
| _videoID | int | 设备编号(程序重启后可能变化) |
| _devName | string | 设备名称 |
| _devMaxWidth | int | 摄像头支持的最大分辨率宽度 |
| _devMaxHeight | int | 摄像头支持的最大分辨率高度 |
| _devGuid | string | 设备guid, 仅获取本地设备有效 |
| _bDisabled | bool | 设备是否被禁用, 仅获取本地设备有效 |
| _devType | CRVSDK_VDEV_TYPE | 设备类型 |
sdkUserVideoID 用户视频ID
| 参数 | 类型 | 说明 |
|---|---|---|
| _userID | string | 用户id |
| _videoID | int | 设备id |
sdkAudioCfg 音频配置
| 参数 | 类型 | 说明 |
|---|---|---|
| _micGuid | string | 麦克风设备(空代表系统默认设备) |
| _spkGuid | string | 扬声器设备(空代表系统默认设备) |
| _agc | bool | 是否启用声音增益 |
| _ans | bool | 是否启用降噪 |
| _aec | bool | 是否启用回声消除 |
sdkVideoCfg 视频配置
| 参数 | 类型 | 说明 |
|---|---|---|
| size | string | 分辨率:"w*h" |
| fps | int | 视频帧率(1~30) |
| maxbps | int | 可选参数默认值,视频码率 单位为bps,如100kbps填值:100000,1mkbps填值1000000 |
| min_qp | int | 可选参数(默认值22),最佳质量(18~51, 越小质量越好) |
| max_qp | int | 可选参数(默认值32),最低质量(18~51, 越小质量越好) , sdk在网络不好时,智能调低质量,以便降低码率来提升流畅性 |
sdkVideoFrame 视频帧数据
| 接口 | 描述 |
|---|---|
| sdkVideoFrame() | 构造空的视频帧 |
| sdkVideoFrame(CRVSDK_VIDEO_FORMAT fmt, int w, int h, uint8_t **srcDat, int *srcLinesize, int64_t pts) | 设置帧数据,内部将分配内存,并copy srcBuf的内容 |
| void initData(CRVSDK_VIDEO_FORMAT fmt, int w, int h, int64_t pts) | 为帧分配内存空间,可通过getRawDatPtr得到对应内存指针,再进行写入操作 |
| int getWidth() const | 获取帧图像宽 |
| int getHeight() const | 获取帧图像高 |
| int copyDatToBuf(unsigned char *pBuf, int bufLen) const | copy图像数据到目标内存,涉及数据copy效率较低 |
| bool getLinesize(int *lineSize); | 获取linesize指针,不涉及数据copy效率高 |
| bool getRawData(uint8_t *yData, uint8_t *uData, uint8_t *vData); | 获取内部共享的数据指针,不涉及数据copy效率高 |
CRScreenShareCfg 屏幕共享配置参数
| 参数 | 类型 | 说明 |
|---|---|---|
| monitorID | int64_t | 可选参数,屏幕ID,如果要指定具体屏幕,可以传入从getScreenCaptureSources中获取的_sourceId |
| catchWnd | int64_t | 可选参数, 共享指定的窗口ID,可以传入从getScreenCaptureSources中获取的_sourceId |
| catchRect | object | 可选参数, 共享区域,如:{"left":0, "top":0, "width":640, "height":360} |
| encSize | object | 可选参数(默认以抓图的尺寸为准), 固定编码清晰度,用于某些场影限定或保持分辨率用,如{"width":640, "height":360} |
| maxFPS | int | 可选参数(默认值12),最大帧率(1~60) |
| maxKbps | int | 可选参数(默认值2000),最大码率(1~4000) 单位为kbps,如100kbps填值:100,1mkbps填值1000 |
| qp | int | 可选参数(默认值22),画质(0~51,0为无损) |
| shareSound | bool | 可选参数(默认值false),共享电脑声音, 仅适用Windows平台 |
| excludeSharerPID | bool | 可选参数(默认值false),不共享本进程, 仅适用Windows平台 |
| activateWindow | bool | 可选参数(默认值false),是否将共享窗口前置,适用窗口共享 |
| borderHighLight | bool | 可选参数(默认值false),是否将共享源描边高亮,适用Windows和macOS平台 |
| highLightColor | string | 可选参数(默认值#54DB00),共享时描边颜色, 支持格式:"#RGB","#RRGGBB", "#AARRGGBB",适用Windows和macOS平台 |
| highLightColorForPause | string | 可选参数(默认值 #FFC268),暂停共享时描边颜色, 支持格式:"#RGB","#RRGGBB", "#AARRGGBB",适用Windows和macOS平台 |
| highLightWidth | int | 可选参数(默认值5),描边宽度,适用Windows和macOS平台 |
屏幕共享场景:传入正确的monitorID, catchWnd、catchRect不传;
窗口共享场景:传入正确的catchWnd, monitorID、catchRect不传;
区域共享场景:传入正确的catchRect, monitorID、catchWnd不传;
monitorID、catchWnd、catchRect传入多值时,将共享交集内容;
sdkScreenShareInfo 屏幕共享状态信息
| 参数 | 类型 | 说明 |
|---|---|---|
| _state | int | 共享状态, 0:未共享,1:共享中 |
| _sharerUserID | string | 共享者用户ID |
| _ctrlerUserID | string | 当前控制者用户ID |
sdkScreenCaptureSourceInfo 屏幕共享采集源信息
| 参数 | 类型 | 说明 |
|---|---|---|
| _type | CRVSDK_SCREENCAPTURESOURCE_TYPE | 类型 |
| _sourceId | int64_t | 采集源ID,对于窗口,表示窗口 ID(Window ID);对于屏幕,表示屏幕 ID(Display ID) |
| _sourceTitle | string | 采集源标题,适用窗口类型 |
| _sourceName | string | 采集源名称 |
| _thumbImage | sdkVideoFrame | 采集源缩略图 |
| _iconImage | sdkVideoFrame | 采集源图标,适用窗口类型 |
| _primaryMonitor | bool | 是否为主屏,适用屏幕类型 |
| _minimizeWindow | bool | 窗口是否已最小化,适用Windows平台 |
ScreenCaptureSourceInfoList 屏幕共享采集源信息列表
sdkScreenCaptureSource列表,参见sdkScreenCaptureSourceInfo
sdkMediaInfo 影音共享状态信息
| 参数 | 类型 | 说明 |
|---|---|---|
| _state | CRVSDK_MEDIA_STATE | 共享状态 |
| _userID | string | 共享者用户ID |
| _mediaName | string | 共享的文件名 |
CRVideoEffectsObj 视频效果参数
{"denoise":1,"mirror":1}
| 参数 | 类型 | 说明 |
|---|---|---|
| denoise | int | 视频降噪, 取值:0/1, 默值为1 |
| mirror | int | 视频镜像(左右翻转),取值:0/1, 默认为0 |
| upsideDown | int | 视频上下翻转,取值:0/1, 默认为0 |
| deinterlace | int | 视频反交错,取值:0/1, 默认为0 (除非视频采集设备为隔行扫描设备,否则不要开启) |
| degree | int | 旋转角度,<0代表自动,旋转取值:0、90、180、270、360, 默认为自动模式 |
CRLocMixerCfgObj 本地混图器规格配置
{"width":640,"height":360,"frameRate":8,"bitRate":500000,"defaultQP":28,"gop":120}
| 参数 | 类型 | 说明 |
|---|---|---|
| width | int | 图像宽度(要求16的倍数) |
| height | int | 图像高度(要求8的倍数) |
| frameRate | int | 图像帧率,取值范围:1-30(值越大,cpu要求更高,录像推荐15帧,直播推存25帧) |
| bitRate | int | 最高码率(例如1m:1000000),当图像变化小时,平均码率会低于此值 |
| defaultQP | int | 目标质量,缺省值:25。取值范围:0~51,0表示完全无损, 51表示质量非常差,推荐高质量取值18,中质量25, 低质量34 |
| gop | int | I帧周期(I帧周期越大码率越小,但直播延时会越大); 文件录制建议15秒一个I帧,取值:frameRate x 15(frameRate的15倍); 直播建议4秒一个I帧,取值: frameRate x 4(frameRate的4倍); |
CRMixerContentObj 混图器内容
{"type":0,"keepAspectRatio":1,"left":5,"top":10, "width":633,"height":356,"param":{"camid":"usr1.1"}}
| 参数 | 类型 | 说明 |
|---|---|---|
| left | int | 在混图画面中的区域(水平位置) |
| top | int | 在混图画面中的区域(垂直位置) |
| width | int | 在混图画面中的区域宽 |
| height | int | 在混图画面中的区域高 |
| type | int | CRVSDK_MIXER_CONTENT_TYPE,请见后面type描述; |
| keepAspectRatio | int | 内容保持原始比例,0不保持,1保持 |
| param | obj | 如:{"camid":"usrxxx.1"}。请见后面param支持的参数; |
type描述:
- 当type=CRVSDK_MIXCONT_VIDEO时,表示混图的是摄像头,param必须包含camid;
- 当type=CRVSDK_MIXCONT_PIC时,表示混图的是指定的图片,param必须包含resourceid;(仅用于本地混图)
- 当type=CRVSDK_MIXCONT_SCREEN时,表示混图的是本地屏幕,param可以增加附加参数screenid/pid/area/window;(仅用于本地混图)
- 当type=CRVSDK_MIXCONT_MEDIA时,表示混图的是影音共享,不用附加任何参数;
- 当type=CRVSDK_MIXCONT_SCREEN_SHARED时,表示混图的是共享的屏幕,不用附加任何参数;
- 当type=CRVSDK_MIXCONT_WBOARD时,表示混图的是白板,不用附加任何参数;(仅用于云端混图,本地混图应该生成图像用MIXVTP_PIC)
- 当type=CRVSDK_MIXCONT_TEXT时,表示混图的是文本,width和height将被忽略,元素大小由文本信息自动确定。 param必须包含text,可选text-color,bk-color,font-size,text-margin;
param 支持的参数如下:
- camid:用户id.摄像头id, 如:"testuser.1"
- screenid:屏幕序号,-1表示主屏
- pid:进程号
- area:抓屏区域:"x,y,w,h"
- text:文本内容,支持时间戳参数"%timestamp%",格式为:YYYY-MM-DD HH:MM:SS
- text-color:文本颜色,支持格式:"#RGB","#RRGGBB", "#AARRGGBB", 默认"#FFFFFF"
- bk-color:背景色,支持格式:"#RGB","#RRGGBB", "#AARRGGBB", 默认"#7D000000"
- font-size:字体大小,默认18
- text-margin:边距,默认5
CRLocMixerOutputObj 本地混图器输出配置
输出到文件配置:{"type":0,"filename":"D:/1.mp4"}
直播推流配置:{"type":1,"liveUrl":"rtmp://xxx"}
当输出到文件时,参数如下:
| 参数 | 类型 | 说明 |
|---|---|---|
| type | int | 录制文件CRVSDK_MIXER_OUTPUT_FILE |
| filename | string | 录像路径文件名(如:d:/1.mp4),支持的文件格式为mp4/ts/flv/avi,其中flv和ts两种格式在程序异常结束时产生的录制文件仍可用。 |
| encryptType | int | 可选参数,录像文件是否加密,0:不加密(默认值),1:加密; |
当输出推流时,参数如下:
| 参数 | 类型 | 说明 |
|---|---|---|
| type | int | 直播推流CRVSDK_MIXER_OUTPUT_LIVE |
| liveUrl | string | 直播推流地址,支持rtmp/rtsp; |
| errRetryTimes | int | 可选参数,直播推流异常时,重试次数,默认值0 |
CRLocMixerOutputInfoObj 本地混图器输出信息
{ "state":2, "duration":100,"fileSize":10000 }
| 参数 | 类型 | 说明 |
|---|---|---|
| state | int | 状态,参见CRVSDK_LOCMIXER_OUTPUT_STATE state为CRVSDK_LOCMO_RUNNING时:duration, fileSize参数有效; state为CRVSDK_LOCMO_STOPPED时:duration, fileSize参数有效; state为CRVSDK_LOCMO_FAIL时:errCode参数有效; |
| duration | int | 录像文件时长,单位:毫秒 |
| fileSize | int | 录像文件大小,单位:字节 |
| errCode | CRVSDK_ERR_DEF | 错误码 |
CRCloudMixerCfgObj 云端混图器配置
//为房间中所有人录制独立的声音文件,独立的默认摄像头视频文件
{
"mode": 1,
"audioFileCfg": {
"svrFileNameSuffix": ".mp3",
"svrPath": "/xxx",
"subscribeAudios": ["_cr_all_"]
},
"videoFileCfg": {
"aStreamType": 1,
"svrFileNameSuffix": ".mp4",
"svrPath": "/xxx",
"subscribeVideos": ["_cr_allDefCam_"]
}
}
//录制一个2分屏左右布局图像+房间声音的mp4文件
{
"mode": 0,
"videoFileCfg": {
"svrPathName": "/2021-09-24/2021-09-24_13-47-41_Win32_73542046.mp4",
"vWidth": 1280,
"vHeight": 720,
"vFps": 15,
"layoutConfig": [
{
"type": 0,
"top": 180,
"left": 0,
"width": 640,
"height": 360,
"keepAspectRatio": 1,
"param": {"camid": "1.-1"}
},
{
"type": 0,
"top": 180,
"left": 640,
"width": 640,
"height": 360,
"keepAspectRatio": 1,
"param": {"camid": "2.-1"}
}
]
}
}
| 参数 | 类型 | 说明 | 是否必传 |
|---|---|---|---|
| mode | int | 录制模式,取值范围: 0-合流模式:将声音录制到一个声音文件、或将声音图像录制成一个视频文件; 1-单流模式:将涉及到的声音流、图像流存到各自独立的文件中; |
是 |
| audioFileCfg | CRCloudMixerAudioFileCfg | 生成音频文件配置,生成规则:进入房间并开启麦克风开始生成文件,离开房间结束生成文件 | 否 |
| videoFileCfg | CRCloudMixerVideoFileCfg | 生成视频文件配置,生成规则:进入房间并开启摄像头开始生成文件,离开房间结束生成文件 | 否 |
| storageConfig | CRCloudStorageConfig | 云存储配置,不配置时将存储在SDK服务器上 | 否 |
CRCloudMixerAudioFileCfg 云端录制语音文件配置
单流模式参数:
| 参数 | 类型 | 说明 | 是否必传 |
|---|---|---|---|
| svrPath | string | 服务器存储路径,默认为空 | 否 |
| svrFileNameSuffix | string | 文件名后缀,支持:“.mp3”、“.wav” 文件命名规则:昵称_房间号_开始时间.后缀 |
是 |
| subscribeAudios | array | 指定生成哪些人的音频文件; 取值:["_cr_all_"]或["userId1","userId2"]; _cr_all_代表生成所有人; |
是 |
合流模式参数:
| 参数 | 类型 | 说明 | 是否必传 |
|---|---|---|---|
| svrPathName | string | 带服务器存储路径的文件名,文件格式支持“mp3”、“wav”,示例:/xxx/xxx/xxx.mp3 | 是 |
| aChannelType | int | 音频通道类型,取值范围:0-单声道,1-左右双声道,默认为0 | 否 |
| aChannelContent | array | 音频通道内容。 左右声道模式时:必须传入两个用户ID,如:["UserID1", "UserID2"],第一个人的为左声道,第二个人为右声道) 单声道模式时:必须为空 |
否 |
CRCloudMixerVideoFileCfg 云端录制视频文件配置
单流模式参数:
| 参数 | 类型 | 说明 | 是否必传 |
|---|---|---|---|
| svrPath | string | 服务器存储路径,默认为空 | 否 |
| svrFileNameSuffix | string | 文件名后缀,当前只支持:”.mp4” 文件命名规则:昵称_cam摄像头编号_房间号_开始时间.后缀 |
是 |
| subscribeVideos | array | 指定生成哪些人的摄像头对应的视频文件; 取值:["_cr_all_"]或["_cr_allDefCam_"]或["userId1.camId", "userId2.camId", ...]; _cr_all_代表所有人所有摄像头,_cr_allDefCam_代表生成所有人的默认摄像头 |
是 |
| aStreamType | int | 视频文件内音频内容,取值:0-自己声音,1-所有人声音,默认0 | 否 |
合流模式参数:
| 参数 | 类型 | 说明 | 是否必传 |
|---|---|---|---|
| svrPathName | string | 带路径的文件名,文件格式支持:mp4、flv、ts、avi、rtmp://、rtsp://,可选一个或多个,以“;”分隔; 示例:”/xxx/xxx.mp4;rtmp://xxx1;rtmp://xxx2;” |
是 |
| aChannelType | int | 音频通道类型,取值:0-单声道,1-左右双声道,默认为0 | 否 |
| aChannelContent | array | 音频通道内容。 左右声道模式时:必须传入两个用户ID,如:["UserID1", "UserID2"],第一个人的为左声道,第二个人为右声道) 单声道模式时:必须为空 |
否 |
| vWidth | int | 视频宽度 | 是 |
| vHeight | int | 视频高度 | 是 |
| vFps | int | 视频帧率,取值0-30, 默认值12 | 否 |
| vBps | int | 视频码率,取值参见视频流默认码率定义 默认会根据视频尺寸生成码率 | 否 |
| vQP | int | 视频质量,取值0~51(0表示完全无损, 51表示质量非常差),推荐高质量取值18,中质量25,低质量34, 默认值19 | 否 |
| layoutConfig | array | 布局内容列表,[CRMixerContentObj,CRMixerContentObj,...] | 是 |
CRCloudStorageConfig 云端录制存储配置
| 参数 | 类型 | 说明 | 是否必传 |
|---|---|---|---|
| vendor | int | 第三方云存储平台: 1-阿里云 | 是 |
| region | string | 第三方云存储指定的地区信息 | 是 |
| bucket | string | 第三方云存储的 bucket | 是 |
| accessKey | string | 第三方云存储的 access key | 是 |
| secretKey | string | 第三方云存储的 secret key | 是 |
| endPoint | string | 第三方云存储的完整路径,当设置该参数后,region参数不生效 | 否 |
CRCloudMixerInfoList 云端混图器信息列表
CRCloudMixerInfo列表,参见CRCloudMixerInfo
CRCloudMixerInfo 云端混图器信息
| 参数 | 类型 | 说明 |
|---|---|---|
| ID | string | 混图器ID |
| owner | string | 创建者用户ID |
| cfg | string | 录制配置,json格式串,参见CRCloudMixerCfgObj |
| state | int | 录制状态,参见CRVSDK_MIXER_STATE |
CRCloudMixerOutputInfo 云端混图器输出信息
| 参数 | 类型 | 说明 |
|---|---|---|
| id | string | 混图器ID |
| state | int | 状态,参见CRVSDK_CLOUDMIXER_OUTPUT_STATE state为CRVSDK_CLOUDMO_STOPPED时:startTime, duration, fileSize参数有效; state为CRVSDK_CLOUDMO_FAIL时:errCode, errDesc参数有效; state为CRVSDK_CLOUDMO_UPLOADING时:progress参数有效; state为CRVSDK_CLOUDMO_UPLOADFAIL时:errCode, errDesc参数有效; |
| svrFilePathName | string | 录像路径文件名 |
| startTime | int64 | 创建时间(从1970年1月1日00:00:00起的毫秒数) |
| duration | int | 录像时长(ms) |
| fileSize | int64 | 文件大小(Byte) |
| errCode | CRVSDK_ERR_DEF | 错误码 |
| errDesc | string | 错误描述 |
| progress | float | 上传进度(0~100.0) |
CRMeetingAttrOptions 操作房间属性选项
| 参数 | 类型 | 说明 |
|---|---|---|
| notifyAll | int | 0(默认值):不通知,1:通知房间所有人员 |
CRAttrObjs 房间属性集
{
"KeyXX": {
"value": "11111",
"lastModifyUserID": "111",
"lastModifyTs": 11111
},
"KeyYY": {
"value": "22222",
"lastModifyUserID": "222",
"lastModifyTs": 22222
}
}
| 参数 | 类型 | 说明 |
|---|---|---|
| User defined Key | string | 自定义的属性Key |
| value | string | 属性值 |
| lastModifyUserID | string | 最后修改的用户ID |
| lastModifyTs | int | 最后修改的时间点,1970-1-1 00:00:00以来的秒数 |
CRUsrAttrObjs 用户属性集
{
"userid1": {
"KeyXX": {
"value": "11111",
"lastModifyUserID": "111",
"lastModifyTs": 11111
},
"KeyYY": {
"value": "22222",
"lastModifyUserID": "222",
"lastModifyTs": 22222
}
},
"userid2": {
"KeyXX": {
"value": "11111",
"lastModifyUserID": "111",
"lastModifyTs": 11111
},
"KeyYY": {
"value": "22222",
"lastModifyUserID": "222",
"lastModifyTs": 22222
}
}
}
| 参数 | 类型 | 说明 |
|---|---|---|
| UserID | string | 用户ID |
| User defined Key | string | 自定义的属性Key |
| value | string | 属性值 |
| lastModifyUserID | string | 最后修改的用户ID |
| lastModifyTs | int | 最后修改的时间点,1970-1-1 00:00:00以来的秒数 |