AbnormalEvent
造成异常体验可能的异常事件类型
被如下接口引用：DescribeUnusualEvent。
| 名称 | 类型 | 描述 |
|---|---|---|
| AbnormalEventId | Integer | 异常事件ID，具体值查看附录：异常体验ID映射表：https://cloud.tencent.com/document/product/647/44916 |
| PeerId | String | 远端用户ID,""：表示异常事件不是由远端用户产生 注意：此字段可能返回 null，表示取不到有效值。 |
AbnormalExperience
用户的异常体验及可能的原因
被如下接口引用：DescribeUnusualEvent。
| 名称 | 类型 | 描述 |
|---|---|---|
| UserId | String | 用户ID |
| ExperienceId | Integer | 异常体验ID |
| RoomId | String | 字符串房间号 |
| AbnormalEventList | Array of AbnormalEvent | 异常事件数组 |
| EventTime | Integer | 异常事件的上报时间 |
AgentParams
转推服务加入TRTC房间的机器人参数。
被如下接口引用：StartPublishCdnStream。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| UserId | String | 是 | 转推服务在TRTC房间使用的UserId，注意这个userId不能与其他TRTC或者转推服务等已经使用的UserId重复，建议可以把房间ID作为userId的标识的一部分。 示例值：room_1234_rtmp_1 |
| UserSig | String | 否 | 转推服务加入TRTC房间的用户签名，当前 UserId 对应的验证签名，相当于登录密码，具体计算方法请参考TRTC计算UserSig的方案。 示例值：xxxx |
| MaxIdleTime | Integer | 否 | 所有参与混流转推的主播持续离开TRTC房间或切换成观众超过MaxIdleTime的时长，自动停止转推，单位：秒。默认值为 30 秒，该值需大于等于 5秒，且小于等于 86400秒(24小时)。 示例值：50 |
AudioEncode
音频编码参数。
被如下接口引用：StartPublishCdnStream, UpdatePublishCdnStream。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SampleRate | Integer | 是 | 输出流音频采样率。取值为[48000, 44100, 32000, 24000, 16000, 8000]，单位是Hz。 示例值：48000 |
| Channel | Integer | 是 | 输出流音频声道数，取值范围[1,2]，1表示混流输出音频为单声道，2表示混流输出音频为双声道。 示例值：2 |
| BitRate | Integer | 是 | 输出流音频码率。取值范围[8,500]，单位为kbps。 示例值：64 |
| Codec | Integer | 否 | 输出流音频编码类型，取值范围[0, 1, 2]，0为LC-AAC，1为HE-AAC，2为HE-AACv2。默认值为0。当音频编码设置为HE-AACv2时，只支持输出流音频声道数为双声道。HE-AAC和HE-AACv2支持的输出流音频采样率范围为[48000, 44100, 32000, 24000, 16000]。 示例值：0 |
AudioEncodeParams
音频转码参数
被如下接口引用：StartStreamIngest。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SampleRate | Integer | 否 | 音频采样率，取值为[48000, 44100]，单位是Hz。 示例值：48000 |
| Channel | Integer | 否 | 音频声道数，取值范围[1,2]，1表示音频为单声道，2表示音频为双声道。 示例值：1 |
| BitRate | Integer | 否 | 音频码率，取值范围[8,500]，单位为kbps。 示例值：64 |
| Volume | Integer | 否 | 音量，取值范围[0,300]。默认100，表示原始音量；0表示静音。 示例值：100 |
AudioParams
录制音频转码参数。
被如下接口引用：CreateCloudRecording。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SampleRate | Integer | 是 | 音频采样率枚举值:(注意1 代表48000HZ, 2 代表44100HZ, 3 代表16000HZ) 1：48000Hz（默认）; 2：44100Hz 3：16000Hz。 示例值：1 |
| Channel | Integer | 是 | 声道数枚举值: 1：单声道; 2：双声道（默认）。 示例值：2 |
| BitRate | Integer | 是 | 音频码率: 取值范围[32000, 128000] ，单位bps，默认64000bps。 示例值：64000 |
CloudStorage
腾讯云对象存储COS以及第三方云存储的账号信息
被如下接口引用：CreateCloudRecording, StartWebRecord。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Vendor | Integer | 是 | 腾讯云对象存储COS以及第三方云存储账号信息 0：腾讯云对象存储 COS 1：AWS 【注意】目前第三方云存储仅支持AWS，更多第三方云存储陆续支持中 示例值：0 示例值：0 |
| Region | String | 是 | 腾讯云对象存储的[地域信息]（https://cloud.tencent.com/document/product/436/6224#.E5.9C.B0.E5.9F.9F）。 示例值：cn-shanghai-1 AWS S3[地域信息]（https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions） 示例值：ap-southeast-3 示例值：cn-shanghai-1 |
| Bucket | String | 是 | 云存储桶名称。 示例值：test-bucket |
| AccessKey | String | 是 | 云存储的access_key账号信息。 若存储至腾讯云对象存储COS，请前往https://console.cloud.tencent.com/cam/capi 查看或创建，对应链接中密钥字段的SecretId值。 示例值：test-accesskey 示例值：test-accesskey |
| SecretKey | String | 是 | 云存储的secret_key账号信息。 若存储至腾讯云对象存储COS，请前往https://console.cloud.tencent.com/cam/capi 查看或创建，对应链接中密钥字段的SecretKey值。 示例值：test-secretkey 示例值：test-secretkey |
| FileNamePrefix | Array of String | 否 | 云存储bucket 的指定位置，由字符串数组组成。合法的字符串范围az,AZ,0~9,'_'和'-'，举个例子，录制文件xxx.m3u8在 ["prefix1", "prefix2"]作用下，会变成prefix1/prefix2/TaskId/xxx.m3u8。 示例值：["prefix1", "prefix2"] 示例值：["prefix1", "prefix2"] |
CloudVod
点播相关参数。
被如下接口引用：CreateCloudRecording, StartWebRecord。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TencentVod | TencentVod | 否 | 腾讯云点播相关参数。 |
EncodeParams
MCU混流输出流编码参数
被如下接口引用：StartMCUMixTranscode, StartMCUMixTranscodeByStrRoomId。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AudioSampleRate | Integer | 是 | 混流-输出流音频采样率。取值为[48000, 44100, 32000, 24000, 16000, 8000]，单位是Hz。混流任务发起过程中，为了保持CDN链接的稳定，不要修改音频参数（codec、采样率、码率、声道数）。 示例值：48000 |
| AudioBitrate | Integer | 是 | 混流-输出流音频码率。取值范围[8,500]，单位为kbps。混流任务发起过程中，为了保持CDN链接的稳定，不要修改音频参数（codec、采样率、码率、声道数）。 示例值：64 |
| AudioChannels | Integer | 是 | 混流-输出流音频声道数，取值范围[1,2]，1表示混流输出音频为单声道，2表示混流输出音频为双声道。混流任务发起过程中，为了保持CDN链接的稳定，不要修改音频参数（codec、采样率、码率、声道数）。 示例值：2 |
| VideoWidth | Integer | 否 | 混流-输出流宽，音视频输出时必填。取值范围[0,1920]，单位为像素值。 示例值：1280 |
| VideoHeight | Integer | 否 | 混流-输出流高，音视频输出时必填。取值范围[0,1080]，单位为像素值。 示例值：720 |
| VideoBitrate | Integer | 否 | 混流-输出流码率，音视频输出时必填。取值范围[1,10000]，单位为kbps。 示例值：512 |
| VideoFramerate | Integer | 否 | 混流-输出流帧率，音视频输出时必填。取值范围[1,60]，表示混流的输出帧率可选范围为1到60fps。 示例值：15 |
| VideoGop | Integer | 否 | 混流-输出流gop，音视频输出时必填。取值范围[1,5]，单位为秒。 示例值：2 |
| BackgroundColor | Integer | 否 | 混流-输出流背景色，取值是十进制整数。常用的颜色有： 红色：0xff0000，对应的十进制整数是16724736。 黄色：0xffff00。对应的十进制整数是16776960。 绿色：0x33cc00。对应的十进制整数是3394560。 蓝色：0x0066ff。对应的十进制整数是26367。 黑色：0x000000。对应的十进制整数是0。 白色：0xFFFFFF。对应的十进制整数是16777215。 灰色：0x999999。对应的十进制整数是10066329。 示例值：0 |
| BackgroundImageId | Integer | 否 | 混流-输出流背景图片，取值为实时音视频控制台上传的图片ID。 示例值：0 |
| AudioCodec | Integer | 否 | 混流-输出流音频编码类型，取值范围[0,1, 2]，0为LC-AAC，1为HE-AAC，2为HE-AACv2。默认值为0。当音频编码设置为HE-AACv2时，只支持输出流音频声道数为双声道。HE-AAC和HE-AACv2支持的输出流音频采样率范围为[48000, 44100, 32000, 24000, 16000]。混流任务发起过程中，为了保持CDN链接的稳定，不要修改音频参数（codec、采样率、码率、声道数）。 示例值：0 |
| BackgroundImageUrl | String | 否 | 混流-输出流背景图片URL地址，支持png、jpg、jpeg、bmp格式，暂不支持透明通道。URL链接长度限制为512字节。BackgroundImageUrl和BackgroundImageId参数都填时，以BackgroundImageUrl为准。图片大小限制不超过2MB。 示例值：xxx |
EventList
sdk或webrtc的事件列表。
被如下接口引用：DescribeUserEvent。
| 名称 | 类型 | 描述 |
|---|---|---|
| Content | Array of EventMessage | 数据内容 |
| PeerId | String | 发送端的userId |
EventMessage
事件信息，包括，事件时间戳，事件ID,
被如下接口引用：DescribeUserEvent。
| 名称 | 类型 | 描述 |
|---|---|---|
| Type | Integer | 视频流类型： 0：与视频无关的事件； 2：视频为大画面； 3：视频为小画面； 7：视频为旁路画面； |
| Time | Integer | 事件上报的时间戳，unix时间（1589891188801ms) |
| EventId | Integer | 事件Id：分为sdk的事件和webrtc的事件，详情见：附录/事件 ID 映射表：https://cloud.tencent.com/document/product/647/44916 |
| ParamOne | Integer | 事件的第一个参数，如视频分辨率宽 |
| ParamTwo | Integer | 事件的第二个参数，如视频分辨率高 |
LayoutParams
MCU混流布局参数
被如下接口引用：StartMCUMixTranscode, StartMCUMixTranscodeByStrRoomId。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Template | Integer | 否 | 混流布局模板ID，0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。 示例值：0 |
| MainVideoUserId | String | 否 | 屏幕分享模板、悬浮模板、画中画模板中有效，代表大画面对应的用户ID。 示例值："main_video_user" |
| MainVideoStreamType | Integer | 否 | 屏幕分享模板、悬浮模板、画中画模板中有效，代表大画面对应的流类型，0为摄像头，1为屏幕分享。左侧大画面为web用户时此值填0。 示例值：0 |
| SmallVideoLayoutParams | SmallVideoLayoutParams | 否 | 画中画模板中有效，代表小画面的布局参数。 示例值：SmallVideoLayoutParams |
| MainVideoRightAlign | Integer | 否 | 屏幕分享模板有效。设置为1时代表大画面居右，小画面居左布局。默认为0。 示例值：0 |
| MixVideoUids | Array of String | 否 | 指定混视频的用户ID列表。设置此参数后，输出流混合此参数中包含用户的音视频，以及其他用户的纯音频。悬浮模板、九宫格、屏幕分享模板有效，最多可设置16个用户。 示例值：["1234","5678"] |
| PresetLayoutConfig | Array of PresetLayoutConfig | 否 | 自定义模板中有效，指定用户视频在混合画面中的位置。 示例值：PresetLayoutConfig |
| PlaceHolderMode | Integer | 否 | 自定义模板中有效，设置为1时代表启用占位图功能，0时代表不启用占位图功能，默认为0。启用占位图功能时，在预设位置的用户没有上行视频时可显示对应的占位图。 示例值：0 |
| PureAudioHoldPlaceMode | Integer | 否 | 悬浮模板、九宫格、屏幕分享模板生效，用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式，悬浮小画面占布局位置，九宫格画面占布局位置、屏幕分享小画面不占布局位置；设置为1时代表纯音频上行占布局位置；设置为2时代表纯音频上行不占布局位置。默认为0。 示例值：0 |
| WaterMarkParams | WaterMarkParams | 否 | 水印参数。 示例值：WaterMarkParams |
| RenderMode | Integer | 否 | 屏幕分享模板、悬浮模板、九宫格模板、画中画模版有效，画面在输出时的显示模式：0为裁剪，1为缩放，2为缩放并显示黑底，不填采用后台的默认渲染方式（屏幕分享大画面为缩放，其他为裁剪）。若此参数不生效，请提交工单寻求帮助。 示例值：0 |
MaxVideoUser
指定动态布局中悬浮布局和屏幕分享布局的大画面信息，只在悬浮布局和屏幕分享布局有效。
被如下接口引用：StartPublishCdnStream, UpdatePublishCdnStream。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| UserMediaStream | UserMediaStream | 是 | 用户媒体流参数。 示例值：UserMediaStream |
McuAudioParams
混流转推的音频相关参数。
被如下接口引用：StartPublishCdnStream, UpdatePublishCdnStream。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AudioEncode | AudioEncode | 否 | 音频编码参数。 示例值：AudioEncode |
| SubscribeAudioList | Array of McuUserInfoParams | 否 | 音频用户白名单，start时，为空或不填表示混所有主播音频，填具体值表示混指定主播音频；update时，不填表示不更新，为空表示更新为混所有主播音频，填具体值表示更新为混指定主播音频。 使用黑白名单时，黑白名单必须同时填写。都不填写时表示不更新。同一个用户同时在黑白名单时，以黑名单为主。 示例值：SubscribeAudioList |
| UnSubscribeAudioList | Array of McuUserInfoParams | 否 | 音频用户黑名单，为空或不填表示无黑名单，填具体值表示不混指定主播音频。update时，不填表示不更新，为空表示更新为清空黑名单，填具体值表示更新为不混指定主播音频。 使用黑白名单时，黑白名单必须同时填写。都不填写时表示不更新。同一个用户同时在黑白名单时，以黑名单为主。 示例值：UnSubscribeAudioList |
McuBackgroundCustomRender
混流自定义渲染参数
被如下接口引用：StartPublishCdnStream, UpdatePublishCdnStream。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Width | Integer | 是 | 自定义渲染画面的宽度，单位为像素值，需大于0，且不能超过子布局的宽。 |
| Height | Integer | 是 | 自定义渲染画面的高度，单位为像素值，需大于0，且不能超过子布局的高。 |
| Radius | Integer | 否 | 自定义渲染画面的圆角半径，单位为像素值，不能超过渲染画面Width和Height最小值的一半，不指定默认为0，表示直角。 示例值：0 |
McuCustomCrop
混流自定义裁剪参数
被如下接口引用：StartPublishCdnStream, UpdatePublishCdnStream。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| LocationX | Integer | 是 | 自定义裁剪起始位置的X偏移，单位为像素值，大于等于0。 示例值：0 |
| LocationY | Integer | 是 | 自定义裁剪起始位置的Y偏移，单位为像素值，大于等于0。 示例值：0 |
| Width | Integer | 是 | 自定义裁剪画面的宽度，单位为像素值，大于0，且LocationX+Width不超过10000 示例值：168 |
| Height | Integer | 是 | 自定义裁剪画面的高度，单位为像素值，大于0，且LocationY+Height不超过10000 示例值：168 |
McuFeedBackRoomParams
回推房间参数。
被如下接口引用：StartPublishCdnStream, UpdatePublishCdnStream。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| RoomId | String | 是 | 回推房间的RoomId。 示例值：room_1234 |
| RoomIdType | Integer | 是 | 房间类型，必须和回推房间所对应的RoomId类型相同，0为整形房间号，1为字符串房间号。 示例值：1 |
| UserId | String | 是 | 回推房间使用的UserId(https://cloud.tencent.com/document/product/647/46351#userid)，注意这个userId不能与其他TRTC或者转推服务等已经使用的UserId重复，建议可以把房间ID作为userId的标识的一部分。 示例值：room_1234_push_1 |
| UserSig | String | 是 | 回推房间UserId对应的用户签名，相当于登录密码，具体计算方法请参考TRTC计算UserSig的方案。 示例值：xxxx |
McuLayout
混流布局参数。
被如下接口引用：StartPublishCdnStream, UpdatePublishCdnStream。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| UserMediaStream | UserMediaStream | 否 | 用户媒体流参数。不填时腾讯云后台按照上行主播的进房顺序自动填充。 示例值：UserMediaStream |
| ImageWidth | Integer | 否 | 子画面在输出时的宽度，单位为像素值，不填默认为0。 示例值：1280 |
| ImageHeight | Integer | 否 | 子画面在输出时的高度，单位为像素值，不填默认为0。 示例值：720 |
| LocationX | Integer | 否 | 子画面在输出时的X偏移，单位为像素值，LocationX与ImageWidth之和不能超过混流输出的总宽度，不填默认为0。 示例值：0 |
| LocationY | Integer | 否 | 子画面在输出时的Y偏移，单位为像素值，LocationY与ImageHeight之和不能超过混流输出的总高度，不填默认为0。 示例值：0 |
| ZOrder | Integer | 否 | 子画面在输出时的层级，不填默认为0。 示例值：0 |
| RenderMode | Integer | 否 | 子画面在输出时的显示模式：0为裁剪，1为缩放并显示背景，2为缩放并显示黑底。不填默认为0。 示例值：0 |
| BackGroundColor | String | 否 | 【此参数配置无效，暂不支持】子画面的背景颜色，常用的颜色有： 红色：0xcc0033。 黄色：0xcc9900。 绿色：0xcccc33。 蓝色：0x99CCFF。 黑色：0x000000。 白色：0xFFFFFF。 灰色：0x999999。 示例值：0xFFFFFF |
| BackgroundImageUrl | String | 否 | 子画面的背景图url，填写该参数，当用户关闭摄像头或未进入TRTC房间时，会在布局位置填充为指定图片。若指定图片与布局位置尺寸比例不一致，则会对图片进行拉伸处理，优先级高于BackGroundColor。支持png、jpg、jpeg、bmp、gif、webm格式。图片大小限制不超过5MB。 注：您需要确保图片链接的可访问性，后台单次下载超时时间为10秒，最多重试3次，若最终图片下载失败，子画面的背景图将不会生效。 示例值：xxxx |
| CustomCrop | McuCustomCrop | 否 | 客户自定义裁剪，针对原始输入流裁剪 示例值：xxx |
| BackgroundRenderMode | Integer | 否 | 子背景图在输出时的显示模式：0为裁剪，1为缩放并显示背景，2为缩放并显示黑底，3为变比例伸缩，4为自定义渲染。不填默认为3。 示例值：3 |
| TransparentUrl | String | 否 | 子画面的透明模版url，指向一张包含透明通道的模板图片。填写该参数，后台混流时会提取该模板图片的透明通道，将其缩放作为目标画面的透明通道，再和其他画面进行混合。您可以通过透明模版实现目标画面的半透明效果和任意形状裁剪（如圆角、星形、心形等）。 支持png格式。图片大小限制不超过5MB。 注：1，模板图片宽高比应接近目标画面宽高比，以避免缩放适配目标画面时出现模板效果变形；2，透明模版只有RenderMode为0（裁剪）时才生效；3，您需要确保图片链接的可访问性，后台单次下载超时时间为10秒，最多重试3次，若最终图片下载失败，透明模版将不会生效。 示例值：xxxx |
| BackgroundCustomRender | McuBackgroundCustomRender | 否 | 子背景图的自定义渲染参数，当BackgroundRenderMode为4时必须配置。 示例值：BackgroundCustomRender |
McuLayoutParams
混流布局参数。
被如下接口引用：StartPublishCdnStream, UpdatePublishCdnStream。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| MixLayoutMode | Integer | 否 | 布局模式：动态布局（1：悬浮布局（默认），2：屏幕分享布局，3：九宫格布局），静态布局（4：自定义布局）。 示例值：4 |
| PureAudioHoldPlaceMode | Integer | 否 | 纯音频上行是否占布局位置，只在动态布局中有效。0表示纯音频不占布局位置，1表示纯音频占布局位置，不填默认为0。 示例值：0 |
| MixLayoutList | Array of McuLayout | 否 | 自定义模板中有效，指定用户视频在混合画面中的位置。 示例值：MixLayoutList |
| MaxVideoUser | MaxVideoUser | 否 | 指定动态布局中悬浮布局和屏幕分享布局的大画面信息，只在悬浮布局和屏幕分享布局有效。 示例值：MaxVideoUser |
| RenderMode | Integer | 否 | 屏幕分享模板、悬浮模板、九宫格模版有效，画面在输出时的显示模式：0为裁剪，1为缩放，2为缩放并显示黑底 示例值：0 |
McuLayoutVolume
音量布局SEI参数，可以自定义AppData和PayloadType类型。
该参数内容可以为空，表示携带默认的音量布局SEI。
被如下接口引用：StartPublishCdnStream, UpdatePublishCdnStream。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AppData | String | 否 | AppData的内容，会被写入自定义SEI中的app_data字段，长度需小于4096。 示例值：xxxx |
| PayloadType | Integer | 否 | SEI消息的payload_type，默认值100，取值范围100-254（244除外，244为我们内部自定义的时间戳SEI） 示例值：100 |
| Interval | Integer | 否 | SEI发送间隔，单位毫秒，默认值为1000。 示例值：1000 |
| FollowIdr | Integer | 否 | 取值范围[0,1]，填1：发送关键帧时会确保带SEI；填0：发送关键帧时不确保带SEI。默认值为0。 示例值：0 |
McuPassThrough
自定义透传SEI
被如下接口引用：StartPublishCdnStream, UpdatePublishCdnStream。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| PayloadContent | String | 是 | 透传SEI的payload内容。 示例值：xxxx |
| PayloadType | Integer | 是 | SEI消息的payload_type，取值范围5、100-254（244除外，244为我们内部自定义的时间戳SEI）。 示例值：101 |
| PayloadUuid | String | 否 | PayloadType为5，PayloadUuid必须填写。PayloadType不是5时，不需要填写，填写会被后台忽略。该值必须是32长度的十六进制。 示例值：xxxx |
| Interval | Integer | 否 | SEI发送间隔，单位毫秒，默认值为1000。 示例值：1000 |
| FollowIdr | Integer | 否 | 取值范围[0,1]，填1：发送关键帧时会确保带SEI；填0：发送关键帧时不确保带SEI。默认值为0。 示例值：0 |
McuPublishCdnParam
转推参数。
被如下接口引用：StartPublishCdnStream, StartWebRecord, UpdatePublishCdnStream。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| PublishCdnUrl | String | 是 | CDN转推URL，只支持rtmp链接。 注：若更新转推时，URL有任何变化，都会断流重推。 示例值：xxxx |
| IsTencentCdn | Integer | 否 | 是否是腾讯云CDN，0为转推非腾讯云CDN，1为转推腾讯CDN，不携带该参数默认为1。注意：1，为避免误产生转推费用，该参数建议明确填写，转推非腾讯云CDN时会产生转推费用，详情参见接口文档说明；2，国内站默认只支持转推腾讯云CDN，如您有转推第三方CDN需求，请联系腾讯云技术支持。 示例值：1 |
McuSeiParams
混流SEI参数
被如下接口引用：StartPublishCdnStream, UpdatePublishCdnStream。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| LayoutVolume | McuLayoutVolume | 否 | 音量布局SEI 示例值：LayoutVolume |
| PassThrough | McuPassThrough | 否 | 透传SEI 示例值：PassThrough |
McuUserInfoParams
混流用户参数
被如下接口引用：StartPublishCdnStream, UpdatePublishCdnStream。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| UserInfo | MixUserInfo | 是 | 用户参数。 示例值：UserInfo |
McuVideoParams
混流转推的视频相关参数。
被如下接口引用：StartPublishCdnStream, UpdatePublishCdnStream。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| VideoEncode | VideoEncode | 否 | 输出流视频编码参数。 示例值：VideoEncode |
| LayoutParams | McuLayoutParams | 否 | 混流布局参数。 示例值：LayoutParams |
| BackGroundColor | String | 否 | 整个画布背景颜色，常用的颜色有： 红色：0xcc0033。 黄色：0xcc9900。 绿色：0xcccc33。 蓝色：0x99CCFF。 黑色：0x000000。 白色：0xFFFFFF。 灰色：0x999999。 示例值：0xFFFFFF |
| BackgroundImageUrl | String | 否 | 整个画布的背景图url，优先级高于BackGroundColor。支持png、jpg、jpeg格式。图片大小限制不超过5MB。 注：您需要确保图片链接的可访问性，后台单次下载超时时间为10秒，最多重试3次，若最终图片下载失败，背景图将不会生效。 示例值：xxxx |
| WaterMarkList | Array of McuWaterMarkParams | 否 | 混流布局的水印参数。 示例值：WaterMarkList |
| BackgroundRenderMode | Integer | 否 | 背景图在输出时的显示模式：0为裁剪，1为缩放并显示黑底，2为变比例伸缩。后台默认为变比例伸缩。 示例值：2 |
McuWaterMarkImage
图片水印参数。
被如下接口引用：StartPublishCdnStream, UpdatePublishCdnStream。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| WaterMarkUrl | String | 是 | 水印图片URL地址，支持png、jpg、jpeg格式。图片大小限制不超过5MB。 注：您需要确保图片链接的可访问性，后台单次下载超时时间为10秒，最多重试3次，若最终图片下载失败，水印图片将不会生效。 示例值：xxx.png |
| WaterMarkWidth | Integer | 是 | 水印在输出时的宽。单位为像素值。 示例值：64 |
| WaterMarkHeight | Integer | 是 | 水印在输出时的高。单位为像素值。 示例值：64 |
| LocationX | Integer | 是 | 水印在输出时的X偏移。单位为像素值。 示例值：0 |
| LocationY | Integer | 是 | 水印在输出时的Y偏移。单位为像素值。 示例值：0 |
| ZOrder | Integer | 否 | 水印在输出时的层级，不填默认为0。 示例值：0 |
| DynamicPosType | Integer | 否 | 动态水印类型，默认为0。0:关闭；1:随机位置，每秒变动一次；2:边界扫描反弹，每帧变动一次。 示例值：0 |
McuWaterMarkParams
水印参数。
被如下接口引用：StartPublishCdnStream, UpdatePublishCdnStream。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| WaterMarkType | Integer | 否 | 水印类型，0为图片（默认），1为文字。 示例值：0 |
| WaterMarkImage | McuWaterMarkImage | 否 | 图片水印参数。WaterMarkType为0指定。 示例值：WaterMarkImage |
| WaterMarkText | McuWaterMarkText | 否 | 文字水印参数。WaterMarkType为1指定。 示例值：WaterMarkText |
McuWaterMarkText
文字水印参数。
被如下接口引用：StartPublishCdnStream, UpdatePublishCdnStream。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Text | String | 是 | 文字水印内容。 示例值："XXX" |
| WaterMarkWidth | Integer | 是 | 水印在输出时的宽。单位为像素值。 示例值：64 |
| WaterMarkHeight | Integer | 是 | 水印在输出时的高。单位为像素值。 示例值：64 |
| LocationX | Integer | 是 | 水印在输出时的X偏移。单位为像素值。 示例值：0 |
| LocationY | Integer | 是 | 水印在输出时的Y偏移。单位为像素值。 示例值：0 |
| FontSize | Integer | 是 | 字体大小 示例值：12 |
| FontColor | String | 否 | 字体颜色，默认为白色。常用的颜色有： 红色：0xcc0033。 黄色：0xcc9900。 绿色：0xcccc33。 蓝色：0x99CCFF。 黑色：0x000000。 白色：0xFFFFFF。 灰色：0x999999。 示例值：0xFFFFFF |
| BackGroundColor | String | 否 | 字体背景色，不配置默认为透明。常用的颜色有： 红色：0xcc0033。 黄色：0xcc9900。 绿色：0xcccc33。 蓝色：0x99CCFF。 黑色：0x000000。 白色：0xFFFFFF。 灰色：0x999999。 示例值：0x000000 |
| DynamicPosType | Integer | 否 | 动态水印类型，默认为0。0:关闭；1:随机位置，每秒变动一次；2:边界扫描反弹，每帧变动一次。 示例值：0 |
| ZOrder | Integer | 否 | 水印在输出时的层级，不填默认为0。 示例值：0 |
MixLayout
用户自定义混流布局参数列表。
被如下接口引用：CreateCloudRecording, ModifyCloudRecording。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Top | Integer | 是 | 画布上该画面左上角的 y 轴坐标，取值范围 [0, 1920]，不能超过画布的高。 示例值：100 |
| Left | Integer | 是 | 画布上该画面左上角的 x 轴坐标，取值范围 [0, 1920]，不能超过画布的宽。 示例值：100 |
| Width | Integer | 是 | 画布上该画面宽度的相对值，取值范围 [0, 1920]，与Left相加不应超过画布的宽。 示例值：100 |
| Height | Integer | 是 | 画布上该画面高度的相对值，取值范围 [0, 1920]，与Top相加不应超过画布的高。 示例值：100 |
| UserId | String | 否 | 字符串内容为待显示在该画面的主播对应的UserId，如果不指定，会按照主播加入房间的顺序匹配。 示例值：123 |
| Alpha | Integer | 否 | 画布的透明度值，取值范围[0, 255]。0表示不透明，255表示全透明。默认值为0。 示例值：100 |
| RenderMode | Integer | 否 | 0 ：拉伸模式，这个模式下整个视频内容会全部显示，并填满子画面，在源视频和目的视频宽高比不一致的时候，画面不会缺少内容，但是画面可能产生形变； 1 ：剪裁模式（默认），这个模式下会严格按照目的视频的宽高比对源视频剪裁之后再拉伸，并填满子画面画布，在源视频和目的视频宽高比不一致的时候，画面保持不变形，但是会被剪裁； 2 ：填黑模式，这个模式下会严格保持源视频的宽高比进行等比缩放，在源视频和目的视频宽高比不一致的时候，画面的上下侧边缘或者左右侧边缘会露出子画面画布的背景； 3 ：智能拉伸模式，这个模式类似剪裁模式，区别是在源视频和目的视频宽高比不一致的时候，限制了最大剪裁比例为画面的宽度或者高度的20%； 示例值：1 |
| MediaId | Integer | 否 | 对应订阅流的主辅路标识： 0：主流（默认）； 1：辅流； 示例值：1 |
| ImageLayer | Integer | 否 | 该画布的图层顺序, 这个值越小表示图层越靠后。默认值为0。 示例值：2 |
| SubBackgroundImage | String | 否 | 图片的url地址， 只支持jpg， png，大小限制不超过5M，宽高比不一致的处理方案同 RenderMode。 示例值：https://xxxx |
MixLayoutParams
录制的混流布局参数。
被如下接口引用：CreateCloudRecording, ModifyCloudRecording。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| MixLayoutMode | Integer | 是 | 布局模式: 1：悬浮布局； 2：屏幕分享布局； 3：九宫格布局（默认）； 4：自定义布局； 悬浮布局：默认第一个进入房间的主播（也可以指定一个主播）的视频画面会铺满整个屏幕。其他主播的视频画面从左下角开始依次按照进房顺序水平排列，显示为小画面，小画面悬浮于大画面之上。当画面数量小于等于17个时，每行4个（4 x 4排列）。当画面数量大于17个时，重新布局小画面为每行5个（5 x 5）排列。最多支持25个画面，如果用户只发送音频，仍然会占用画面位置。 屏幕分享布局：指定一个主播在屏幕左侧的大画面位置（如果不指定，那么大画面位置为背景色），其他主播自上而下依次垂直排列于右侧。当画面数量少于17个的时候，右侧每列最多8人，最多占据两列。当画面数量多于17个的时候，超过17个画面的主播从左下角开始依次水平排列。最多支持25个画面，如果主播只发送音频，仍然会占用画面位置。 九宫格布局：根据主播的数量自动调整每个画面的大小，每个主播的画面大小一致，最多支持25个画面。 自定义布局：根据需要在MixLayoutList内定制每个主播画面的布局。 示例值：3 |
| MixLayoutList | Array of MixLayout | 否 | 如果MixLayoutMode 选择为4自定义布局模式的话，设置此参数为每个主播所对应的布局画面的详细信息，最大不超过25个。 |
| BackGroundColor | String | 否 | 录制背景颜色，RGB的颜色表的16进制表示，每个颜色通过8bit长度标识，默认为黑色。比如橙色对应的RGB为 R:255 G:165 B:0, 那么对应的字符串描述为#FFA500，格式规范：‘#‘开头，后面跟固定RGB的颜色值 示例值：123 |
| MaxResolutionUserId | String | 否 | 在布局模式为1：悬浮布局和 2：屏幕分享布局时，设定为显示大视频画面的UserId。不填的话：悬浮布局默认是第一个进房间的主播，屏幕分享布局默认是背景色 示例值：123 |
| MediaId | Integer | 否 | 主辅路标识， 0：主流（默认）； 1：辅流（屏幕分享）； 这个位置的MediaId代表的是对应MaxResolutionUserId的主辅路，MixLayoutList内代表的是自定义用户的主辅路。 示例值：0 |
| BackgroundImageUrl | String | 否 | 图片的url地址， 只支持jpg， png，大小限制不超过5M，url不可包含中文。 示例值：https://xxxx |
| PlaceHolderMode | Integer | 否 | 设置为1时代表启用占位图功能，0时代表不启用占位图功能，默认为0。启用占位图功能时，在预设位置的用户没有上行视频时可显示对应的占位图。 示例值：0 |
| BackgroundImageRenderMode | Integer | 否 | 背景画面宽高比不一致的时候处理方案，与MixLayoufList定义的RenderMode一致。 示例值：1 |
| DefaultSubBackgroundImage | String | 否 | 子画面占位图url地址， 只支持jpg， png，大小限制不超过5M，宽高比不一致的处理方案同 RenderMode。 示例值：https://xxxx |
| WaterMarkList | Array of WaterMark | 否 | 水印布局参数， 最多支持25个。 |
| RenderMode | Integer | 否 | 模板布局下，背景画面宽高比不一致的时候处理方案。自定义布局不生效，与MixLayoufList定义的RenderMode一致。 示例值：1 |
| MaxResolutionUserAlign | Integer | 否 | 屏幕分享模板有效。设置为1时代表大画面居右，小画面居左布局。默认为0。 示例值：0 |
MixTranscodeParams
录制的音视频转码参数。
被如下接口引用：CreateCloudRecording。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| VideoParams | VideoParams | 否 | 录制视频转码参数，注意如果设置了这个参数，那么里面的字段都是必填的，没有默认值，如果不填这个参数，那么取值为默认值。 |
| AudioParams | AudioParams | 否 | 录制音频转码参数，注意如果设置了这个参数，那么里面的字段都是必填的，没有默认值，如果不填这个参数，那么取值为默认值。 |
MixUserInfo
TRTC用户参数。
被如下接口引用：StartPublishCdnStream, UpdatePublishCdnStream。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| UserId | String | 是 | 用户ID。 示例值：owen-test |
| RoomId | String | 否 | 动态布局时房间信息必须和主房间信息保持一致，自定义布局时房间信息必须和MixLayoutList中对应用户的房间信息保持一致，不填时默认与主房间信息一致。 示例值：room_1234 |
| RoomIdType | Integer | 否 | 房间号类型，0为整形房间号，1为字符串房间号。 示例值：1 |
OneSdkAppIdTranscodeTimeUsagesInfo
旁路转码时长的查询结果
被如下接口引用：DescribeTrtcMcuTranscodeTime。
| 名称 | 类型 | 描述 |
|---|---|---|
| SdkAppIdTranscodeTimeUsages | Array of SdkAppIdTrtcMcuTranscodeTimeUsage | 旁路转码时长查询结果数组 |
| TotalNum | Integer | 查询记录数量 |
| SdkAppId | String | 所查询的应用ID，可能值为:1-应用的应用ID，2-total，显示为total则表示查询的是所有应用的用量合计值。 |
OutputParams
MCU混流的输出参数
被如下接口引用：StartMCUMixTranscode, StartMCUMixTranscodeByStrRoomId。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| StreamId | String | 是 | 直播流 ID，由用户自定义设置，该流 ID 不能与用户旁路的流 ID 相同，限制64字节。 示例值：mix_stream |
| PureAudioStream | Integer | 否 | 取值范围[0,1]， 填0：直播流为音视频(默认); 填1：直播流为纯音频 示例值：0 |
| RecordId | String | 否 | 自定义录制文件名称前缀。请先在实时音视频控制台开通录制功能，https://cloud.tencent.com/document/product/647/50768。 【注意】该方式仅对旧版云端录制功能的应用生效，新版云端录制功能的应用请用接口CreateCloudRecording发起录制。新、旧云端录制类型判断方式请见：https://cloud.tencent.com/document/product/647/50768#record 示例值：mix_stream_record |
| RecordAudioOnly | Integer | 否 | 取值范围[0,1]，填0无实际含义; 填1：指定录制文件格式为mp3。此参数不建议使用，建议在实时音视频控制台配置纯音频录制模板。 示例值：0 |
PictureInfo
图片列表信息
被如下接口引用：DescribePicture。
| 名称 | 类型 | 描述 |
|---|---|---|
| Height | Integer | 图片长度 示例值：15 |
| Width | Integer | 图片宽度 示例值：15 |
| XPosition | Integer | 显示位置x轴方向 示例值：36 |
| YPosition | Integer | 显示位置y轴方向 示例值：36 |
| SdkAppId | Integer | 应用id 示例值：1234567 |
| PictureId | Integer | 图片id 示例值：123 |
PresetLayoutConfig
自定义模板中有效，指定用户视频在混合画面中的位置。
被如下接口引用：StartMCUMixTranscode, StartMCUMixTranscodeByStrRoomId。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| UserId | String | 否 | 指定显示在该画面上的用户ID。如果不指定用户ID，会按照用户加入房间的顺序自动匹配PresetLayoutConfig中的画面设置。 示例值：user1 |
| StreamType | Integer | 否 | 当该画面指定用户时，代表用户的流类型。0为摄像头，1为屏幕分享。小画面为web用户时此值填0。 示例值：0 |
| ImageWidth | Integer | 否 | 该画面在输出时的宽度，单位为像素值，不填默认为0。 示例值：640 |
| ImageHeight | Integer | 否 | 该画面在输出时的高度，单位为像素值，不填默认为0。 示例值：480 |
| LocationX | Integer | 否 | 该画面在输出时的X偏移，单位为像素值，LocationX与ImageWidth之和不能超过混流输出的总宽度，不填默认为0。 示例值：0 |
| LocationY | Integer | 否 | 该画面在输出时的Y偏移，单位为像素值，LocationY与ImageHeight之和不能超过混流输出的总高度，不填默认为0。 示例值：0 |
| ZOrder | Integer | 否 | 该画面在输出时的层级，不填默认为0。 示例值：0 |
| RenderMode | Integer | 否 | 该画面在输出时的显示模式：0为裁剪，1为缩放，2为缩放并显示黑底。不填默认为0。 示例值：0 |
| MixInputType | Integer | 否 | 该当前位置用户混入的流类型：0为混入音视频，1为只混入视频，2为只混入音频。默认为0，建议配合指定用户ID使用。 示例值：0 |
| PlaceImageId | Integer | 否 | 占位图ID。启用占位图功能时，在当前位置的用户没有上行视频时显示占位图。占位图大小不能超过2M，在实时音视频控制台上传并生成，https://cloud.tencent.com/document/product/647/50769 示例值：0 |
PublishCdnParams
第三方CDN转推参数
被如下接口引用：StartMCUMixTranscode, StartMCUMixTranscodeByStrRoomId。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| BizId | Integer | 是 | 腾讯云直播BizId。 |
| PublishCdnUrls | Array of String | 是 | 第三方CDN转推的目的地址，同时只支持转推一个第三方CDN地址。 |
QualityData
Es返回的质量数据
被如下接口引用：DescribeCallDetailInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| Content | Array of TimeValue | 数据内容 |
| UserId | String | 用户ID |
| PeerId | String | 对端Id,为空时表示上行数据 注意：此字段可能返回 null，表示取不到有效值。 |
| DataType | String | 数据类型 |
RecordParams
云端录制控制参数。
被如下接口引用：CreateCloudRecording。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| RecordMode | Integer | 是 | 录制模式： 1：单流录制，分别录制房间的订阅UserId的音频和视频，将录制文件上传至云存储； 2：混流录制，将房间内订阅UserId的音视频混录成一个音视频文件，将录制文件上传至云存储； 示例值：1 |
| MaxIdleTime | Integer | 否 | 房间内持续没有用户（主播）上行推流的状态超过MaxIdleTime的时长，自动停止录制，单位：秒。默认值为 30 秒，该值需大于等于 5秒，且小于等于 86400秒(24小时)。 示例值：30 |
| StreamType | Integer | 否 | 录制的媒体流类型： 0：录制音频+视频流（默认）; 1：仅录制音频流； 2：仅录制视频流， 示例值：0 |
| SubscribeStreamUserIds | SubscribeStreamUserIds | 否 | 指定订阅流白名单或者黑名单。 |
| OutputFormat | Integer | 否 | 输出文件的格式（存储至COS等第三方存储时有效）。0：(默认)输出文件为hls格式。1：输出文件格式为hls+mp4。2：输出文件格式为hls+aac 。3：输出文件格式为mp4。4：输出文件格式为aac。 存储到云点播VOD时此参数无效，存储到VOD时请通过TencentVod（https://cloud.tencent.com/document/api/647/44055#TencentVod）内的MediaType设置。 示例值：0 |
| AvMerge | Integer | 否 | 单流录制模式下，用户的音视频是否合并，0：单流音视频不合并（默认）。1：单流音视频合并成一个ts。混流录制此参数无需设置，默认音视频合并。 示例值：0 |
| MaxMediaFileDuration | Integer | 否 | 如果是aac或者mp4文件格式，超过长度限制后，系统会自动拆分视频文件。单位：分钟。默认为1440min（24h），取值范围为1-1440。【单文件限制最大为2G，满足文件大小 >2G 或录制时长度 > 24h任意一个条件，文件都会自动切分】 Hls 格式录制此参数不生效。 示例值：1440 |
| MediaId | Integer | 否 | 指定录制主辅流，0：主流+辅流（默认）；1:主流；2:辅流。 示例值：0 |
RecordUsage
录制的使用信息。
被如下接口引用：DescribeRecordStatistic。
| 名称 | 类型 | 描述 |
|---|---|---|
| TimeKey | String | 本组数据对应的时间点，格式如:2020-09-07或2020-09-07 00:05:05。 |
| Class1VideoTime | Integer | 视频时长-标清SD，单位：秒。 |
| Class2VideoTime | Integer | 视频时长-高清HD，单位：秒。 |
| Class3VideoTime | Integer | 视频时长-超清HD，单位：秒。 |
| AudioTime | Integer | 语音时长，单位：秒。 |
RoomState
房间信息列表
被如下接口引用：DescribeRoomInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| CommId | String | 通话ID（唯一标识一次通话） |
| RoomString | String | 房间号 |
| CreateTime | Integer | 房间创建时间 |
| DestroyTime | Integer | 房间销毁时间 |
| IsFinished | Boolean | 房间是否已经结束 |
| UserId | String | 房间创建者Id |
RowValues
SeriesInfo类型的二维数组
被如下接口引用：DescribeTRTCMarketQualityData, DescribeTRTCMarketScaleData, DescribeTRTCRealTimeQualityData, DescribeTRTCRealTimeScaleData。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| RowValue | Array of Integer | 否 | 数据值 注意：此字段可能返回 null，表示取不到有效值。 示例值：[1659927600,399] |
ScaleInfomation
历史规模信息
被如下接口引用：DescribeScaleInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| Time | Integer | 每天开始的时间 |
| UserNumber | Integer | 房间人数，用户重复进入同一个房间为1次 注意：此字段可能返回 null，表示取不到有效值。 |
| UserCount | Integer | 房间人次，用户每次进入房间为一次 注意：此字段可能返回 null，表示取不到有效值。 |
| RoomNumbers | Integer | sdkappid下一天内的房间数 注意：此字段可能返回 null，表示取不到有效值。 |
SdkAppIdRecordUsage
SdkAppId级别录制时长数据。
被如下接口引用：DescribeRecordStatistic。
| 名称 | 类型 | 描述 |
|---|---|---|
| SdkAppId | String | SdkAppId的值。 |
| Usages | Array of RecordUsage | 统计的时间点数据。 |
SdkAppIdTrtcMcuTranscodeTimeUsage
查询旁路转码计费时长。
查询时间小于等于1天时，返回每5分钟粒度的数据；查询时间大于1天时，返回按天汇总的数据。
被如下接口引用：DescribeTrtcMcuTranscodeTime。
| 名称 | 类型 | 描述 |
|---|---|---|
| TimeKey | String | 本组数据对应的时间点，格式如：2020-09-07或2020-09-07 00:05:05。 示例值：2020-09-07 00:05:05 |
| AudioTime | Integer | 语音时长，单位：秒。 示例值：100 |
| VideoTimeSd | Integer | 视频时长-标清SD，单位：秒。 示例值：100 |
| VideoTimeHd | Integer | 视频时长-高清HD，单位：秒。 示例值：100 |
| VideoTimeFhd | Integer | 视频时长-全高清FHD，单位：秒。 示例值：100 |
| Flux | Float | 带宽，单位：Mbps。 示例值： 100.12 |
SeriesInfo
SeriesInfo类型
被如下接口引用：DescribeTRTCMarketQualityMetricData, DescribeTRTCMarketScaleMetricData, DescribeTRTCRealTimeQualityMetricData, DescribeTRTCRealTimeScaleMetricData。
| 名称 | 类型 | 描述 |
|---|---|---|
| Columns | Array of String | 数据列 注意：此字段可能返回 null，表示取不到有效值。 示例值：["time","count(queryCount)"] |
| Values | Array of Integer | 数据值 注意：此字段可能返回 null，表示取不到有效值。 示例值：[1659927600,399] |
SeriesInfos
SeriesInfos类型
被如下接口引用：DescribeTRTCMarketQualityData, DescribeTRTCMarketScaleData, DescribeTRTCRealTimeQualityData, DescribeTRTCRealTimeScaleData。
| 名称 | 类型 | 描述 |
|---|---|---|
| Columns | Array of String | 数据列 注意：此字段可能返回 null，表示取不到有效值。 示例值：["time","count(queryCount)"] |
| Values | Array of RowValues | 数据值 注意：此字段可能返回 null，表示取不到有效值。 示例值：1659927600,399] |
SingleSubscribeParams
单流旁路转推的用户上行信息。
被如下接口引用：StartPublishCdnStream, UpdatePublishCdnStream。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| UserMediaStream | UserMediaStream | 是 | 用户媒体流参数。 示例值：UserMediaStream |
SmallVideoLayoutParams
画中画模板中有效，代表小画面的布局参数
被如下接口引用：StartMCUMixTranscode, StartMCUMixTranscodeByStrRoomId。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| UserId | String | 是 | 代表小画面对应的用户ID。 示例值："small_video_user" |
| StreamType | Integer | 是 | 代表小画面对应的流类型，0为摄像头，1为屏幕分享。小画面为web用户时此值填0。 示例值：0 |
| ImageWidth | Integer | 否 | 小画面在输出时的宽度，单位为像素值，不填默认为0。 示例值：640 |
| ImageHeight | Integer | 否 | 小画面在输出时的高度，单位为像素值，不填默认为0。 示例值：480 |
| LocationX | Integer | 否 | 小画面在输出时的X偏移，单位为像素值，LocationX与ImageWidth之和不能超过混流输出的总宽度，不填默认为0。 示例值：0 |
| LocationY | Integer | 否 | 小画面在输出时的Y偏移，单位为像素值，LocationY与ImageHeight之和不能超过混流输出的总高度，不填默认为0。 示例值：0 |
StorageFile
云端录制查询接口，录制文件的信息
被如下接口引用：DescribeCloudRecording。
| 名称 | 类型 | 描述 |
|---|---|---|
| UserId | String | 录制文件对应的UserId，如果是混流的话的这里返回的是空串。 注意：此字段可能返回 null，表示取不到有效值。 示例值：123 |
| FileName | String | 录制索引文件名。 示例值：xxx.m3u8 |
| TrackType | String | 录制文件流信息。 video：视频录制文件 audio：音频录制文件 audio_video：音视频录制文件 注意：此字段可能返回 null，表示取不到有效值。 示例值：audio_video |
| BeginTimeStamp | Integer | 录制文件开始Unix时间戳。 示例值：1562724852626 |
StorageParams
录制存储参数
被如下接口引用：CreateCloudRecording, StartWebRecord。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| CloudStorage | CloudStorage | 否 | 腾讯云对象存储COS以及第三方云存储的账号信息 |
| CloudVod | CloudVod | 否 | 腾讯云云点播Vod的存储信息 |
SubscribeStreamUserIds
指定订阅流白名单或者黑名单，音频的白名单和音频黑名单不能同时设置，视频亦然。同时实际并发订阅的媒体流路数最大支持25路流，混流场景下视频的多画面最大支持24画面。支持通过设置".*$"通配符，来前缀匹配黑白名单的UserId，注意房间里不能有和通配符规则相同的用户，否则将视为订阅具体用户，前缀规则会失效。
被如下接口引用：CreateCloudRecording, ModifyCloudRecording。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SubscribeAudioUserIds | Array of String | 否 | 订阅音频流白名单，指定订阅哪几个UserId的音频流，例如["1", "2", "3"], 代表订阅UserId 1，2，3的音频流；["1.*$"], 代表订阅UserId前缀为1的音频流。默认不填订阅房间内所有的音频流，订阅列表用户数不超过32。 示例值：["123","456"] |
| UnSubscribeAudioUserIds | Array of String | 否 | 订阅音频流黑名单，指定不订阅哪几个UserId的音频流，例如["1", "2", "3"], 代表不订阅UserId 1，2，3的音频流；["1.*$"], 代表不订阅UserId前缀为1的音频流。默认不填订阅房间内所有音频流，订阅列表用户数不超过32。 示例值：["123","456"] |
| SubscribeVideoUserIds | Array of String | 否 | 订阅视频流白名单，指定订阅哪几个UserId的视频流，例如["1", "2", "3"], 代表订阅UserId 1，2，3的视频流；["1.*$"], 代表订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流，订阅列表用户数不超过32。 示例值：["123","456"] |
| UnSubscribeVideoUserIds | Array of String | 否 | 订阅视频流黑名单，指定不订阅哪几个UserId的视频流，例如["1", "2", "3"], 代表不订阅UserId 1，2，3的视频流；["1.*$"], 代表不订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流，订阅列表用户数不超过32。 示例值：["123","456"] |
TRTCDataResp
TRTC数据大盘/实时监控 API接口数据出参
被如下接口引用：DescribeTRTCMarketQualityMetricData, DescribeTRTCMarketScaleMetricData, DescribeTRTCRealTimeQualityMetricData, DescribeTRTCRealTimeScaleMetricData。
| 名称 | 类型 | 描述 |
|---|---|---|
| StatementID | Integer | StatementID值，监控仪表盘下固定为0。 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| Series | Array of SeriesInfo | 查询结果数据，以Columns-Values形式返回。 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| Total | Integer | Total值，监控仪表盘功能下固定为1。 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
TRTCDataResult
TRTC数据大盘/实时监控 API接口数据出参
被如下接口引用：DescribeTRTCMarketQualityData, DescribeTRTCMarketScaleData, DescribeTRTCRealTimeQualityData, DescribeTRTCRealTimeScaleData。
| 名称 | 类型 | 描述 |
|---|---|---|
| StatementID | Integer | StatementID值，监控仪表盘下固定为0。 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| Series | Array of SeriesInfos | 查询结果数据，以Columns-Values形式返回。 注意：此字段可能返回 null，表示取不到有效值。 |
| Total | Integer | Total值，监控仪表盘功能下固定为1。 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
TencentVod
腾讯云点播相关参数。
被如下接口引用：CreateCloudRecording, StartWebRecord。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Procedure | String | 否 | 媒体后续任务处理操作，即完成媒体上传后，可自动发起任务流操作。参数值为任务流模板名，云点播支持 创建任务流模板 并为模板命名。 示例值：xxx |
| ExpireTime | Integer | 否 | 媒体文件过期时间，为当前时间的绝对过期时间；保存一天，就填"86400"，永久保存就填"0"，默认永久保存。 示例值：86400 |
| StorageRegion | String | 否 | 指定上传园区，仅适用于对上传地域有特殊需求的用户。 示例值：ap-shanghai |
| ClassId | Integer | 否 | 分类ID，用于对媒体进行分类管理，可通过 创建分类 接口，创建分类，获得分类 ID。 默认值：0，表示其他分类。 示例值：0 |
| SubAppId | Integer | 否 | 点播 子应用 ID。如果要访问子应用中的资源，则将该字段填写为子应用 ID；否则无需填写该字段。 示例值：0 |
| SessionContext | String | 否 | 任务流上下文，任务完成回调时透传。 示例值：xxx |
| SourceContext | String | 否 | 上传上下文，上传完成回调时透传。 示例值：xxx |
| MediaType | Integer | 否 | 上传到vod平台的录制文件格式类型，0：mp4(默认), 1: hls, 2:aac(StreamType=1纯音频录制时有效), 3: hls+mp4, 4: hls+aac(StreamType=1纯音频录制时有效)。 示例值：1 |
| UserDefineRecordId | String | 否 | 仅支持API录制上传vod，该参数表示用户可以自定义录制文件名前缀，【限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线和连词符】。前缀与自动生成的录制文件名之间用__UserDefine_u_ 分开。示例值：xxx |
TimeValue
返回的质量数据，时间:值
被如下接口引用：DescribeCallDetailInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| Time | Integer | 时间，unix时间戳（1590065877s) |
| Value | Float | 当前时间返回参数取值，如（bigvCapFps在1590065877取值为0，则Value：0 ） |
TrtcUsage
实时音视频用量在某一时间段的统计信息。
被如下接口引用：DescribeMixTranscodingUsage, DescribeRecordingUsage, DescribeRelayUsage, DescribeTrtcUsage。
| 名称 | 类型 | 描述 |
|---|---|---|
| TimeKey | String | 时间点，格式为YYYY-MM-DD HH:mm:ss。多天查询时，HH:mm:ss为00:00:00。 |
| UsageValue | Array of Float | 用量数组。每个数值含义与UsageKey对应。单位：分钟。 |
UserInformation
用户信息，包括用户进房时间，退房时间等
被如下接口引用：DescribeCallDetailInfo, DescribeUserInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| RoomStr | String | 房间号 |
| UserId | String | 用户Id |
| JoinTs | Integer | 用户进房时间 |
| LeaveTs | Integer | 用户退房时间，用户没有退房则返回当前时间 |
| DeviceType | String | 终端类型 |
| SdkVersion | String | Sdk版本号 |
| ClientIp | String | 客户端IP地址 |
| Finished | Boolean | 判断用户是否已经离开房间 |
UserMediaStream
用户媒体流参数。
被如下接口引用：StartPublishCdnStream, UpdatePublishCdnStream。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| UserInfo | MixUserInfo | 否 | TRTC用户参数。 示例值：MixUserInfo |
| StreamType | Integer | 否 | 主辅路流类型，0为摄像头，1为屏幕分享，不填默认为0。 示例值：0 |
VideoEncode
视频编码参数。
被如下接口引用：StartPublishCdnStream, UpdatePublishCdnStream。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Width | Integer | 是 | 输出流宽，音视频输出时必填。取值范围[0,1920]，单位为像素值。 示例值：1280 |
| Height | Integer | 是 | 输出流高，音视频输出时必填。取值范围[0,1080]，单位为像素值。 示例值：720 |
| Fps | Integer | 是 | 输出流帧率，音视频输出时必填。取值范围[1,60]，表示混流的输出帧率可选范围为1到60fps。 示例值：15 |
| BitRate | Integer | 是 | 输出流码率，音视频输出时必填。取值范围[1,10000]，单位为kbps。 示例值：1500 |
| Gop | Integer | 是 | 输出流gop，音视频输出时必填。取值范围[1,5]，单位为秒。 示例值：2 |
VideoEncodeParams
视频转码参数
被如下接口引用：StartStreamIngest。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Width | Integer | 否 | 宽。取值范围[0,1920]，单位为像素值。 示例值：1280 |
| Height | Integer | 否 | 高。取值范围[0,1080]，单位为像素值。 示例值：720 |
| Fps | Integer | 否 | 帧率。取值范围[1,60]，表示帧率可选范围为1到60fps。 示例值：15 |
| BitRate | Integer | 否 | 码率。取值范围[1,10000]，单位为kbps。 示例值：1500 |
| Gop | Integer | 否 | gop。取值范围[1,2]，单位为秒。 示例值：2 |
VideoParams
录制视频转码参数。
被如下接口引用：CreateCloudRecording。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Width | Integer | 是 | 视频的宽度值，单位为像素，默认值360。不能超过1920，与height的乘积不能超过1920*1080。 示例值：360 |
| Height | Integer | 是 | 视频的高度值，单位为像素，默认值640。不能超过1920，与width的乘积不能超过1920*1080。 示例值：640 |
| Fps | Integer | 是 | 视频的帧率，范围[1, 60]，默认15。 示例值：15 |
| BitRate | Integer | 是 | 视频的码率,单位是bps，范围[64000, 8192000]，默认550000bps。 示例值：550000 |
| Gop | Integer | 是 | 视频关键帧时间间隔，单位秒，默认值10秒。 示例值：10 |
WaterMark
水印布局参数
被如下接口引用：CreateCloudRecording, ModifyCloudRecording。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| WaterMarkType | Integer | 否 | 水印类型，0为图片（默认），1为文字，2为时间戳。 示例值：0 |
| WaterMarkImage | WaterMarkImage | 否 | 水印为图片时的参数列表，水印为图片时校验必填。 |
| WaterMarkChar | WaterMarkChar | 否 | 水印为文字时的参数列表，水印为文字时校验必填。 |
| WaterMarkTimestamp | WaterMarkTimestamp | 否 | 水印为时间戳时的参数列表，水印为时间戳时校验必填。 |
WaterMarkChar
自定义文字水印数据结构
被如下接口引用：CreateCloudRecording, ModifyCloudRecording。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Top | Integer | 是 | 文字水印的起始坐标Y值，从左上角开始 示例值：0 |
| Left | Integer | 是 | 文字水印的起始坐标X值，从左上角开始 示例值：0 |
| Width | Integer | 是 | 文字水印的宽度，单位像素值 示例值：200 |
| Height | Integer | 是 | 文字水印的高度，单位像素值 示例值：100 |
| Chars | String | 是 | 水印文字的内容 示例值：李专家 |
| FontSize | Integer | 否 | 水印文字的大小，单位像素，默认14 示例值：14 |
| FontColor | String | 否 | 水印文字的颜色，默认白色 示例值：0xFFFFFF |
| BackGroundColor | String | 否 | 水印文字的背景色，为空代表背景透明，默认为空 示例值：0xbbccbb |
| Font | String | 否 | 文字水印的字体，支持设置以下值： 1. Tencent （默认） 2. SourceHanSans 示例值：Tencent |
WaterMarkImage
水印类型为图片的参数列表
被如下接口引用：CreateCloudRecording, ModifyCloudRecording。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| WaterMarkUrl | String | 是 | 下载的url地址， 只支持jpg， png，大小限制不超过5M。 示例值：https://xxxx |
| Top | Integer | 是 | 画布上该画面左上角的 y 轴坐标，取值范围 [0, 2560]，不能超过画布的高。 示例值：100 |
| Left | Integer | 是 | 画布上该画面左上角的 x 轴坐标，取值范围 [0, 2560]，不能超过画布的宽。 示例值：100 |
| Width | Integer | 是 | 画布上该画面宽度的相对值，取值范围 [0, 2560]，与Left相加不应超过画布的宽。 示例值：100 |
| Height | Integer | 是 | 画布上该画面高度的相对值，取值范围 [0, 2560]，与Top相加不应超过画布的高。 示例值：100 |
WaterMarkParams
MCU混流水印参数
被如下接口引用：StartMCUMixTranscode, StartMCUMixTranscodeByStrRoomId。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| WaterMarkId | Integer | 是 | 混流-水印图片ID。取值为实时音视频控制台上传的图片ID。 示例值：51 |
| WaterMarkWidth | Integer | 是 | 混流-水印宽。单位为像素值。水印宽+X偏移不能超过整个画布宽。 示例值：64 |
| WaterMarkHeight | Integer | 是 | 混流-水印高。单位为像素值。水印高+Y偏移不能超过整个画布高。 示例值：64 |
| LocationX | Integer | 是 | 水印在输出时的X偏移。单位为像素值。水印宽+X偏移不能超过整个画布宽。 示例值：10 |
| LocationY | Integer | 是 | 水印在输出时的Y偏移。单位为像素值。水印高+Y偏移不能超过整个画布高。 示例值：10 |
| WaterMarkUrl | String | 否 | 混流-水印图片URL地址，支持png、jpg、jpeg、bmp格式，暂不支持透明通道。URL链接长度限制为512字节。WaterMarkUrl和WaterMarkId参数都填时，以WaterMarkUrl为准。图片大小限制不超过2MB。 示例值：xxx |
WaterMarkTimestamp
时间戳水印数据结构
被如下接口引用：CreateCloudRecording, ModifyCloudRecording。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Pos | Integer | 是 | 时间戳的位置，取值范围0-6，分别代表上左，上右，下左，下右，上居中，下居中，居中 示例值：0 |
| TimeZone | Integer | 否 | 显示时间戳的时区，默认东八区 示例值：8 |
| Font | String | 否 | 文字水印的字体，支持设置以下值： 1. Tencent （默认） 2. SourceHanSans 示例值：Tencent |
WebRecordVideoParams
页面录制视频参数
被如下接口引用：StartWebRecord。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Width | Integer | 否 | 录制画面宽度，默认为1280，取值范围[0, 1920] 示例值：1280 |
| Height | Integer | 否 | 录制画面高度，默认为720，取值范围[0, 1080] 示例值：720 |
| Format | String | 否 | 指定输出格式，可选hls,mp4 示例值：mp4 |