文档中心
互动直播 (Legacy)
Console 官网 社区 技术支持
简体中文
search-icon

数据类型定义

更新时间 2023/03/13 03:15:08

本文介绍旁路推流 RESTful API 的相关数据类型定义。

audioOptions

Converter 的音频转码配置。

字段 类型 描述               
codecProfile String（可选） Converter 输出的音频编解码器。支持如下值：
  • LC-AAC（默认值）: MPEG-4 AAC LC。
  • HE-AAC: High-Efficiency AAC。
    		•
    sampleRate Number（可选） Converter 输出的音频编码采样率 (Hz)，可填 32000，44100 或 48000（默认值）。
    bitrate Number（可选） Converter 输出的音频编码码率 (Kbps)取值范围为 [32,128]。默认值为 48。如果音频编解码器为 LC-AAC，推荐音频编码码率取值范围为 [32, 112]。如果音频编解码器为 HE-AAC，推荐音频编码码率取值范围为 [40, 96]。
    audioChannels Number（可选） Converter 输出的音频声道数，可填 1（默认值） 或 2。
    rtcStreamUids JSON Array（可选） 参与混音的用户 UID 数组。
  • 默认值为频道内所有用户 UID，代表声网将频道内所有用户音频进行混音。
  • 如果数组为空，则不混合任何用户的音频流。
    		•
    volumes JSON Array（可选） 设置参与混音的用户音量。
  • 仅指定混音用户 UID （设置 rtcStreamUids）时该字段生效。
  • 你可以调用 Update 方法调整指定用户的音量，每一次 Update 请求成功会将本次指定用户以外的其他用户的音量恢复为默认值 100。
    		•
    volumes.rtcStreamUid Number 待设置音量的混音用户 UID。
    volumes.rtcStreamUid 需要存在于rtcStreamUids 数组中，否则请求失败，响应状态码为 400。
    volumes.volume Number 指定的混音用户的音量。默认值为 100，取值范围 [0, 200]。

    videoOptions

    Converter 的视频转码配置。

    canvas

    视频画布配置。

    字段 类型 描述               
    width Number（必填） 画布的宽度 (pixel)。取值范围为 [66,1920]。
    height Number（必填） 画布的高度 (pixel)。取值范围为 [66,1920]。
    color Number（可选） 画布的背景色。RGB 颜色值，以十进制数表示。如 255 代表蓝色。取值范围为 [0,16777215]。默认值为 0，即黑色。

    layout

    画布上视频画面的内容描述。

    layout.RtcStreamView

    用于配置画布上各用户的视频画面。

    字段 类型 描述               
    rtcStreamUid Number（必填） 视频流所属用户的 UID。
    region JSON Object（必填） 用户视频画面在画布上的显示区域。超出画布的视频画面会被裁剪，无法显示。
    region.xPos Number（必填） 画面在画布上的 x 坐标 (pixel)。以画布左上角为原点，x 坐标为画面左上角相对于原点的横向位移。
    region.yPos Number（必填） 画面在画布上的 y 坐标 (pixel)。以画布左上角为原点，y 坐标为画面左上角相对于原点的纵向位移。
    region.zIndex Number（必填） 画面的图层编号。取值范围为 [0,100]。0 代表最下层的图层。100 代表最上层的图层。
    region.width Number（必填） 画面的宽度 (pixel)。
    region.height Number（必填） 画面的高度 (pixel)。
    fillMode String（可选） 画面的显示方式。
  • （默认）fill：在保持长宽比的前提下，缩放画面，使画面充满容器。
  • fit：在保持长宽比的前提下，缩放画面，使得画面在容器内完整显示出来。
    • placeholderImageUrl String（必填） 用户画面的背景图 URL 地址。支持 JPG、PNG 和 GIF 格式的图片。当频道内用户停止发布视频流，如果设置了该字段，用户的视频画面将切换为该背景图，否则会显示为画布背景色。

    layout.ImageView

    配置画布上的视频图片，可用于当水印。

    字段 类型 描述               
    imageUrl String（必填） 图片的 HTTP(S) URL。支持 JPG 和 PNG 格式的图片。
    region JSON Object（必填） 图片在画布上的显示区域。超出画布的图片会被裁剪，无法显示。
    region.xPos Number（必填） 图片在画布上的 x 坐标 (pixel)。以画布左上角为原点，x 坐标为图片左上角相对于原点的横向位移。
    region.yPos Number（必填） 图片在画布上的 y 坐标 (pixel)。以画布左上角为原点，y 坐标为图片左上角相对于原点的纵向位移。
    region.zIndex Number（必填） 图片的图层编号。取值范围为 [0,100]。0 代表最下层的图层。100 代表最上层的图层。
    region.width Number（必填） 图片的宽度 (pixel)。
    region.height Number（必填） 图片的高度 (pixel)。
    fillMode（可选） String 图片的显示方式。
  • （默认）fill：在保持长宽比的前提下，缩放图片，使图片充满容器。
  • fit：在保持长宽比的前提下，缩放图片，使得图片在容器内完整显示出来。

    • vertical

    配置垂直布局的视频画面。

    字段 类型 描述               
    maxResolutionUid （可选）Number 显示大视窗画面的用户 UID。如果未设置 maxResolutionUid，则布局刷新时音量最大的用户显示为大视窗画面。
  • Converter 会 3 秒刷新一次画面布局，如需调整刷新时间间隔，请联系技术支持。
  • 未设置 maxResolutionUid 可能会导致画面布局每隔 3 秒变化一次，如果需要布局稳定不变，请设置该参数。
    		•
    fillMode （可选）String 用户画面的显示方式。
  • fill：在保持长宽比的前提下，缩放画面，使画面充满容器。
  • fit：在保持长宽比的前提下，缩放画面，使得画面在容器内完整显示出来。
    		•

    seiOptions

    设置输出视频中携带的用户 SEI 信息。

    字段 类型 描述               
    source JSON Object（可选） 设置 SEI 信息的数据来源。默认为空。
    source.metadata Bool（可选） 设置是否传入 metadata 类型的 SEI 信息。
  • true：传入 metadata 类型的 SEI 信息。
  • （默认）false：不传入 metadata 类型的 SEI 信息。
    		•
    source.datastream Bool（可选） 设置是否传入声网 DataStream 类型的 SEI 信息 。
  • true：传入声网 DataStream 类型的 SEI 信息。
  • （默认）false：不传入声网 DataStream 类型的 SEI 信息。
    		•
    source.customized JSON Object（可选） 自定义 SEI 信息。该 SEI 信息会被转换为声网 SEI 规范的 SEI 信息。默认为空。
    source.customized.prefixForAgoraSei String（可选） 设置 SEI 信息的 payload 前缀。长度必须在 32 个字符以内，默认为空。
    source.customized.payload String（可选） 设置 SEI 信息的 payload。长度必须在 4096 个字符以内，默认为空。SEI 信息被转换为声网 SEI 规范的 SEI 信息时，该 payload 会被传入到 SEI 的 app_data 中。
    sink JSON Object（可选） 设置输出 SEI 信息的属性。默认为空。
    sink.type Int（可选） 设置输出 SEI 信息的 payload type。默认为 100。