Classes

The following classes are available globally.

  • CameraKit handles interaction with the camera and contains several components like lenses.

    See more

    Declaration

    Objective-C

    
@interface SCCameraKitSession : NSObject <SCCameraKitProtocol>

    Swift

    class Session : NSObject, CameraKitProtocol

  • AVSessionInput is a CameraKit provided wrapper for AVCaptureSession. It may make adjustments to things like color formats in order to process frames. You are still responsible for doing the general configuration of the capture session, such as adding devices.

    See more

    Declaration

    Objective-C

    
@interface SCCameraKitARSessionInput : NSObject <SCCameraKitARInput>

    Swift

    class ARSessionInput : NSObject

  • AVSessionInput is a CameraKit provided wrapper for AVCaptureSession. It may make adjustments to things like color formats in order to process frames. You are still responsible for doing the general configuration of the capture session, such as adding devices.

    See more

    Declaration

    Objective-C

    
@interface SCCameraKitAVSessionInput : NSObject <SCCameraKitInput>

    Swift

    class AVSessionInput : NSObject

  • AVWriterOutput is a CameraKit provided wrapper for AVAssetWriter. You are still responsible for the configuration of the writer.

    See more

    Declaration

    Objective-C

    
@interface SCCameraKitAVWriterOutput : NSObject

    Swift

    class AVWriterOutput : NSObject

  • An adjustment which allows users to more accurately represent the color of their skin when captured by the camera.

    Declaration

    Objective-C

    
@interface SCCameraKitToneMapAdjustment : NSObject <SCCameraKitAdjustment>

    Swift

    class ToneMapAdjustment : NSObject, __Adjustment

  • An adjustment which allows users to blur the background on their input.

    Declaration

    Objective-C

    
@interface SCCameraKitPortraitAdjustment : NSObject <SCCameraKitAdjustment>

    Swift

    class PortraitAdjustment : NSObject, __Adjustment

  • Component for user’s custom data providers

    See more

    Declaration

    Objective-C

    
@interface SCCameraKitDataProviderComponent : NSObject

    Swift

    class DataProviderComponent : NSObject

  • Enables the configuration of a custom viewport for SCCameraKitPreviewView.

    See more

    Declaration

    Objective-C

    
@interface SCCameraKitExplicitViewportProvider : NSObject

  • Concrete class to build lens launch data to pass to processor when applying

    See more

    Declaration

    Objective-C

    
@interface SCCameraKitLensLaunchDataBuilder : NSObject

    Swift

    class LensLaunchDataBuilder : NSObject

  • Final, opaque data class to reset persisted launch data

    Declaration

    Objective-C

    
@interface SCCameraKitEmptyLensLaunchData : NSObject <SCCameraKitLensLaunchData>

    Swift

    class EmptyLensLaunchData : NSObject, LensLaunchData

  • A default implementation of SCCameraKitLensMediaPickerProvider that uses the user’s photos library.

    See more

    Declaration

    Objective-C

    
@interface SCCameraKitLensMediaPickerProviderPhotoLibrary
    : NSObject <SCCameraKitLensMediaPickerProvider>

    Swift

    class LensMediaPickerProviderPhotoLibrary : NSObject, LensMediaPickerProvider

  • Concrete data class for the remote api service response to a request sent by a lens.

    See more

    Declaration

    Objective-C

    
@interface SCCameraKitLensRemoteApiResponse
    : NSObject <SCCameraKitLensRemoteApiResponse>

    Swift

    class LensRemoteApiResponse : NSObject, LensRemoteApiResponseProtocol

  • Concrete class to configure camera kit cache

    See more

    Declaration

    Objective-C

    
@interface SCCameraKitCacheConfig : NSObject

    Swift

    class CacheConfig : NSObject

  • Concrete class to configure all available, user-configurable properties within the lenses component

    See more

    Declaration

    Objective-C

    
@interface SCCameraKitLensesConfig : NSObject

    Swift

    class LensesConfig : NSObject

  • An output that will capture photos. You should add this as an output for your CameraKit instance.

    See more

    Declaration

    Objective-C

    
@interface SCCameraKitPhotoCaptureOutput : NSObject

    Swift

    class PhotoCaptureOutput : NSObject

  • A UIView which is capable of rendering SCCameraKitTextures. You should add this as an output for your CameraKit instance.

    See more

    Declaration

    Objective-C

    
@interface SCCameraKitPreviewView : UIView

  • Data class that is used to pass in a configuration for the CameraKit Session. Use this data class if you would like to be able to dynamically update config values like application id and api token or overwrite the ones that are passed into Info.plist.

    See more

    Declaration

    Objective-C

    
@interface SCCameraKitSessionConfig : NSObject

    Swift

    class SessionConfig : NSObject

  • Concrete user data class to pass in user data that can be used by some lenses

    See more

    Declaration

    Objective-C

    
@interface SCCameraKitUserData : NSObject

    Swift

    class UserData : NSObject