数据结构体定义
CRNetworkProxy
{"type":1,"addr":"192.168.0.2","port":8080}
| 参数 |
类型 |
说明 |
| type |
number |
网络代理类型(0:无代理, 1:http代理) |
| addr |
string |
代理服务器地址 |
| port |
number |
代理服务器端口 |
| name |
string |
可选参数,代理帐号 |
| pswd |
string |
可选参数,代理密码 |
CRSDKCreateParams sdk创建扩展参数
| 参数 |
类型 |
说明 |
| Timeout |
number |
网络通信超时时间,单位是毫秒,取值范围:10000-120000, 缺省值:60000(60秒) |
CRLoginDat 登录数据
| 参数 |
类型 |
说明 |
| 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 |
服务器地址,如10.8.8.122:2726 |
| userID |
string |
用户ID,长度不能大于128。业务方自由填写,保证同一appID下具有唯一性 |
| nickName |
string |
用户昵称,长度不能大于128 |
| userAuthCode |
string |
默认填空。只有开启第三方认证才需要填写。(开启第三方认证时,SDK服务器将连接提前配好的业务方服务器进行实时验证。) |
CRUserStatus 用户在线状态信息
| 参数 |
类型 |
说明 |
| userID |
string |
用户ID, 请参见关键词 |
| userStatus |
CRVSDK_USER_STATUS |
客户端状态 |
| DNDType |
number |
用户自定义免打扰状态,0:未开启免打扰 |
CRQueInfo 队列信息
| 参数 |
类型 |
说明 |
| queID |
number |
队列ID |
| name |
string |
队列名称 |
| desc |
string |
队列描述信息 |
| prio |
number |
队列优先级(为优先级最高) |
CRQueUserInfo 排队用户信息
| 参数 |
类型 |
说明 |
| queID |
number |
队列ID |
| usrID |
string |
排队的用户ID |
| name |
string |
用户的昵称 |
| usrExtDat |
string |
用户排队时的扩展数据 |
| queuingTime |
number |
排队的时长(单位:秒) |
CRQueStatus 队列状态
| 参数 |
类型 |
说明 |
| queID |
number |
队列ID |
| agentNum |
number |
坐席数 |
| waitNum |
number |
等待人数 |
| srvNum |
number |
服务中人数 |
CRQueuingInfo 我的排队信息
| 参数 |
类型 |
说明 |
| queID |
number |
排的队列ID(<0:代表我没有排队) |
| position |
number |
当前位置(0为队列中的第1位,即将被服务) |
| queuingTime |
number |
我排队的时长(单位:秒) |
CRTransReqInfo 文件传输请求信息
| 参数 |
类型 |
说明 |
| filePathName |
string |
本地路径文件名 |
| dstUrl |
string |
目标URL |
| bUploadType |
boolean |
传输类型(上传:true、下载:false) |
| extParams |
string |
扩展信息,如:http头部扩展,json格式,{"header1":"value1", "header2":"value2"} |
| transferCfg |
string |
传输控制参数,josn格式,例如{"decodeCREEFile":0} 详细如下: (1)decodeCREEFile:此参数仅http上传有效。0:上传原始文件,1:上传解密的文件(SDK录制加密文件) (2)extParamsTransfType:此参数仅http上传有效。当取值缺省或为0时:extParams在header中传送。取值为1时:extParams在multipart/form-data中传送 |
CRFileTransInfo 文件传输状态信息
CRMeetingMember 房间成员信息
CRAudioDevInfo 音频设备信息
| 参数 |
类型 |
说明 |
| id |
string |
设备id |
| name |
string |
设备名称 |
CRVideoDevInfo 视频设备信息
| 参数 |
类型 |
说明 |
| videoID |
number |
设备编号(程序重启后可能变化) |
| devName |
string |
设备名称 |
| devMaxSz |
CRSize |
摄像头支持的最大分辨率 |
| devGuid |
string |
设备guid, 仅获取本地设备有效 |
| bDisabled |
boolean |
设备是否被禁用, 仅获取本地设备有效 |
| devType |
CRVSDK_VDEV_TYPE |
设备类型 |
CRUserVideoID 用户视频ID
| 参数 |
类型 |
说明 |
| userID |
string |
用户id |
| videoID |
number |
设备id |
CRAudioCfg 音频配置
| 参数 |
类型 |
说明 |
| micGuid |
string |
麦克风设备(空代表系统默认设备) |
| spkGuid |
string |
扬声器设备(空代表系统默认设备) |
| agc |
boolean |
是否启用声音增益 |
| ans |
boolean |
是否启用降噪 |
| aec |
boolean |
是否启用回声消除 |
CRVideoCfg 视频配置
参数 |
类型 |
说明 |
| size |
string |
分辨率:"w*h" |
| fps |
number |
视频帧率(1~30) |
| maxbps |
number |
可选参数默认值,视频码率 单位为bps,如100kbps填值:100000,1mkbps填值1000000 |
| min_qp |
number |
可选参数(默认值22),最佳质量(18~51, 越小质量越好) |
| max_qp |
number |
可选参数(默认值32),最低质量(18~51, 越小质量越好) , sdk在网络不好时,智能调低质量,以便降低码率来提升流畅性 |
CRAudioFrame 音频帧数据
CRAudioFrame2 音频帧数据
CRVideoFrame 视频帧数据
| 参数 |
类型 |
说明 |
| format |
CRVSDK_VIDEO_FORMAT |
图像格式 |
| width |
number |
视频宽度 |
| height |
number |
视频高度 |
| pts |
number |
时间戳(ms) |
| data |
Uint8Array |
音频数据 |
CRScreenCaptureSourceInfo 屏幕共享采集源信息
| 参数 |
类型 |
说明 |
| type |
CRVSDK_SCREENCAPTURESOURCE_TYPE |
类型 |
| sourceId |
number |
采集源ID,对于窗口,表示窗口 ID(Window ID);对于屏幕,表示屏幕 ID(Display ID) |
| sourceTitle |
string |
采集源标题,适用窗口类型 |
| sourceName |
string |
采集源名称 |
| thumbImage |
CRVideoFrame |
采集源缩略图 |
| iconImage |
CRVideoFrame |
采集源图标,适用窗口类型 |
| primaryMonitor |
boolean |
是否为主屏,适用屏幕类型 |
| minimizeWindow |
boolean |
窗口是否已最小化,适用Windows平台 |
CRScreenShareCfg 屏幕共享配置参数
| 参数 |
类型 |
说明 |
| encSize |
Size |
固定编码清晰度,用于某些场影限定或保持分辨率用,如{"width":640, "height":360} |
| maxFPS |
number |
最大帧率(1~60),默认值12 |
| maxKbps |
number |
最大码率(1~4000) 单位为kbps,如100kbps填值:100,1mkbps填值1000 |
| qp |
number |
画质,默认值22, 范围0~51,0为无损 |
CRScreenShareInfo 屏幕共享状态信息
| 参数 |
类型 |
说明 |
| state |
number |
共享状态, 0:未共享,1:共享中 |
| sharerUserID |
string |
共享者用户ID |
| ctrlerUserID |
string |
当前控制者用户ID |
CRVStreamInfo 图像流信息
| 参数 |
类型 |
说明 |
| w |
short |
图像宽 |
| h |
short |
图像高 |
| fps |
number |
帧率 |
| bps |
number |
码率,单位:bit/秒 |
| codecID |
CRVSDK_CODEC_ID |
编码类型 |
CRNetStateInfo 网络状态信息
| 参数 |
类型 |
说明 |
| lv |
number |
网络评价0~10(10分为最佳) |
| delay |
number |
网络延时,单位ms |
| aSndLost |
number |
语音发送丢包率 |
| aRcvLost |
number |
语音接收丢包率 |
| vSndLost |
number |
视频发送丢包率 |
| vRcvLost |
number |
视频接收丢包率 |
CRVideoAttributesObj 摄像头私有属性
{ "size":"1280*720", "fps":15, "maxbps":1000000 }
{ "size":"1280*720", "fps":15, "maxbps":1000000, "quality2":{"size":"228*160", "maxbps":120000} }
CRVideoEffectsObj 视频效果参数
{"denoise":1,"mirror":1}
| 参数 |
类型 |
说明 |
| denoise |
number |
视频降噪, 取值:0/1, 默值为1 |
| mirror |
number |
视频镜像(左右翻转),取值:0/1, 默认为0。 |
| upsideDown |
number |
视频上下翻转,取值:0/1, 默认为0 |
| deinterlace |
number |
视频反交错,取值:0/1, 默认为0 (除非视频采集设备为隔行扫描设备,否则不要开启) |
| degree |
number |
旋转角度,<0代表自动,旋转取值:0、90、180、270、360, 默认为自动模式 |
CRLocMixerCfgObj 本地混图器规格配置
{
"width":640,
"height":360,
"frameRate":8,
"bitRate":500000,
"defaultQP":28,
"gop":120
}
| 参数 |
类型 |
说明 |
| width |
number |
图像宽度(要求16的倍数) |
| height |
number |
图像高度(要求8的倍数) |
| frameRate |
number |
图像帧率,取值范围:1-30(值越大,cpu要求更高,录像推荐15帧,直播推存25帧) |
| bitRate |
number |
最高码率(例如1m:1000000),当图像变化小时,平均码率会低于此值 |
| defaultQP |
number |
目标质量,缺省值:25。取值范围:0~51,0表示完全无损, 51表示质量非常差,推荐高质量取值18,中质量25, 低质量34 |
| gop |
number |
I帧周期(I帧周期越大码率越小,但直播延时会越大); 文件录制建议15秒一个I帧,取值:frameRate x 15(frameRate的15倍); 直播建议4秒一个I帧,取值: frameRate x 4(frameRate的4倍); |
CRMixerContentObj 混图器内容
{
"type": 0,
"left": 5,
"top": 10,
"width": 633,
"height": 356,
"keepAspectRatio": 1,
"param": {"camid":"usr1.1"}
}
| 参数 |
类型 |
说明 |
| left |
number |
在混图画面中的区域(水平位置) |
| top |
number |
在混图画面中的区域(垂直位置) |
| width |
number |
在混图画面中的区域宽 |
| height |
number |
在混图画面中的区域高 |
| type |
number |
CRVSDK_MIXER_CONTENT_TYPE,请见后面type描述; |
| keepAspectRatio |
number |
内容保持原始比例,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"
- resourceid:具有唯一属性的字符串id,通过setPicResource将图片存储到sdk内供混图模块使用
- 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 |
number |
录制文件CRVSDK_MIXER_OUTPUT_FILE |
| filename |
string |
录像路径文件名(如:d:/1.mp4),支持的文件格式为mp4/ts/flv/avi,其中flv和ts两种格式在程序异常结束时产生的录制文件仍可用。 |
| encryptType |
number |
可选参数,录像文件是否加密,0:不加密(默认值),1:加密; |
当输出推流时,参数如下:
| 参数 |
类型 |
说明 |
| type |
number |
直播推流CRVSDK_MIXER_OUTPUT_LIVE |
| liveUrl |
string |
直播推流地址,支持rtmp/rtsp; |
| errRetryTimes |
number |
可选参数,直播推流异常时,重试次数,默认值0 |
CRLocMixerOutputInfoObj 本地混图器输出信息
{ "state":2, "duration":100,"fileSize":10000 }
| 参数 |
类型 |
说明 |
| state |
CRVSDK_LOCMIXER_OUTPUT_STATE |
状态 state为CRVSDK_LOCMO_RUNNING时:duration, fileSize参数有效; state为CRVSDK_LOCMO_STOPPED时:duration, fileSize参数有效; state为CRVSDK_LOCMO_FAIL时:errCode参数有效; |
| duration |
number |
录像文件时长,单位:毫秒 |
| fileSize |
number |
录像文件大小,单位:字节 |
| 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_"]
}
}
{
"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"}
}
]
}
}
CRCloudMixerAudioFileCfg 云端录制语音文件配置
单流模式参数:
| 参数 |
类型 |
说明 |
是否必传 |
| svrPath |
string |
服务器存储路径,默认为空 |
否 |
| svrFileNameSuffix |
string |
文件名后缀,支持:“.mp3”、“.wav” 文件命名规则:昵称_房间号_开始时间.后缀 |
是 |
| subscribeAudios |
string[] |
指定生成哪些人的音频文件; 取值:["_cr_all_"]或["userId1","userId2"]; _cr_all_代表生成所有人; |
是 |
合流模式参数:
| 参数 |
类型 |
说明 |
是否必传 |
| svrPathName |
string |
带服务器存储路径的文件名,文件格式支持“mp3”、“wav”,示例:/xxx/xxx/xxx.mp3 |
是 |
| aChannelType |
number |
音频通道类型,取值范围:0-单声道,1-左右双声道,默认为0 |
否 |
| aChannelContent |
string[] |
音频通道内容。
左右声道模式时:必须传入两个用户ID,如:["UserID1", "UserID2"],第一个人的为左声道,第二个人为右声道)
单声道模式时:必须为空 |
否 |
CRCloudMixerVideoFileCfg 云端录制视频文件配置
单流模式参数:
| 参数 |
类型 |
说明 |
是否必传 |
| svrPath |
string |
服务器存储路径,默认为空 |
否 |
| svrFileNameSuffix |
string |
文件名后缀,当前只支持:”.mp4” 文件命名规则:昵称_cam摄像头编号_房间号_开始时间.后缀 |
是 |
| subscribeVideos |
string[] |
指定生成哪些人的摄像头对应的视频文件; 取值:["_cr_all_"]或["_cr_allDefCam_"]或["userId1.camId", "userId2.camId", ...]; _cr_all_代表所有人所有摄像头,_cr_allDefCam_代表生成所有人的默认摄像头 |
是 |
| aStreamType |
number |
视频文件内音频内容,取值:0-自己声音,1-所有人声音,默认0 |
否 |
合流模式参数:
| 参数 |
类型 |
说明 |
是否必传 |
| svrPathName |
string |
带路径的文件名,文件格式支持:mp4、flv、ts、avi、rtmp://、rtsp://,可选一个或多个,以“;”分隔; 示例:”/xxx/xxx.mp4;rtmp://xxx1;rtmp://xxx2;” |
是 |
| aChannelType |
number |
音频通道类型,取值:0-单声道,1-左右双声道,默认为0 |
否 |
| aChannelContent |
string[] |
音频通道内容。
左右声道模式时:必须传入两个用户ID,如:["UserID1", "UserID2"],第一个人的为左声道,第二个人为右声道)
单声道模式时:必须为空 |
否 |
| vWidth |
number |
视频宽度 |
是 |
| vHeight |
number |
视频高度 |
是 |
| vFps |
number |
视频帧率,取值0-30, 默认值12 |
否 |
| vBps |
number |
视频码率,取值参见视频流默认码率定义 默认会根据视频尺寸生成码率 |
否 |
| vQP |
number |
视频质量,取值0~51(0表示完全无损, 51表示质量非常差),推荐高质量取值18,中质量25,低质量34, 默认值19 |
否 |
| layoutConfig |
CRMixerContentObj[] |
布局内容列表 |
是 |
CRCloudStorageConfig 云端录制存储配置
| 参数 |
类型 |
说明 |
是否必传 |
| vendor |
number |
第三方云存储平台: 1-阿里云 |
是 |
| region |
string |
第三方云存储指定的地区信息 |
是 |
| bucket |
string |
第三方云存储的 bucket |
是 |
| accessKey |
string |
第三方云存储的 access key |
是 |
| secretKey |
string |
第三方云存储的 secret key |
是 |
| endPoint |
string |
第三方云存储的完整路径,当设置该参数后,region参数不生效 |
否 |
CRCloudMixerInfoList 云端混图器信息列表
CRCloudMixerInfo列表,参见CRCloudMixerInfo
CRCloudMixerInfo 云端混图器信息
CRCloudRecordFileInfo 云端录制文件信息
| 参数 |
类型 |
说明 |
| state |
number |
上传状态,5:上传成功,6:上传失败 |
| outputName |
string |
文件名 |
| duration |
number |
文件时长 |
| size |
number |
文件大小 |
CRCloudMixerEventInfoObj 云端混图器事件信息
| 参数 |
类型 |
说明 |
| eventDesc |
string |
事件描述 |
| outputName |
string |
文件名/推流地址 |
| startTime |
number |
创建时间(从1970年1月1日00:00:00起的毫秒数) |
| duration |
number |
录像时长(ms) |
| size |
number |
文件大小(Byte) |
| errCode |
CRVSDK_ERR_DEF |
错误码 |
| errDesc |
string |
错误描述 |
| progress |
number |
上传进度(0~100.0) |
| streamID |
string |
摄像头id |
| allFileState |
number |
录制文件上传整体状态, 0:全部未上传,1:全部上传成功,2:部分上传成功 |
| allFileInfo |
CRCloudRecordFileInfo[] |
录制文件上传信息列表 |
CRMeetingAttrOptions 操作房间属性选项
| 参数 |
类型 |
说明 |
| notifyAll |
number |
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 |
number |
最后修改的时间点,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 |
number |
最后修改的时间点,1970-1-1 00:00:00以来的秒数 |
CRSize 尺寸
| 参数 |
类型 |
说明 |
| width |
number |
宽度 |
| height |
number |
高度 |
CRCanvas 视图控件