ZegoMixerTask class

Mix stream task object.

This class is the configuration class of the stream mixing task. When a stream mixing task is requested to the ZEGO RTC server, the configuration of the stream mixing task is required. This class describes the detailed configuration information of this stream mixing task.

Constructors

ZegoMixerTask(String taskID)
Create a mix stream task object with TaskID

Properties

advancedConfig ↔ Map<String, String>
Set advanced configuration, such as specifying video encoding and others. If you need to use it, contact ZEGO technical support. On web platforms, this property does not take effect.
getter/setter pair
audioConfig ↔ ZegoMixerAudioConfig
The audio config of the task
getter/setter pair
backgroundColor ↔ int
Mix stream background color, The color value corresponding to RGBA is 0xRRGGBBAA, and setting the transparency of the background color is currently not supported. The AA in 0xRRGGBBAA is 00. For example, select RGB as #87CEFA as the background color, this parameter passes 0x87CEFA00.
getter/setter pair
backgroundImageURL ↔ String
The background image URL of the task
getter/setter pair
enableSoundLevel ↔ bool
Enable or disable sound level callback for the task. If enabled, then the remote player can get the soundLevel of every stream in the inputlist by onMixerSoundLevelUpdate callback. On web platforms, this property does not take effect.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
inputList ↔ List<ZegoMixerInput>
The input list of the task
getter/setter pair
minPlayStreamBufferLength ↔ int
Description: Sets the lower limit of the interval range for the adaptive adjustment of the stream playing cache of the stream mixing server. In the real-time chorus KTV scenario, slight fluctuations in the network at the push end may cause the mixed stream to freeze. At this time, when the audience pulls the mixed stream, there is a high probability of the problem of freeze. By adjusting the lower limit of the interval range for the adaptive adjustment of the stream playing cache of the stream mixing server, it can optimize the freezing problem that occurs when playing mixing streams at the player end, but it will increase the delay. It is not set by default, that is, the server uses its own configuration values. It only takes effect for the new input stream setting, and does not take effect for the input stream that has already started mixing.Value Range: 0,10000, exceeding the maximum value will result in a failure of the stream mixing request. On web platforms, this property does not take effect.
getter/setter pair
mixImageCheckMode ↔ ZegoMixImageCheckMode
Set the mixed stream image check mode.
getter/setter pair
outputList ↔ List<ZegoMixerOutput>
The output list of the task
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
streamAlignmentMode ↔ ZegoStreamAlignmentMode
The stream mixing alignment mode. On web platforms, this property does not take effect.
getter/setter pair
taskID ↔ String
The task ID of the task
getter/setter pair
userData ↔ Uint8List
User data, the length of user data should not be more than 1000 bytes,After setting, the streaming party can obtain the SEI content by listening to the callback of onPlayerRecvSEI.
getter/setter pair
videoConfig ↔ ZegoMixerVideoConfig
The audio config of the task
getter/setter pair
watermark ↔ ZegoWatermark
The watermark of the task
getter/setter pair
whiteboard ↔ ZegoMixerWhiteboard
Mix stream whiteboard. On web platforms, this property does not take effect.
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