SCCameraKitARInput

Objective-C

@protocol SCCameraKitARInput <SCCameraKitInput>

Swift

protocol ARInput

Describes a source of AR data for CameraKit.

  • The managed ARSession.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) ARSession *_Nonnull session;

    Swift

    var session: ARSession { get }

  • The intermediate destination for ARKit delegate methods. See the protocol definition for more details. This property should NOT be set directly. CameraKit will assign this as appropriate.

    Declaration

    Objective-C

    @property (nonatomic, weak) id<SCCameraKitARInputDelegate> _Nullable arDelegate;

    Swift

    weak var arDelegate: ARInputDelegate? { get set }

  • The ARConfiguration to use when using the front camera.

    Warning

    if your app supports lenses with true sizing, you MUST return an instance of ARFaceTrackingConfiguration (additionally, we recommend setting the number of tracked faces to 0)

    Note

    this is nil by default, as adding ARFaceTrackingConfiguration will subject your app to additional app review, concerning your usage of the TrueDepth camera.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) ARConfiguration *_Nonnull frontCameraConfiguration;

    Swift

    var frontCameraConfiguration: ARConfiguration { get }

  • Runs the session with the provided configuration and options.

    Declaration

    Objective-C

    - (void)runWithConfiguration:(nonnull ARConfiguration *)configuration
                     options:(ARSessionRunOptions)options;

    Swift

    func run(_ configuration: ARConfiguration, options: ARSession.RunOptions = [])

  • Pauses the session.

    Declaration

    Objective-C

    - (void)pause;

    Swift

    func pause()