SCCameraKitOutputViewportProviding

Objective-C

@protocol SCCameraKitOutputViewportProviding <SCCameraKitOutputSpecialCase>

Swift

protocol OutputViewportProviding

Allows conformers to provide output viewport frame size

  • A delegate to notify if you change the viewport. This property will be set by CameraKit automatically when you add the output.

    Declaration

    Objective-C

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

    Swift

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

  • Output viewport frame size When modified, the protocol conformer should call viewportChanged: on its delegate.

    Declaration

    Objective-C

    @property (nonatomic, readonly) CGSize viewportSize;

    Swift

    var viewportSize: CGSize { get }

  • Output resolution size in pixels When modified, the protocol conformer should call resolutionChanged: on its delegate

    Note

    the size should be in pixels, not points (eg: an iPhone X would be 1125x2436, not 375x812)

    Declaration

    Objective-C

    @property (nonatomic, readonly) CGSize outputResolution;

    Swift

    var outputResolution: CGSize { get }

  • A CGRect describing an area that the host app will not draw on top of. When modified, the protocol conformer should call viewportChanged: on its delegate.

    Note

    If multiple viewport providers are given, CameraKit will use the smallest one provided.

    Declaration

    Objective-C

    @property (nonatomic, readonly) CGRect safeArea;

    Swift

    var safeArea: CGRect { get }