ZegoMixerTask

Mix stream task object.

Details

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.

Declared in entity/ZegoMixerTask.java

Properties

taskID

private String taskID

Mix stream task ID

audioConfig

public ZegoMixerAudioConfig audioConfig

Mix stream audio config

videoConfig

public ZegoMixerVideoConfig videoConfig

Mix stream audio config

inputList

public ArrayList<ZegoMixerInput> inputList

Mix stream task input list

outputList

public ArrayList<ZegoMixerOutput> outputList

Mix stream task output list

watermark

public ZegoWatermark watermark

Mix stream wate rmark

whiteboard

public ZegoMixerWhiteboard whiteboard

Mix stream whiteboard

backgroundColor

public int backgroundColor

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.

backgroundImageURL

public String backgroundImageURL

Mix stream background image URL

soundLevel

public boolean soundLevel

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.

streamAlignmentMode

private ZegoStreamAlignmentMode streamAlignmentMode

The stream mixing alignment mode

userData

public ByteBuffer userData

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]. it must be created using the [ByteBuffer. Allocatedirect] function, otherwise the data cannot be transferred to the SDK.

userDataLength

public int userDataLength

User data length, not greater than 1000. that only data with length will be read by SDK. If the length is greater than the actual length of data, the SDK will read the data according to the actual length of data.

advancedConfig

public HashMap<String, String> advancedConfig

Set advanced configuration, such as specifying video encoding and others. If you need to use it, contact ZEGO technical support.

minPlayStreamBufferLength

public int minPlayStreamBufferLength

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.

mixImageCheckMode

public ZegoMixImageCheckMode mixImageCheckMode

Set the mixed stream image check mode.

Methods

ZegoMixerTask

public ZegoMixerTask(String taskID)

Create a mix stream task object with TaskID

Declared in entity/ZegoMixerTask.java

getTaskID

public void String getTaskID()

Get current TaskID

Declared in entity/ZegoMixerTask.java

setInputList

public void setInputList(ArrayList<ZegoMixerInput> inputList)

Set the input stream list for the mix stream task object

Declared in entity/ZegoMixerTask.java

setOutputList

public void setOutputList(ArrayList<ZegoMixerOutput> outputList)

Set the output list of the mix stream task object

Declared in entity/ZegoMixerTask.java

setAudioConfig

public void setAudioConfig(ZegoMixerAudioConfig config)

Set the audio configuration of the mix stream task object

Declared in entity/ZegoMixerTask.java

setVideoConfig

public void setVideoConfig(ZegoMixerVideoConfig config)

Set the video configuration of the mix stream task object

Declared in entity/ZegoMixerTask.java

setBackgroundColor

public void setBackgroundColor(int backgroundColor)

Set the background color of the mix stream task object

Declared in entity/ZegoMixerTask.java

setBackgroundImageURL

public void setBackgroundImageURL(String backgroundImageURL)

Set the background image of the mix stream task object

Declared in entity/ZegoMixerTask.java

setWatermark

public void setWatermark(ZegoWatermark watermark)

Set the watermark of the mix stream task object

Declared in entity/ZegoMixerTask.java

setWhiteboard

public void setWhiteboard(ZegoMixerWhiteboard whiteboard)

Set the whiteboard of the mix stream task object

Declared in entity/ZegoMixerTask.java

enableSoundLevel

public void enableSoundLevel(boolean enable)

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.

Declared in entity/ZegoMixerTask.java

setStreamAlignmentMode

public void setStreamAlignmentMode(ZegoStreamAlignmentMode mode)

Setting the stream mixing alignment mode

Declared in entity/ZegoMixerTask.java

setUserData

public void setUserData(ByteBuffer data, int length)

Set custom user data.

Declared in entity/ZegoMixerTask.java

setAdvancedConfig

public void setAdvancedConfig(HashMap<String, String> advancedConfig)

Set advanced configuration, such as specifying video encoding and others. If you need to use it, contact ZEGO technical support.

Declared in entity/ZegoMixerTask.java

setMinPlayStreamBufferLength

public void setMinPlayStreamBufferLength(int minPlayStreamBufferLength)

Sets the jitter buffer length for the mux server to pull the input stream.

Declared in entity/ZegoMixerTask.java

setMixImageCheckMode

public void setMixImageCheckMode(ZegoMixImageCheckMode mixImageCheckMode)

Set the mixed stream image check mode.

Declared in entity/ZegoMixerTask.java