IVSRemoteStageStream Class Reference


                    
                    
                    -init

Unavailable

Do not create instances of this class directly

Declaration

Objective-C

IVS_INIT_UNAVAILABLE


                    
                    
                    +new

Unavailable

Do not create instances of this class directly

Declaration

Objective-C

IVS_INIT_UNAVAILABLE


                    
                    
                    delegate

A delegate that can provide updates about this stream.

Declaration

Objective-C

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

Swift

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


                    
                    
                    layers

The layers for the remote stream.

Note

this must be called on the main thread

Declaration

Objective-C

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

Swift

var layers: [IVSRemoteStageStreamLayer] { get }


                    
                    
                    selectedLayer

The selected layer.

Note

this must be called on the main thread

Declaration

Objective-C

@property (nonatomic, strong, readonly, nullable) IVSRemoteStageStreamLayer *selectedLayer;

Swift

var selectedLayer: IVSRemoteStageStreamLayer? { get }


                    
                    
                    highestQualityLayer

The layer with the largest combined surface area (width x height).

Note

this must be called on the main thread

Declaration

Objective-C

@property (nonatomic, strong, readonly) IVSRemoteStageStreamLayer *_Nonnull highestQualityLayer;

Swift

var highestQualityLayer: IVSRemoteStageStreamLayer { get }


                    
                    
                    lowestQualityLayer

The layer with the smalles combined surface area (width x height).

Note

this must be called on the main thread

Declaration

Objective-C

@property (nonatomic, strong, readonly) IVSRemoteStageStreamLayer *_Nonnull lowestQualityLayer;

Swift

var lowestQualityLayer: IVSRemoteStageStreamLayer { get }


                    
                    
                    isAdapting

This represents if dynamic simulcast adaption is enabled.

Note

this must be called on the main thread

Declaration

Objective-C

@property (nonatomic, readonly) BOOL isAdapting;

Swift

var isAdapting: Bool { get }


                    
                    
                    -layersWithConstraints:

The list of available layers which match the constraints given.

Note

this must be called on the main thread

Declaration

Objective-C

- (nonnull NSArray<IVSRemoteStageStreamLayer *> *)layersWithConstraints:
    (nonnull IVSRemoteStageStreamLayerConstraints *)constraints;

Swift

func layers(with constraints: IVSRemoteStageStreamLayerConstraints) -> [IVSRemoteStageStreamLayer]

Parameters


                                constraints

The layer constraints.


                    
                    
                    -firstLayerWithConstraints:or:

The first layer which match the constraints given.

Note

this must be called on the main thread

Declaration

Objective-C

- (nonnull IVSRemoteStageStreamLayer *)
    firstLayerWithConstraints:
        (nonnull IVSRemoteStageStreamLayerConstraints *)constraints
                           or:(nonnull IVSRemoteStageStreamLayer *)defaultValue;

Swift

func firstLayer(with constraints: IVSRemoteStageStreamLayerConstraints, or defaultValue: IVSRemoteStageStreamLayer) -> IVSRemoteStageStreamLayer

Parameters

`constraints`	The layer constraints.
`defaultValue`	A fallback value when there is no matched layer.