IVSSimulcastConfiguration

Objective-C


@interface IVSSimulcastConfiguration : NSObject

Swift

class IVSSimulcastConfiguration : NSObject

A configuration object describing simulcast configuration

  • Whether simulcast is enabled.

    By default this is NO.

    Declaration

    Objective-C

    @property (nonatomic) BOOL enabled;

    Swift

    var enabled: Bool { get set }

  • The layer configurations to be parent with the stage session that owns this video config. By default this is an empty array.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSArray<IVSLocalStageStreamLayer *> *_Nonnull layers;

    Swift

    var layers: [IVSLocalStageStreamLayer] { get }

  • Sets the layer configurations for the publishing video stream. The number of layers must be 3 or less. Each layer must have different configurations. maxBitrate, size and targetFramerate must be set on each layer. If the provided layers are invalid, the layers will not be set and the provided outError will be set. If no layers are defined, the default internal layer configurations is used.

    Declaration

    Objective-C

    - (BOOL)setLayers:(nonnull NSArray<IVSLocalStageStreamLayer *> *)layers
            error:(NSError *_Nullable *_Nullable)outError;

    Swift

    func setLayers(_ layers: [IVSLocalStageStreamLayer]) throws

    Parameters

    layers

    the layer configurations
    outError

    On input, a pointer to an error object. If an error occurs, the pointer is an NSError object that describes the error. If you don’t want error information, pass in nil.

    Return Value

    if the set operation is successful or not.