IVSImageDeviceFrame

Objective-C


@interface IVSImageDeviceFrame : NSObject

Swift

class IVSImageDeviceFrame : NSObject

A data class providing metadata about the frames going through an IVSImageDevice.

  • The size of the current frame.

    Declaration

    Objective-C

    @property (nonatomic, readonly) CGSize size;

    Swift

    var size: CGSize { get }

  • The messages embedded in the current frame. For h264 frames, these are SEI messages (See IVSBroadcastSEIMessage). Only populated by the subscribe-side IVSImageDevice implementations in the Real-Time Stages SDK (not by the Broadcast SDK alone).

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSArray<id<IVSBroadcastImageFrameMessage>> *_Nonnull embeddedMessages;

    Swift

    var embeddedMessages: [any IVSImageFrameMessage] { get }

  • The CVPixelBuffer associated with this frame. The buffer will be retained for the duration of the frame callback, beyond that the host application must manage the buffer. This will always be nil unless explicitly opted into using the appropriate IVSImageDevice.setOnFrameCallback APIs.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) CVPixelBufferRef pixelBuffer;

    Swift

    unowned(unsafe) var pixelBuffer: CVPixelBuffer? { get }