文档反馈
文档反馈
互动直播2.0 > 服务端 API > 数据结构

数据结构

重要通知

网易云信新版文档中心现已正式上线！

音视频通话2.0、互动直播2.0、多人语音聊天室、PK 直播等产品和场景方案已迁移至新版文档中心维护，欢迎体验！

members

音视频房间中的在线用户信息列表。

被以下接口引用：查看房间内成员信息。

名称 类型 是否必选 示例 描述
uid 是 193992653091841 房间中在线成员的用户 ID。
starttime int64 是 1513145926 该成员加入房间的时间。UTC 时间戳格式。

layout

旁路推流画面布局设置。配置示例请参考旁路推流画面布局。

被以下接口引用：

参数名称 类型 是否必选 示例值 描述
canvas - JSON 数组 必选 - 用于设置混流视频的整体画布属性。
height Integer 必选 640 整体画布的高度，单位为 px。
取值范围为 0~1920，若设置为奇数值，会自动向下取偶。
width Integer 必选 0 整体画布的宽度，单位为 px。
取值范围为 0~1920，若设置为奇数值，会自动向下取偶。
color Integer 可选 0 画面背景颜色，格式为 256 ✖ 256 ✖ R + 256 ✖ G + B的和。
请将对应 RGB 的值分别带入此公式计算即可。若未设置，则默认为0。
users - JSON数组 必选 - 用于设置混流视频中每个参与者对应的画面属性。
注意：
  • 用户窗口边界不能超出 canvas 画布。
  • 视频互动中最多添加 7 人，纯语音互动中最多添加 21 人。如果人数超限，可能会造成服务故障。
uid Integer 必选 1111 将指定uid对应用户的视频流拉入直播。
如果添加多个 users，则 uid 不能重复。
x Integer 必选 0 通过 x 和 y 指定画布坐标中的一个点，该点将作为用户图像的左上角。
x 参数用于设置画布的横轴坐标值。
取值范围为 0~1920，若设置为奇数值，会自动向下取偶。
y Integer 必选 0 通过 x 和 y 指定画布坐标中的一个点，该点将作为用户图像的左上角。
x参数用于设置画布的纵轴坐标值。
取值范围为 0~1920，若设置为奇数值，会自动向下取偶。
width Integer 必选 360 该用户图像在画布中的宽度。
取值范围为 0~1920，若设置为奇数值，会自动向下取偶。
zOrder Integer 可选 1 直播视频上用户视频帧的图层编号。取值范围为 0~100，默认为 0。
最小值为 0（默认值），表示该区域图像位于最下层。
最大值为 100，表示该区域图像位于最上层。
height Integer 必选 360 该用户图像在画布中的高度。
取值范围为 0~1920，若设置为奇数值，会自动向下取偶。
adaption Integer 可选 1 用于设置占位图片和指定区域的适应属性。可设置为：
  • 0：适应图片。即保证视频内容全部显示，未覆盖区域默认填充背景色
  • 1：适应区域。即保证所有区域被填满，视频超出部分会被裁剪。
若未设置，则默认为1。
pushAudio Boolean 可选 true 是否在直播中混流该用户的对应音频流。可设置为：
  • true：在直播中混流该用户的对应音频流。
  • false：在直播中将该用户设置为静音。
若未设置，默认为 true。
pushVideo Boolean 可选 true 是否在直播中向观看者播放该用户的对应视频流。可设置为：
  • true：在直播中播放该用户的视频流。
  • false：在直播中不播放该用户的视频流。
若未设置，则默认为 true。
images - JSON数组 必选 - 用于设置混流视频中占位图片属性。
若参数 users 指定的用户未上线，会在其对应的区域展示占位图片。
url String 必选 www.163.com/test.jpg 占位图片的URL。
x Integer 必选 360 通过 x 和 y 指定画布坐标中的一个点，该点将作为占位图片的左上角。
x 参数用于设置画布的横轴坐标值。
取值范围为 0~1920，若设置为奇数值，会自动向下取偶。
y Integer 必选 0 通过 x 和 y 指定画布坐标中的一个点，该点将作为占位图片的左上角。
x 参数用于设置画布的纵轴坐标值。
取值范围为 0~1920，若设置为奇数值，会自动向下取偶。
width Integer 必选 360 该占位图片在画布中的宽度。
取值范围为 0~1920，若设置为奇数值，会自动向下取偶。
height Integer 必选 640 该占位图片在画布中的高度。
取值范围为 0~1920，若设置为奇数值，会自动向下取偶。
adaption Integer 可选 1 用于设置占位图片和指定区域的适应属性。可设置为：
  • 0：适应图片。即保证视频内容全部显示，未覆盖区域默认填充背景色
  • 1：适应区域。即保证所有区域被填满，视频超出部分会被裁剪。
若未设置，则默认为 1。

rtmpTasks

推流任务详情。

被以下接口引用：

参数名称 类型 示例 描述
taskId String stream_1 自定义的推流任务 ID。请保证此ID唯一。
streamUrl String rtmp://test.url 推流地址，例如 rtmp://test.url。
此处的推流地址可设置为网易云信直播产品中服务端API创建频道的返回参数 pushUrl。
layout Json - 互动直播中的布局相关参数。
参数详情请参考 layout。布局参数的配置方式及典型配置示例请参考旁路推流画面布局。
record Boolean true 旁路推流是否需要进行音视频录制。
version Integer 1 推流任务版本，此处请设置为 1。
hostuid Integer 111 主播的 UID。
config JSON - 音视频流配置。详细参数说明请参考config。
extraInfo String abc 自定义的媒体补充增强信息。

config

旁路推流时的音视频流配置。

被以下接口引用：

参数名称 类型 类型 示例 描述
singleVideoNoTrans Boolean Boolean true 单路视频透传开关，可选。默认为关闭状态。
开启后，如果房间中只有一路视频流输入，则不对输入视频流进行转码，不遵循转码布局，直接推流 CDN。
audioParam - - - 音频编码参数。
bitRate Number 128 音频推流码率，可选。单位为 kbps，取值范围为 10~192。
语音场景建议设置为 64 及以上码率，音乐场景建议设置为 128 及以上码率。
sampleRate Number 3200 音频推流采样率。单位为Hz，可设置为：
  • 32000：采样率为 32 kHz。
  • 44100：采样率为 44.1 kHz。
  • （默认）48000：采样率为 48 kHz。
    channels Number 1 音频推流声道数。
    • 1：单声道。
    • 2：（默认）双声道。
      codecProfile Number 1 音频编码规格。
      • 0：（默认）LC-AAC 规格，表示基本音频编码规格。
      • 1：HE-AAC 规格，表示高效音频编码规格。

        相关文档

        相关产品

        ×

        反馈成功

        非常感谢您的反馈，我们会继续努力做得更好。
        确定