类型定义

初始化配置

InitObj

• Type:object

登录配置

LoginObj

• Type:object

用户状态

UserStatus

队列信息

QueueInfo

队列状态

QueueStatus

排队信息

QueuingInfo

会话信息

VideoSessionInfo

队列用户

UserInfo

设备入会配置

CRDevJoinCfg

{
    devInfo: {
        autoOpenMic: 0,
        userID: "123456",
        nickname: "xxx",
        videoSize: "1280*720",
        quality2Size: "228*160"
    }
}

devInfo参数说明

操作房间属性选项

CRAttrOptions

房间属性集

CRAttrObjs

{
    "KeyXX": {
        "value": "11111",
        "lastModifyUserID": "111",
        "lastModifyTs": 11111
    },
    "KeyYY": {
        "value": "22222",
        "lastModifyUserID": "222",
        "lastModifyTs": 22222
    }
}

用户属性集

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

房间对象数据类

MeetInfo

成员信息

MemberInfo

• Type: object

音频配置

AudioCfg

• Type: object

视频配置

VideoCfg

• 注意事项

  • 我们采用的是vbr编码（由质量+码率，双重控制）
  • qp范围：质量参数，为的是达到目标质量后，无需花费更大码率提高质量
  • maxbps码率控制，是为了确保结果一定不大于“目标码率”（体积受控）, 当要超出码率控制时，自动降低质量；当质量达到目标时，自动减少码率甚至无码率输出 注：使用硬编时第二点是无效的。

视频效果配置

VideoEffects

前后置摄像头配置

DevicePosition

• Type: object

视频设备私有属性

VideoAttributes

用户摄像头

UsrVideoId

• Type: object

用户视频信息列表

VideoInfosObj

[
    {
        "isScreenCamera": false,
        "userId": "Uniapp_2212",
        "isDisabled": false,
        "videoID": 1,
        "videoName": "CAMERA_FACING_FRONT",
        "isCustomCamera": false,
        "isIPCamera": false,
        "devID": "1_1"
    },
    {
        "isScreenCamera": false,
        "userId": "Uniapp_2212",
        "isDisabled": false,
        "videoID": 2,
        "videoName": "CAMERA_FACING_BACK",
        "isCustomCamera": false,
        "isIPCamera": false,
        "devID": "1_0"
    }
]

• Type: object

影音文件信息

MediaInfoObj

• Type: object

屏幕共享配置对象

ScreenShareCfg

• Type: object

屏幕共享启动配置对象

ScreenMessageCfg

• Type: object

混图器规格配置

MixerCfg

• Type: object

混图器内容配置

MixerCotent

• Type: object

type描述：
当type=0时，表示混图的是摄像头，可配置userId、camId；
当type=1时，表示混图的是图片，可配置resId(仅用于本地混图)；
当type=3时，表示混图的是影音共享；
当type=5时，表示混图的是共享的屏幕；
当type=6时，表示混图的是白板；
当type=10时，表示混图的是文本，可配置text、color、background、font-size、text-margin。

混图器输出配置

MixerOutPutCfg

• Type: object

录制文件

RecordFileShow

录制文件、直播信息通知

MixerOutputInfo

云端混图器配置

CloudMixerCfgObj

• Type:object

//为房间中所有人录制独立的声音文件，独立的默认摄像头视频文件
{
    "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"}
            }
        ]
    }
}

云端录制语音文件配置

CloudMixerAudioFileCfg

• Type:object

单流模式参数：

合流模式参数：

云端录制视频文件配置

• Type:object

CloudMixerVideoFileCfg

单流模式参数：

合流模式参数：

云端录制存储配置

CloudStorageConfig

• Type:object

混图器内容配置

MixerContentObj

• Type:object

{
  "type": 0, 
  "keepAspectRatio": 1,
  "left": 5,
  "top": 10, 
  "width": 633,
  "height": 356,
  "param": {
    "camid": "usr1.1"
  }
}

type描述：

• 当type=0时，表示混图的是摄像头，param必须包含camid；
• 当type=3时，表示混图的是影音共享，不用附加任何参数；
• 当type=5时，表示混图的是共享的屏幕，不用附加任何参数；
• 当type=6时，表示混图的是白板，不用附加任何参数；
• 当type=10时，表示混图的是文本，width和height将被忽略，元素大小由文本信息自动确定。 param必须包含text，可选text-color，bk-color，font-size，text-margin；

param 支持的参数如下：

• camid：用户id.摄像头id, 如："testuser.1"
• 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

云端混图器信息

CloudMixerInfo

• Type:object

云端混图器输出信息

CloudMixerOutputInfo