Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ZegoMixerTask

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.

Hierarchy

  • ZegoMixerTask

Index

Properties

advancedConfig

advancedConfig: {}

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

Type declaration

  • [key: string]: string

audioConfig

The audio configuration of the mix stream task object

backgroundImageURL

backgroundImageURL: string

The background image of the mix stream task object

enableSoundLevel

enableSoundLevel: boolean

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.

inputList

inputList: ZegoMixerInput[]

The input stream list for the mix stream task object

outputList

outputList: ZegoMixerOutput[]

The output list of the mix stream task object

taskID

taskID: string

Mix stream task ID, a string of up to 256 characters. You cannot include URL keywords, otherwise publishing stream and playing stream will fails. Only support numbers, English characters and '~', '!', '@', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', '/', ''.

videoConfig

The video configuration of the mix stream task object

watermark

watermark: ZegoWatermark

The watermark of the mix stream task object

Generated using TypeDoc