ZegoAutoMixerTask class

自动混流任务对象

详情描述：调用 StartAutoMixerTask 函数向 ZEGO RTC 服务器发起自动混流任务时，需要通过该参数配置自动混流任务，包括任务 ID、房间 ID、音频配置、输出流列表、是否开启声浪回调通知。 业务场景：当向 ZEGO RTC 服务器发起自动混流任务时，需要这个配置。 注意事项：作为调用 StartAutoMixerTask 函数时传入的参数。

Constructors

ZegoAutoMixerTask()
构造一个自动混流任务对象

Properties

audioConfig ↔ ZegoMixerAudioConfig
自动混流任务的音频配置。详情描述：自动混流任务的音频配置，可配置音频码率、音频声道，编码 ID、多路音频流混音模式。业务场景：如果对自动混流任务的音频有特殊需求，比如需要调整音频码率，可根据需要调整该参数，否则不用配置。是否必填：否。默认值：默认音频码率为 "48 kbps", 默认音频声道为 "ZEGO_AUDIO_CHANNEL_MONO", 默认编码 ID 为 "ZEGO_AUDIO_CODEC_ID_DEFAULT"，默认多路音频流混音模式为 "ZEGO_AUDIO_MIX_MODE_RAW"。建议值：根据需求设置。
getter/setter pair
enableSoundLevel ↔ bool
是否开启自动混流的声浪回调通知，开启后拉混流时可通过 onAutoMixerSoundLevelUpdate 回调收到每条单流的声浪信息。详情描述：是否开启自动混流的声浪回调通知，开启后拉混流时可通过 onAutoMixerSoundLevelUpdate 回调收到每条单流的声浪信息。业务场景：当发起自动混流任务时，如果需要回调流的声浪信息，需要配置该参数。是否必填：否。默认值："false"。建议值：根据需求设置。
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
minPlayStreamBufferLength ↔ int
详情描述：设置混流服务器拉流缓存自适应调整的区间范围下限。在实时合唱 KTV 场景下，推流端网络轻微波动可能会导致混流的卡顿，此时观众拉混流的时候，会有比较高概率出现卡顿的问题。通过调节混流服务器拉流缓存自适应调整的区间范围下限，可优化观众端拉混流出现的卡顿问题，但会增大延迟。默认不设置，即服务端使用自身配置值。只会对新的输入流设置生效，对于已经开始混流的输入流不生效。取值范围：0,10000，超过最大值混流会失败。在 web 平台，此属性不生效。
getter/setter pair
outputList ↔ List<ZegoMixerOutput>
自动混流任务的输出流列表。详情描述：自动混流任务的输出流列表，列表中为 URL 或者流 ID，若为 URL 格式 目前只支持 RTMP URL 格式：rtmp://xxxxxxxx。业务场景：当发起自动混流任务时，需要配置该参数指明混流输出目标。Mix stream output target是否必填：是。
getter/setter pair
roomID ↔ String
自动混流任务的房间 ID。详情描述：自动混流任务的房间 ID。业务场景：当发起自动混流任务时，需要配置该参数。是否必填：是。建议值：根据需求设置。取值范围：长度不超过 128 字节的字符串。注意事项：仅支持数字，英文字符 和 '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', '\'。如果需要与 Web SDK 互通，请不要使用 '%'。
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
streamAlignmentMode ↔ ZegoStreamAlignmentMode
混流对齐模式。
getter/setter pair
taskID ↔ String
自动混流任务的任务 ID。详情描述：自动混流任务 ID，一个房间内需要保证混流任务 ID 的唯一性。业务场景：当发起自动混流任务时，需要配置该参数。是否必填：是。建议值：根据需求设置。取值范围：长度不超过 256 字节的字符串。注意事项：一个房间内只能存在一个混流任务 ID，即保证混流任务 ID 的唯一性，建议混流任务 ID 与房间 ID 关联，可直接使用房间 ID 作为混流任务 ID。不可以包含 URL 关键字，例如 'http', '?' 等，否则推拉流会失败。仅支持数字，英文字符 和 '~', '!', '@', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', '/', '\'。
getter/setter pair

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