IVSStageStream

Objective-C


@interface IVSStageStream : NSObject

Swift

class IVSStageStream : NSObject

A media stream that contains a single IVSDevice and a single type of media data (audio or video).

  • 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

  • A delegate that can provide updates about this stream.

    Declaration

    Objective-C

    @property (nonatomic, weak) id<IVSStageStreamDelegate> _Nullable delegate;

    Swift

    weak var delegate: (any IVSStageStreamDelegate)? { get set }

  • The device associated with this stream.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) id<IVSDevice> _Nonnull device;

    Swift

    var device: any IVSDevice { get }

  • The mute state for this stream. This state applies to the Stage itself, not the local rendering. If this is true, nobody can render this stream.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL isMuted;

    Swift

    var isMuted: Bool { get }

  • Request Real Time Communication stats from this stream.

    Declaration

    Objective-C

    - (BOOL)requestRTCStatsWithError:(NSError *_Nullable *_Nullable)outError;

    Swift

    func requestRTCStats() throws

    Parameters

    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.

  • Request quality stats from this stream.

    Declaration

    Objective-C

    - (BOOL)requestQualityStatsWithError:(NSError *_Nullable *_Nullable)outError;

    Swift

    func requestQualityStats() throws

    Parameters

    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.