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 ZegoExpressDefines.h

Properties

taskID

nonatomic, copy, readonly NSString * taskID

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 '~', '!', '@', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', ''.

Methods

new

+ (instancetype)new NS_UNAVAILABLE;

This function is unavaialble

Declared in ZegoExpressDefines.h

Please use [initWithTaskID:] instead

init

- (instancetype)init NS_UNAVAILABLE;

This function is unavaialble

Declared in ZegoExpressDefines.h

Please use [initWithTaskID:] instead

initWithTaskID

- (instancetype)initWithTaskID:(NSString *)taskID;

Create a mix stream task object with TaskID

Declared in ZegoExpressDefines.h

ZegoMixerTask instance

setAudioConfig

- (void)setAudioConfig:(ZegoMixerAudioConfig *)audioConfig;

Set the audio configuration of the mix stream task object

Declared in ZegoExpressDefines.h

setVideoConfig

- (void)setVideoConfig:(ZegoMixerVideoConfig *)videoConfig;

Set the video configuration of the mix stream task object

Declared in ZegoExpressDefines.h

setInputList

- (void)setInputList:(NSArray<ZegoMixerInput *> *)inputList;

Set the input stream list for the mix stream task object

Declared in ZegoExpressDefines.h

setOutputList

- (void)setOutputList:(NSArray<ZegoMixerOutput *> *)outputList;

Set the output list of the mix stream task object

Declared in ZegoExpressDefines.h

setWatermark

- (void)setWatermark:(ZegoWatermark *)watermark;

Set the watermark of the mix stream task object

Declared in ZegoExpressDefines.h

setWhiteboard

- (void)setWhiteboard:(ZegoMixerWhiteboard *)whiteboard;

Set the whiteboard of the mix stream task object

Declared in ZegoExpressDefines.h

setBackgroundColor

- (void)setBackgroundColor:(int)backgroundColor;

Set the background color of the mix stream task object, 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.

Declared in ZegoExpressDefines.h

setBackgroundImageURL

- (void)setBackgroundImageURL:(NSString *)backgroundImageURL;

Set the background image of the mix stream task object

Declared in ZegoExpressDefines.h

enableSoundLevel

- (void)enableSoundLevel:(BOOL)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 ZegoExpressDefines.h

setStreamAlignmentMode

- (void)setStreamAlignmentMode:(ZegoStreamAlignmentMode)mode;

Setting the stream mixing alignment mode

Declared in ZegoExpressDefines.h

setUserData:length

- (void)setUserData:(NSData *)data length:(int)length;

Set custom user data, the length is no more than 1000.Note 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.

Declared in ZegoExpressDefines.h

setAdvancedConfig

- (void)setAdvancedConfig:(NSDictionary<NSString *, NSString *> *)config;

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

Declared in ZegoExpressDefines.h

setMinPlayStreamBufferLength

- (void)setMinPlayStreamBufferLength:(int)minPlayStreamBufferLength;

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.

Declared in ZegoExpressDefines.h

setMixImageCheckMode

- (void)setMixImageCheckMode:(ZegoMixImageCheckMode)mixImageCheckMode;

Set the mixed stream image check mode.

Declared in ZegoExpressDefines.h