ZegoMixerTask

混流任务对象

详情

本类为混流任务的配置类，当向 ZEGO RTC 服务器发起混流任务的请求时，需要这个混流任务的配置。本类即描述这次混流任务的详细配置信息。

Declared in ZegoExpressDefines.h

属性

taskID

nonatomic, copy, readonly NSString * taskID

混流任务 ID，长度不超过256的字符串。不可以包含 URL 关键字，否则推拉流失败。仅支持数字，英文字符和 '~', '!', '@', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', '\'。

方法

new

+ (instancetype)new NS_UNAVAILABLE;

此函数不可用

Declared in ZegoExpressDefines.h

请使用 [initWithTaskID:]

init

- (instancetype)init NS_UNAVAILABLE;

此函数不可用

Declared in ZegoExpressDefines.h

请使用 [initWithTaskID:]

initWithTaskID

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

通过 TaskID 构造一个混流任务对象

Declared in ZegoExpressDefines.h

ZegoMixerTask 实例

setAudioConfig

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

设置混流任务对象的音频配置

Declared in ZegoExpressDefines.h

setVideoConfig

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

设置混流任务对象的视频配置

Declared in ZegoExpressDefines.h

setInputList

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

设置混流任务对象的输入流列表

Declared in ZegoExpressDefines.h

setOutputList

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

设置混流任务对象的输出列表

Declared in ZegoExpressDefines.h

setWatermark

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

设置混流任务对象的水印

Declared in ZegoExpressDefines.h

setWhiteboard

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

设置混流任务对象的白板信息

Declared in ZegoExpressDefines.h

setBackgroundColor

- (void)setBackgroundColor:(int)backgroundColor;

设置混流任务对象的背景色，颜色值对应 RGBA 为 0xRRGGBBAA，目前不支持设置背景色的透明度，0xRRGGBBAA 中的 AA 为 00 即可。例如：选取 RGB 为 \#87CEFA 作为背景色，此参数传 0x87CEFA00。

Declared in ZegoExpressDefines.h

setBackgroundImageURL

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

设置混流任务对象的背景图片

Declared in ZegoExpressDefines.h

enableSoundLevel

- (void)enableSoundLevel:(BOOL)enable;

是否开启混流的声浪回调通知，开启后拉混流时可通过 [onMixerSoundLevelUpdate] 回调收到每条单流的声浪信息

Declared in ZegoExpressDefines.h

setStreamAlignmentMode

- (void)setStreamAlignmentMode:(ZegoStreamAlignmentMode)mode;

设置混流对齐模式

Declared in ZegoExpressDefines.h

setUserData:length

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

设置用户自定义数据，长度不超过 1000。注意 SDK 只读取长度为 length 的数据，如果 length 大于 data 实际长度，则 SDK 按照 data 实际长度读取数据

Declared in ZegoExpressDefines.h

setAdvancedConfig

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

设置高级配置，如可用于指定视频编码等功能。如需使用，联系 ZEGO 技术支持。

Declared in ZegoExpressDefines.h

setMinPlayStreamBufferLength

- (void)setMinPlayStreamBufferLength:(int)minPlayStreamBufferLength;

详情描述：设置混流服务器拉流缓存自适应调整的区间范围下限。在实时合唱 KTV 场景下，推流端网络轻微波动可能会导致混流的卡顿，此时观众拉混流的时候，会有比较高概率出现卡顿的问题。通过调节混流服务器拉流缓存自适应调整的区间范围下限，可优化观众端拉混流出现的卡顿问题，但会增大延迟。默认不设置，即服务端使用自身配置值。只会对新的输入流设置生效，对于已经开始混流的输入流不生效。取值范围：[0,10000]，超过最大值混流会失败。在 web 平台，此属性不生效。

Declared in ZegoExpressDefines.h

setMixImageCheckMode

- (void)setMixImageCheckMode:(ZegoMixImageCheckMode)mixImageCheckMode;

设置混流图片检查模式

Declared in ZegoExpressDefines.h