Documentation

Global

Type Definitions

DeviceInfo

设备详情

Type:
  • Object
Properties:
Name Type Description
deviceId string

该设备所独有的设备 ID（Chrome 81 及以后版本在获取媒体设备权限后才能获得设备 ID）
label string

能够区分设备的设备名字，例如"外接 USB 网络摄像头"（出于系统安全考虑，如果用户没有打开媒体设备的权限，该属性会被设为空）

NERtcImageWatermarkConfig

图片水印设置参数，可通过Stream#setCanvasWatermarkConfigs使用

Type:
  • Object
Properties:
Name Type Argument Description
imageUrls Array.<String>

水印图片URL，支持多张轮播
offsetX number <optional>

水印框左上角与视频画布左上角的水平距离。单位为像素（pixel），默认值为 0
offsetY number <optional>

水印框左上角与视频画布左上角的垂直距离。单位为像素（pixel），默认值为 0。
wmColor number <optional>

水印框颜色。默认灰色（支持透明度），格式为ARGB，例如0x08080808。
wmWidth number <optional>

水印框的宽度。单位为像素（pixel），默认值为 0 表示没有水印框
wmHeight number <optional>

水印框的高度。单位为像素（pixel），默认值为 0 表示没有水印框
fps number <optional>

播放帧率。默认 0 帧
loop number <optional>

是否设置循环。默认循环，设置为false后水印数组播放完毕后消失

NERtcTextWatermarkConfig

文字水印设置参数，可通过Stream#setCanvasWatermarkConfigs使用

Type:
  • Object
Properties:
Name Type Argument Description
content string

支持自动换行。当文字内容长度超过水印框宽度时，会自动换行。
字符串长度没有限制。最终显示受字体大小和水印框大小的影响，超出水印框的部分不显示
fontSize number <optional>

字体大小。默认值为 10，相当于 144 dpi 设备上的 10 x 15 磅
fontColor number <optional>

字体颜色。默认白色
offsetX number <optional>

水印框左上角与视频画布左上角的水平距离。单位为像素（pixel），默认值为 0
offsetY number <optional>

水印框左上角与视频画布左上角的垂直距离。单位为像素（pixel），默认值为 0。
wmColor number <optional>

水印框颜色。默认灰色（支持透明度），格式为ARGB，例如0x08080808。
wmWidth number <optional>

水印框的宽度。单位为像素（pixel），默认值为 0 表示没有水印框
wmHeight number <optional>

水印框的高度。单位为像素（pixel），默认值为 0 表示没有水印框

NERtcTimestampWatermarkConfig

时间戳水印，可通过Stream#setCanvasWatermarkConfigs使用，格式为 yyyy-MM-dd HH:mm:ss

Type:
  • Object
Properties:
Name Type Argument Description
fontSize number <optional>

字体大小。默认值为 10，相当于 144 dpi 设备上的 10 x 15 磅
fontColor number <optional>

字体颜色。默认白色
offsetX number <optional>

水印框左上角与视频画布左上角的水平距离。单位为像素（pixel），默认值为 0
offsetY number <optional>

水印框左上角与视频画布左上角的垂直距离。单位为像素（pixel），默认值为 0。
wmColor number <optional>

水印框颜色。默认灰色（支持透明度），格式为ARGB，例如0x08080808。
wmWidth number <optional>

水印框的宽度。单位为像素（pixel），默认值为 0 表示没有水印框
wmHeight number <optional>

水印框的高度。单位为像素（pixel），默认值为 0 表示没有水印框

RTMPTask

一个推流任务

Type:
  • Object
Properties:
Name Type Argument Description
taskId string

自定义的推流任务ID。请保证此ID唯一。字母数字下划线组成的64位以内的字符串
streamUrl string

流地址，例如rtmp://test.url。此处的推流地址可设置为网易云信直播产品中服务端API创建频道的返回参数pushUrl。
record boolean <optional>

旁路推流是否需要进行音视频录制。
layout object <optional>

互动直播中的布局相关参数。详细参数说明请参考layout。布局参数的配置方式及典型配置示例请参考旁路推流画面布局。

Properties
Name Type Description
canvas object

用于设置混流视频的整体画布属性。

Properties
Name Type Argument Description
width number

整体画布的宽度，单位为 px。取值范围为 0~1920，若设置为奇数值，会自动向下取偶。
height number

整体画布的宽度，单位为 px。取值范围为 0~1920，若设置为奇数值，会自动向下取偶。
color number <optional>

画面背景颜色，格式为 256 ✖ 256 ✖ R + 256 ✖ G + B的和。请将对应 RGB 的值分别带入此公式计算即可。若未设置，则默认为0。
users[] object <optional>

用于设置混流视频中每个参与者对应的画面属性。

Properties
Name Type Argument Description
uid number

将指定uid对应用户的视频流拉入直播。如果添加多个 users，则 uid 不能重复。
x number

通过 x 和 y 指定画布坐标中的一个点，该点将作为用户图像的左上角。x 参数用于设置画布的横轴坐标值。取值范围为 0~1920，若设置为奇数值，会自动向下取偶。
y number

通过 x 和 y 指定画布坐标中的一个点，该点将作为用户图像的左上角。y 参数用于设置画布的纵轴坐标值。取值范围为 0~1920，若设置为奇数值，会自动向下取偶。
width number

该用户图像在画布中的宽度。取值范围为 0~1920，若设置为奇数值，会自动向下取偶。
height number

该用户图像在画布中的高度。取值范围为 0~1920，若设置为奇数值，会自动向下取偶。
adaption number <optional>

用于设置占位图片和指定区域的适应属性。可设置为：

  • 0：适应图片。即保证视频内容全部显示，未覆盖区域默认填充背景色
  • 1：适应区域。即保证所有区域被填满，视频超出部分会被裁剪。

若未设置，则默认为1。
pushAudio boolean <optional>

是否在直播中混流该用户的对应音频流。可设置为：

  • true：在直播中混流该用户的对应音频流。
  • false：在直播中将该用户设置为静音。

若未设置，默认为 true。
pushVideo boolean <optional>

是否在直播中向观看者播放该用户的对应视频流。可设置为：

  • true：在直播中播放该用户的视频流。
  • false：在直播中不播放该用户的视频流。

若未设置，则默认为 true。
images[] Object <optional>

用于设置混流视频中占位图片属性。若参数 users 指定的用户未上线，会在其对应的区域展示占位图片。

Properties
Name Type Description
url string

占位图片的URL。
x number

通过 x 和 y 指定画布坐标中的一个点，该点将作为占位图片的左上角。x 参数用于设置画布的横轴坐标值。取值范围为 0~1920，若设置为奇数值，会自动向下取偶。
y number

通过 x 和 y 指定画布坐标中的一个点，该点将作为占位图片的左上角。y 参数用于设置画布的纵轴坐标值。取值范围为 0~1920，若设置为奇数值，会自动向下取偶。
width number

该占位图片在画布中的宽度。取值范围为 0~1920，若设置为奇数值，会自动向下取偶。
height number

该占位图片在画布中的高度。取值范围为 0~1920，若设置为奇数值，会自动向下取偶。
adaption number

用于设置占位图片和指定区域的适应属性。可设置为：

  • 0：适应图片。即保证视频内容全部显示，未覆盖区域默认填充背景色
  • 1：适应区域。即保证所有区域被填满，视频超出部分会被裁剪。

若未设置，则默认为 1。
config object <optional>

其他设置

Properties
Name Type Argument Description
singleVideoNoTrans boolean <optional>

单视频直推不转码。开启后推流服务器会透传用户的视频编码，不再对视频做转码。
audioParam object <optional>

音频参数

Properties
Name Type Argument Description
bitRate number <optional>

自定义音频比特率。取值范围为 10～192。语音场景建议64以上，音乐场景建议128。