类型定义
CRVideo_AddFileToRecordMgr
添加本地文件到录制文件管理中
- Type:object
参数 | 参数类型 | 说明 |
---|---|---|
fileName | string | 文件名,不含路径 |
filePath | string | 文件路径,不含文件名 |
CRVideo_AudioCfg
麦克风、扬声器风正在使用的设备信息
- Type:object
参数 | 参数类型 | 说明 |
---|---|---|
micId | number | 麦克风设备ID |
speakerId | number | 扬声器ID |
privEC | number | 是否开启云屋私有回声消息0:不开启;1:开启 |
privAgc | number | 是否开启云屋私有语音自动增益0:不开启;1:开启 |
CRVideo_FileInfo
排队信息(params详细说明:decodeCREEFile:取值0或1。此参数仅上传有效,为0时上传原始文件,为1时上传解密的文件)
- Type: object
参数 | 参数类型 | 说明 |
---|---|---|
bUploadType | number | 传输类型,0:下载类型,1:上传类型 |
filePathName | string | 本地完整路径文件名(路径中要求有“CloudroomVideoSDK”) |
fileVersion | string | 文件版本(可以填版本号,也可以md5,也可以为空) |
httpUrl | string | 目标URL |
params | object | 特殊参数,字典数据。 |
fileSize | number | 文件大小 |
finishedSize | number | 已传输大小 |
state | CRVideo_HTTP_TRANSFER_STAT | 文件传输状态,详见:HTTP_TRANSFER_STATE |
CRVideo_MediaInfoObj
影音文件信息
- Type: object
参数 | 参数类型 | 说明 |
---|---|---|
userID | string | 用户id |
state | number | 播放状态 0:播放 1:暂停 2:未播放 |
mediaName | string | 影音文件名 |
CRVideo_MemberInfo
成员信息
- Type: object
名称 | 参数类型 | 说明 |
---|---|---|
userID | string | 用户ID |
nickname | string | 昵称 |
audioStatus | CRVideo_ASTATUS | 音频状态,数值参考麦克风状态 |
videoStatus | CRVideo_VSTATUS | 视频状态,数值参考视频状态定义 |
CRVideo_QueueInfo
队列信息
- Type: object
参数 | 参数类型 | 说明 |
---|---|---|
queID | string | 队列ID |
name | string | 队列名称 |
desc | string | 队列描述 |
prio | number | 优先级,值越小优先级越高 |
CRVideo_QueuingInfo
排队信息
- Type: object
参数 | 参数类型 | 说明 |
---|---|---|
queID | string | 队列ID 我排的队列(-1:代表我没有排队;-2:代表我正在会话中,通过GetSessionInfo可获取相关信息) |
position | string | 我的位置 |
queuingTime | string | 我排队的时长(单位s) |
CRVideo_RecordFileInfo
录制文件信息
- Type: object
参数 | 参数类型 | 说明 |
---|---|---|
fileName | string | 文件名,全路径 |
state | number | 0没有上传,1上传中,2 上传完毕 |
uploadPercent | number | 上传进度,state为1时关注此字段 |
CRVideo_RecordUploadCfg
上传配置参数
- Type: object
参数 | 参数类型 | 说明 |
---|---|---|
type | number | 0:云屋网盘(默认),1:http |
speakerName | string | 上传地址 |
CRVideo_RecordVideoInfo
需要录制的视频信息
- Type: object
参数 | 参数类型 | 说明 |
---|---|---|
left | number | 左 |
top | number | 上 |
width | number | 宽 |
height | number | 高 |
param | object | 附加参数 Properties Name Type Description type CRVideo_REC_VCONTENT_TYPE 录制类型 |
CRVideo_ScreenShareCfgObj
屏幕共享配置对象
- Type: object
参数 | 参数类型 | 说明 |
---|---|---|
encodeType | number | 编码类型,详见屏幕共享的编码类型CRVideo_ENCODE_TYPE |
catchRect | object | {"left":xx,"top":xx,"width":xx,"height":xx}用于实现区域共享 |
catchWnd | number | 共享窗口的窗口句柄,用于实现窗口共享 |
maxFPS | number | 最大帧率, 缺省为8 (当网络发不动时,帧率会自动下降) |
maxKbps | number | 最大码率,缺省800kbps |
CRVideo_SessionInfo
排队信息
- Type: object
参数 | 参数类型 | 说明 |
---|---|---|
callID | string | 会话的呼叫ID |
peerID | string | 会话的目标用户ID |
peerName | string | 会话的目标用户昵称 |
bCallAccepted | number | 呼叫是否被对方接受 0:暂未接受,1:已接受 |
meetingID | number | 呼叫接受后,分配的会议ID |
meetingPswd | string | 会议密码 |
duration | number | 会议持续的时长(单位s) |
CRVideo_VideoCfg
视频参数
- Type: object
参数 | 参数类型 | 说明 |
---|---|---|
sizeType | CRVideo_VIDEO_SHOW_SIZE | 视频尺寸 |
fps | number | 帧率:视频帧率(5~30) |
maxbps | number | 视频码率(1~10010001000);未配置则使用内部默认值,请参见VIDEO_SHOW_SIZE |
qp_min | number | 最佳质量(18~51, 越小质量越好);(未配置则使用内部默认值25) |
qp_max | number | 最差质量(18~51, 越大质量越差);(未配置则使用内部默认值36) |
wh_rate | number | 视频宽高比(0对应16:9,1对应4:3;2对应1:1 ); (未配置则使用内部默认值0) |
wh_rate | CRVideo_VIDEO_WH_RATE | 视频宽高比例 |
CRVideo_VideoDeviceInfo
视频设备信息
- Type: object
参数 | 参数类型 | 说明 |
---|---|---|
userID | string | 用户ID |
videoID | string | 设备id |
videoName | string | 设备名称 |
CRVideo_VideoIDsObj
视频设备对象
- Type: object
参数 | 参数类型 | 说明 |
---|---|---|
userID | string | 用户ID |
videoID | string | 设备id |
CRVideo_VideoImgObj
视频设备对象
- Type: object
参数 | 参数类型 | 说明 |
---|---|---|
dat | string | 图像数据Base64编码 |
width | number | 图像宽度 |
height | number | 图像高度 |
CRVideo_Board
白板信息
- Type: object
参数 | 参数类型 | 说明 |
---|---|---|
userID | string | 用户ID |
boardID | number | 白板id |
title | string | 白板名称 |
width | number | 白板宽度 |
height | number | 白板高度 |
CRVideo_MeetInfoObj
区域
- Type: object
参数 | 参数类型 | 说明 |
---|---|---|
ID | number | 会议号,0时代表会议信息为空 |
pswd | string | 会议密码;(空代表会议无密码) |
subject | string | 会议主题 |
pubMeetUrl | string | 会议公共链接 |
CRVideo_QueInfo
队列信息
- Type: object
参数 | 参数类型 | 说明 |
---|---|---|
queID | number | 队列id |
name | number | 队列名称 |
desc | string | 队列描述 |
prio | number | 优先级,值越小优先级越高 |
CRVideo_QueStatus
队列状态
- Type: object
参数 | 参数类型 | 说明 |
---|---|---|
queID | number | 队列id |
agent_num | number | 坐席数量 |
wait_num | number | 排队客户数量 |
srv_num | number | 正在服务的客户数量 |
CRVideo_QueUser
队列用户信息
- Type: object
参数 | 参数类型 | 说明 |
---|---|---|
queID | number | 队列ID |
usrID | string | 用户ID |
name | string | 用户昵称 |
queuingTime | string | 已排队时长(秒) |
param | string | 用户呼叫时的私有数据 |
CRVideo_Rect
区域
- Type: object
参数 | 参数类型 | 说明 |
---|---|---|
left | number | 区域右上角x坐标 |
top | number | 区域右上角y坐标 |
width | number | 区域宽度 |
height | number | 区域高度 |
CRVideo_SubPage
队列状态信息
- Type: object
参数 | 参数类型 | 说明 |
---|---|---|
userID | number | 用户ID |
boardID | number | 白板id |
CRVideo_MixerCfgObj
- 混图器规格配置
{"width":640,"height":320,"frameRate":8,"bitRate":500000,"defaultQP":28,"gop":120}
- Type: object
参数 | 参数类型 | 说明 |
---|---|---|
width | number | 图像宽度 |
height | number | 图像高度 |
frameRate | number | 图像帧率,取值范围:1-30(值越大,cpu要求更高,录像推荐15帧,直播推存25帧) |
bitRate | number | 录制视频文件的最高码率,当图像变化小时,实际码率会低于此值 |
defaultQP | number | 录制视频文件的缺省质量,缺省值:26。取值范围:0~51,0表示完全无损, 51表示质量非常差,推荐高质量取值18,中质量26, 低质量34 |
gop | number | I帧周期(I帧越少码率越小,但直播延时会越大); 文件录制建议15秒一个I帧取值:fpsx15; 直播建议4秒一个I帧取值: fpsx4; |
CRVideo_MutiMixerCfgsObj
- 混图器规格配置列表
[
{"id":"1", "cfg":{"width":640,"height":320,"frameRate":8,"bitRate":500000,"defaultQP":28,"gop":120}}
]
- Type: object
参数 | 参数类型 | 说明 |
---|---|---|
id | number | 混图器编号 |
cfg | CRVideo_MixerCfgObj | 混图器规格配置,参见CRVideo_MixerCfgObj |
CRVideo_MixerContentObj
- 混图器内容配置
[
{"type":0,"keepAspectRatio":1,"left":5,"top":181,"width":633,"height":356,"param":{"camid":"usr1.1"}}, {"type":0,"keepAspectRatio":1,"left":642,"top":181,"width":633,"height":356,"param":{"camid":"usr2.1"}}
]
- Type: object
参数 | 参数类型 | 说明 |
---|---|---|
left | number | 图像宽度 |
top | number | 图像高度 |
width | number | 图像帧率,取值范围:1-30(值越大,cpu要求更高,录像推荐15帧,直播推存25帧) |
height | number | 录制视频文件的最高码率,当图像变化小时,实际码率会低于此值 |
type | 类型CRVideo_MIXER_VCONTENT_TYPE | 请见后面type描述; |
keepAspectRatio | number | I帧周期(I帧越少码率越小,但直播延时会越大); 文件录制建议15秒一个I帧取值:fpsx15; 直播建议4秒一个I帧取值: fpsx4; |
param | json格式 | 如:{"camid":"usr2.1"}。请见后面param支持的参数; |
type描述:
- 1.当type=MIXVTP_VIDEO时,表示混图的是摄像头,param必须包含camid.
- 2.当type=MIXVTP_PIC时,表示混图的是指定的图片,param必须包含resourceid。(仅用于本地混图)
- 3.当type=MIXVTP_SCREEN时,表示混图的是本地屏幕,param可以增加附加参数screenid/pid/area
- 4.当type=MIXVTP_TIMESTAMP时,表示混图的是时戳,不用附加任何参数
- 5.当type=MIXVTP_REMOTE_SCREEN时,表示混图的是远端共享的屏幕,不用附加任何参数
- 6.当type=MIXVTP_WBOARD时,表示混图的是白板,不用附加任何参数。(仅用于云端混图,本地混图应该用MIXVTP_PIC)
- 7.当type=MIXVTP_TEXT时,表示混图的是文本(支持简单html),param必须包含resourceid和text
- 注 MIXVTP_TEXT时,width和height可为0,此时元素大小由文本信息自动确定
param 支持的参数如下:
- 1.camid 用户id.摄像头id, 如:"testuser.1"
- 2.resourceid 具有唯一属性的字符串id,通过setPicResource(resourceid, picJsonVal)将图片存储到id内供混图模块使用
- 3.screenid 屏幕序号,-1表示主屏
- 4.pid 进程号
- 5.area 抓屏区域:x,y,w,h, 如:"10,20,400,800",无此参数时代表抓全屏
- 6.text 文件内容,支持一些简单的html标签,如:
<span style=" font-weight:600; color:#00f;">客户姓名:</span><span style=" color:#00f;">张三</span> <br/> <span style=" font-weight:600; color:#00f;">录制日期:</span><span style=" color:#00f;">2018-03-01</span>
CRVideo_MutiMixerContentsObj
- 混图器内容配置列表
[
{ "id": "1", "content": [ {"type":0,"keepAspectRatio":1,"left":5,"top":181,"width":633,"height":356,"param":{"camid":"usr1.1"}}, {"type":0,"keepAspectRatio":1,"left":642,"top":181,"width":633,"height":356,"param":{"camid":"usr2.1"}} ] }
]
- Type: object
参数 | 参数类型 | 说明 |
---|---|---|
id | number | 混图器编号 |
content | CRVideo_MixerContentObj | 混图器内容配置,参见CRVideo_MixerContentObj |
CRVideo_MixerOutputObj
- 混图器输出配置
[
{"type":0,"filename":"D:\1.mp4"}, {"type":1,"liveUrl":"rtmp://xxx"},
]
- Type: object
参数 | 参数类型 | 说明 |
---|---|---|
type | number | 输出类型CRVideo_MIXER_OUTPUT_TYPE |
filename | string | 录像路径文件名(本地录像名格式如:d:\1.mp4,服务器录像名格式如:/2018-11-21/1.mp4),支持的文件格式为mp4/ts/flv/avi,其中flv和ts两种格式在程序异常结束时产生的录制文件仍可用。 |
encryptType | number | 录像文件是否加密,0:不加密,1:加密; |
isUploadOnRecording | number | 录像文件是否边录边传,0:不上传,1:边录边传; (此参数仅本地录像有效) |
serverPathFileName | string | 边录边传时,上传到服务器的路径文件名; (此参数仅本地录像有效) |
liveUrl | string | 直播推流地址,支持rtmp/rtsp; |
errRetryTimes | number | 直播推流异常时,重试次数 |
CRVideo_MutiMixerOutputsObj
- 混图器输出配置列表
[
{
"id": "1", "output": [ {"type": 0,"filename": "D:\\1.mp4"}, {"type": 1,"liveUrl": "rtmp://xxx"} ]
}
]
- Type: object
参数 | 参数类型 | 说明 |
---|---|---|
id | number | 混图器编号 |
output | 混图器输出配置 | 参见CRVideo_MixerOutputObj |