ZegoMixerTask class

混流任务对象

本类为混流任务的配置类,当向 ZEGO RTC 服务器发起混流任务的请求时,需要这个混流任务的配置。 本类即描述这次混流任务的详细配置信息。

Constructors

ZegoMixerTask(String taskID)
通过 TaskID 构造一个混流任务对象

Properties

advancedConfig ↔ Map<String, String>
设置高级配置,如可用于指定视频编码等功能。如需使用,联系 ZEGO 技术支持。在 web 平台上,此属性不生效。
read / write
audioConfig ZegoMixerAudioConfig
混流任务的音频配置
read / write
backgroundColor ↔ int
混流背景色,颜色值对应 RGBA 为 0xRRGGBBAA,目前不支持设置背景色的透明度,0xRRGGBBAA 中的 AA 为 00 即可。例如:选取 RGB 为 #87CEFA 作为背景色,此参数传 0x87CEFA00。
read / write
backgroundImageURL ↔ String
混流任务的背景图 URL
read / write
enableSoundLevel ↔ bool
是否开启混流的声浪回调通知,开启后拉混流时可通过 onMixerSoundLevelUpdate 回调收到每条单流的声浪信息。在 web 平台上,此属性不生效。
read / write
hashCode → int
The hash code for this object.
read-onlyinherited
inputList ↔ List<ZegoMixerInput>
混流任务的输入流列表
read / write
minPlayStreamBufferLength ↔ int
详情描述:设置混流服务器拉流缓存自适应调整的区间范围下限。在实时合唱 KTV 场景下,推流端网络轻微波动可能会导致混流的卡顿,此时观众拉混流的时候,会有比较高概率出现卡顿的问题。通过调节混流服务器拉流缓存自适应调整的区间范围下限,可优化观众端拉混流出现的卡顿问题,但会增大延迟。默认不设置,即服务端使用自身配置值。只会对新的输入流设置生效,对于已经开始混流的输入流不生效。取值范围:0,10000,超过最大值混流会失败。在 web 平台,此属性不生效。
read / write
outputList ↔ List<ZegoMixerOutput>
混流任务的输出流列表
read / write
runtimeType → Type
A representation of the runtime type of the object.
read-onlyinherited
streamAlignmentMode ZegoStreamAlignmentMode
混流对齐模式。在 web 平台上,此属性不生效。
read / write
taskID ↔ String
混流任务 ID
read / write
userData ↔ Uint8List
用户自定义数据,长度不超过 1000 字节,设置后拉流方可通过监听 onPlayerRecvSEI 的回调获取 SEI 内容。
read / write
videoConfig ZegoMixerVideoConfig
混流任务的视频配置
read / write
watermark ZegoWatermark
混流任务的水印
read / write
whiteboard ZegoMixerWhiteboard
混流输入白板信息。在 web 平台上,此属性不生效。
read / write

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited