IVSLocalStageStream

Objective-C


@interface IVSLocalStageStream : IVSStageStream

Swift

class IVSLocalStageStream : IVSStageStream

A stage stream that is used to publish local IVSDevices.

  • Unavailable

    Do not create instances of this class directly

    Declaration

    Objective-C

    IVS_INIT_UNAVAILABLE

  • Unavailable

    Do not create instances of this class directly

    Declaration

    Objective-C

    IVS_INIT_UNAVAILABLE

  • Creates a IVSLocalStageStream with the associated device.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDevice:(nonnull id<IVSDevice>)device;

    Swift

    init(device: any IVSDevice)

    Parameters

    device

    The device to initialize the stream with.

  • Deprecated

    Use initWithDevice:config instead, providing an IVSLocalStageStreamConfiguration.

    Creates a IVSLocalStageStream with the associated device and configuration.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDevice:(nonnull id<IVSDevice>)device
                         configuration:
                             (nullable IVSLocalStageStreamVideoConfiguration *)
                                 configuration;

    Swift

    init(device: any IVSDevice, configuration: IVSLocalStageStreamVideoConfiguration?)

    Parameters

    device

    The device to initialize the stream with.
    configuration

    The configuration to initialize the stream with.

  • Creates a IVSLocalStageStream with the associated device and configuration.

    Declaration

    Objective-C

    - (nonnull instancetype)
    initWithDevice:(nonnull id<IVSDevice>)device
            config:(nullable IVSLocalStageStreamConfiguration *)configuration;

    Swift

    init(device: any IVSDevice, config configuration: IVSLocalStageStreamConfiguration?)

    Parameters

    device

    The device to initialize the stream with.
    configuration

    The configuration to initialize the stream with.

  • Sets the mute state for this stream on the Stage. Setting this to true will either disable your video, or mute your audio on the Stage, depending on the media type associated with this stream.

    Declaration

    Objective-C

    - (void)setMuted:(BOOL)muted;

    Swift

    func setMuted(_ muted: Bool)

    Parameters

    muted

    The new muted state for the stream.

  • Deprecated

    Use setConfig: instead, providing an IVSLocalStageStreamConfiguration.

    Updates the configuration of this stream.

    Declaration

    Objective-C

    - (void)setConfiguration:
    (nonnull IVSLocalStageStreamVideoConfiguration *)configuration;

    Swift

    func setConfiguration(_ configuration: IVSLocalStageStreamVideoConfiguration)

    Parameters

    configuration

    The new configuration for the stream.

  • Updates the configuration of this stream.

    Declaration

    Objective-C

    - (void)setConfig:(nonnull IVSLocalStageStreamConfiguration *)configuration;

    Swift

    func setConfig(_ configuration: IVSLocalStageStreamConfiguration)

    Parameters

    configuration

    The new configuration for the stream.