类定义

相关类定义


Sdk初始化数据

com.cloudroom.cloudroomvideosdk.model.SdkInitDat

  • sdkDatSavePath: SDK内部使用文件位置
  • noCall: 不使用呼叫业务(可减少登录环节、及通信需求)
  • noQueue: 不使用sdk的排队功能的业务(可减少登录环节、及通信需求)
  • noMediaDatToSvr: 与服务器无实时流媒体数据(可减少复杂度,加快登录速度)
  • timeOut: 网络通信超时时间(10000-120000),单位是毫秒,超出范围时就近取边界值
  • showSDKLogConsole: 输出SDK日志到控制台,发布版本建议设置不输出
  • datEncType: 数据加密类型(0:敏感数据加密,1:全面加密; 缺省:1)

登录数据

com.cloudroom.cloudroomvideosdk.model.LoginDat

  • authAcnt: 云屋鉴权帐号
  • authPswd: 云屋鉴权密码
  • nickName: 昵称
  • privAcnt: 自定义帐号, 云屋服务器将会去配置的服务器进行认证; (当不使用自定义帐号时,privAuthCode应为null)
  • privAuthCode: 自定义验证码(有复杂要求的,可以使用json格式)

创建会议信息对象

com.cloudroom.cloudroomvideosdk.model.CreatInfo

{"meetSubject":"test","needPswd":0,"isRegular":0}
  • meetSubject: 会议名称
  • needPswd: 是否创建密码
  • isRegular: 是否固定会议;(普通会议,会议室无人30分钟后,自动消毁; 固定会议,会议室一直存在直到用户主动消毁它)

会议对象

com.cloudroom.cloudroomvideosdk.model.MeetInfo

  • ID: 会议号,数值0代表会议信息无效
  • pswd: 会议密码;(空代表会议无密码)
  • subject: 会议主题
  • pubMeetUrl: 会议公共链接
  • creator: 会议创建者
  • memberCount: 会议内人数
  • startTime: 会议开始时间(从1970年1月1日00:00:00起)

用户状态

com.cloudroom.cloudroomvideosdk.model.UserStatus

大小描述

com.cloudroom.cloudroomvideosdk.model.Size

  • width
  • height

会议成员

com.cloudroom.cloudroomvideosdk.model.MemberInfo

  • userID 用户ID
  • nickname 用户昵称
  • audioStatus 音频状态,数值参考麦克风状态ASTATUS
  • videoStatus 视频状态,数值参考视频状态定义VSTATUS

音频配置

com.cloudroom.cloudroomvideosdk.model.AudioCfg

  • _micName 麦克风设备名称(空代表系统默认设备)
  • _speakerName 扬声器名称(空代表系统默认设备)
  • _privEC 是否开启云屋私有回声消除
  • _privAgc 是否开启云屋私有语音自动增益
  • _HILevelEC 是否开启云屋超强回声消除

视频配置

com.cloudroom.cloudroomvideosdk.model.VideoCfg

  • sizeType 视频尺寸,详见定义VIDEO_SHOW_SIZE
  • whRate 视频宽高比,取值如下:
    • 0 为16:9(未配置时内部默认值)
    • 1 为4:3
    • 2 为1:1
  • fps 视频帧率(5~30)
  • maxbps 视频码率(1~100*1000*1000)(未配置则使用内部默认值,详见定义VIDEO_SHOW_SIZE)
  • minQuality 最佳质量(18~51,越小质量越好) (未配置则使用内部默认值25)
  • maxQuality 最差质量(18~51, 越大质量越差) (未配置则使用内部默认值36)

我们采用的是vbr编码(由质量+码率,双重控制):

  1. qp范围:质量参数,为的是达到目标质量后,无需花费更大码率提高质量
  2. maxbps码率控制,是为了确保结果一定不大于“目标码率”(体积受控)
  3. 当要超出码率控制时,自动降低质量;当质量达到目标时,自动减少码率甚至无码率输出 注:使用硬编时第二点是无效的。

视频设备私有属性

com.cloudroom.cloudroomvideosdk.model.VideoAttributes

  • disabled 取值0:不禁用此设备(默认值),1:禁用此设备;
  • quality1Cfg 参见定义VideoCfg,未配置时采用全局配置的VideoCfg
  • quality2Cfg 参见定义VideoCfg,第二档视频配置,未配置代表关闭对应档位视频流

说明:

  1. 一个摄像头出多档质量的视频流,将带来很大的cpu开销;
  2. 通过setUsrVideoId可以选择观看的视频流;

视频帧图像

com.cloudroom.cloudroomvideosdk.model.RawFrame

  • camShowNo 摄像头显示序号(0开始编号)
  • format 图像格式,数值参考视频图像格式VIDEO_FORMAT
  • dat 图像数据
  • frameWidth 图像宽度
  • frameHeight 图像高度
  • frameTime 图像的时间戳

用户视频信息

com.cloudroom.cloudroomvideosdk.model.UsrVideoInfo

  • videoDevPath 设备路径(已废弃,无效)
  • videoName 设备名称
  • isIPCamera 是否IP摄像头

用户摄像头

com.cloudroom.cloudroomvideosdk.model.UsrVideoId

  • userId 用户id
  • videoID 设备id

屏幕共享帧图像

com.cloudroom.cloudroomvideosdk.model.ScreenShareImg

  • rgbDat 图像数据
  • rgbWidth 图像宽度
  • rgbHeight 图像高度

屏幕共享标注信息

com.cloudroom.cloudroomvideosdk.model.ScreenMarkData

  • userID 标注者用户ID
  • useridSN 标注SN
  • color 标注颜色
  • mousePosSeq 标注数据

屏幕共享删除标注信息

com.cloudroom.cloudroomvideosdk.model.RemoveScreenMarkData

  • userID 标注者用户ID
  • useridSN 标注SN

混图器规格配置

com.cloudroom.cloudroomvideosdk.model.MixerCfg

  • dstResolution 图像大小,详见定义Size
  • frameRate 图像帧率,取值范围:1-30(值越大,cpu要求更高,录像推荐15帧,直播推存25帧)
  • bitRate 录制视频文件的最高码率,当图像变化小时,实际码率会低于此值。建议:

    • 640*360: 500000; (500kbps)
    • 1280*720: 1000000; (1mbps)
    • 1920*1080: 2000000; (2mbps)
  • defaultQP 录制视频文件的缺省质量,缺省值:26

  • 取值范围:0~51,0表示完全无损, 51表示质量非常差,推荐高质量取值18,中质量26, 低质量34。
  • gop I帧周期(I帧越少码率越小,但直播延时会越大); 文件录制建议15秒一个I帧取值:fpsx15; 直播建议4秒一个I帧取值: fpsx4;

混图器内容配置

com.cloudroom.cloudroomvideosdk.model.MixerContent

  • itemRt 在录制画面中的区域(相对于录像尺寸)
  • type 录制类型MIXER_VCONTENT_TYPE
MixerContent(MIXER_VCONTENT_TYPE type, Rect rect)
  • 功能 构造方法
  • 返回值
  • 参数

    • itemRt 在混图画面中的区域(相对于混图器尺寸)
    • itemType 类型MIXER_VCONTENT_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,此时元素大小由文本信息自动确定
  • keepAspectRatio 内容保持原始比例,0不保持,1保持

  • 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>

混图器输出配置

com.cloudroom.cloudroomvideosdk.model.MixerOutPutCfg

  • type 输出类型MIXER_OUTPUT_TYPE
  • filename 录像路径文件名(本地录像名格式如:d:\1.mp4,服务器录像名格式如:/2018-11-21/1.mp4),支持的文件格式为mp4/ts/flv/avi,其中flv和ts两种格式在程序异常结束时产生的录制文件仍可用。
  • encryptType 录像文件是否加密,0:不加密,1:加密;
  • isUploadOnRecording 录像文件是否边录边传,0:不上传,1:边录边传; (此参数仅本地录像有效)
  • serverPathFileName 边录边传时,上传到服务器的路径文件名; (此参数仅本地录像有效)
  • liveUrl 直播推流地址,支持rtmp/rtsp
  • errRetryTimes 直播推流异常时,重试次数

录制文件、直播信息通知

com.cloudroom.cloudroomvideosdk.model.MixerOutputInfo

state状态描述:

  • 0:输出对象已创建;
  • 1:输出目标信息更新; 可以从结构中取得:duration, fileSize参数;
  • 2:输出对象已关闭; 可以从结构中取得:duration, fileSize参数;
  • 3:输出对象异常;可以从结构中取得:err参数;

录制文件

com.cloudroom.cloudroomvideosdk.model.RecordFileInfo

  • fileName 文件名,全路径
  • startTime 开始录制时间
  • duration 录制时长
  • fileSize 文件大小

com.cloudroom.cloudroomvideosdk.model.RecordFileShow

  • fileName 文件名,全路径
  • size 文件大小
  • state 文件状态,详见定义RECORD_FILE_STATE
  • uploadPercent 录制结果中视频尺寸高度上传进度

影音文件信息

com.cloudroom.cloudroomvideosdk.model.MediaInfo

  • userID 用户id
  • state 播放状态,详见定义MEDIA_STATE
  • mediaName 影音文件名

影音帧图像

com.cloudroom.cloudroomvideosdk.model.MediaFrame

  • format 图像格式,数值参考视频图像格式VIDEO_FORMAT
  • buf 图像数据
  • w 图像宽度
  • h 图像高度
  • frameTime 图像的时间戳

白板

com.cloudroom.cloudroomvideosdk.model.SubPage

  • userID 用户id
  • pageID 白板页ID

白板信息

com.cloudroom.cloudroomvideosdk.model.SubPageInfo

  • page 白板标识,详见定义SubPage
  • title 白板的名字
  • width
  • height
  • pageCount 页数
  • curPage 当前页
  • pagePos1 扩展参数1
  • pagePos2 扩展参数2

白板图元

  • elementID 图元id
  • type 图元的类型,值100以下为云屋保留值,100及以上为自定义值
  • left、top 图元在页内的左上角位置
  • 可自由扩展

说明:

  • elementID必须调用createElementID获取, 即使是曾经调此接口创建的然后存入了磁盘文件,再次读入会议时,所有elementID也需要重新生成
  • 如果要和云屋产品互通,那就需要按云屋的定义取值,可以联系云屋获取相关文档

网盘文件

com.cloudroom.cloudroomvideosdk.model.FileInfo

  • ownerID 文件所有者的ID
  • ownerName 文件所有者的名称
  • name 在服务器上的文件名
  • orgFileName 用户的原始文件名
  • md5 压缩后的md5(如果不压缩,则原文件md5)
  • ctime 上传时间,字符串,格式"yyyy-MM-dd hh:mm:ss"
  • size 在服务器上的大小(单位B,类型ulong)
  • orgSize 原始文件大小(单位B,类型ulong)
  • status 文件状态

网盘容量信息

com.cloudroom.cloudroomvideosdk.model.DiskSummary

  • confDiskLimit 网盘总容量(KB)
  • confDiskUsed 网盘已用容量(KB)

队列信息

com.cloudroom.cloudroomvideosdk.model.QueueInfo

  • queID 队列ID
  • name 队列名称
  • desc 队列描述
  • prio 优先级,值越小优先级越高

队列状态

com.cloudroom.cloudroomvideosdk.model.QueueStatus

  • queID 队列ID
  • agent_num 坐席数量
  • wait_num 排队客户数量
  • srv_num 正在服务的客户数量

排队信息

com.cloudroom.cloudroomvideosdk.model.QueuingInfo

  • queID 队列ID 我排的队列(-1:代表我没有排队;-2:代表我正在会话中,通过GetSessionInfo可获取相关信息)
  • position 我的位置
  • queuingTime 我排队的时长(单位s)

会话信息

com.cloudroom.cloudroomvideosdk.model.VideoSessionInfo

  • callID 会话中的呼叫ID
  • peerID 会话中的目标用户ID
  • peerName 会话中的目标用户昵称
  • bCallAccepted 呼叫是否被对方接受 0:暂未接受,1:已接受
  • meetingID 会话中分配的会议ID
  • meetingPswd 会议密码
  • duration 会话持续的时长(秒)

队列用户

com.cloudroom.cloudroomvideosdk.model.UserInfo

  • queID 队列ID
  • usrID 用户ID
  • name 用户昵称
  • queuingTime 用户排队的时长(单位s)
  • usrExtDat 用户排队时传入的扩展参数

Http文件传输请求对象

com.cloudroom.cloudroomvideosdk.model.HttpReqInfo

  • bUploadType 是否上传
  • filePathName 本地完整路径文件名
  • fileVersio 文件版本(可以填版本号,也可以md5,也可以为空)
  • httpUrl 目标URL
  • extParams 上传给http server的扩展参数, 缺省放在在http header中。其它方式参见transforCfg中的extParamsTransType配置
  • transforCfg 特殊处理配置,字典数据
    • decodeCREEFile:此参数仅上传有效。0:上传原始文件,1:上传解密的文件(云屋录制加密文件)
    • extParamsTransfType:此参数仅上传有效。缺省或0:extParams在header中传送,1:extParams在multipart/form-data中传送

com.cloudroom.cloudroomvideosdk.model.FileTransInfo

  • bUploadType 是否上传
  • filePathName 本地完整路径文件名
  • fileVersio 文件版本(可以填版本号,也可以md5,也可以为空)
  • httpUrl 目标URL
  • transforDeal 特殊处理配置,字典数据
  • extHeaders http头部扩展信息,字典数据
  • fileSize 文件大小
  • finishedSize 已传输大小
  • state 文件传输状态,详见HTTP_TRANSFER_STATE

文档列表

com.cloudroom.cloudroomvideosdk.model.NetDiskDocDir

  • name 在网盘里的文件名
  • files 查询目录下的所有文件
  • subDirs 查询目录下的所有目录

获取文档页信息结果

com.cloudroom.cloudroomvideosdk.model.NetDiskDocFilePageInfo

  • width 文档的图像宽度
  • height 文档的图像高度
  • fileList 每页文档在服务器上的路径文件名
© HeDonghai all right reserved,powered by Gitbook文件修订时间: 2019-03-28 18:48:02

results matching ""

    No results matching ""