Protocols

Objective-C

@protocol SCCameraKitProtocol <NSObject>

/// Contains lenses related objects.
@property (strong, nonatomic, readonly) id<SCCameraKitLensesComponent> lenses;

/// Contains adjustment related objects.
@property (strong, nonatomic, readonly) id<SCCameraKitAdjustmentsComponent> adjustments;

/// Begin processing input frames with front camera position and portrait video orientation
/// @param input the input to configure.
/// @param arInput the ARKit input to configure.
- (void)startWithInput:(id<SCCameraKitInput>)input
               arInput:(id<SCCameraKitARInput>)arInput NS_SWIFT_NAME(start(input:arInput:));

/// Deprecated. Use
/// -startWithInput:arInput:cameraPosition:videoOrientation:dataProvider:hintDelegate:agreementsPresentationContextProvider:
- (void)startWithInput:(id<SCCameraKitInput>)input
               arInput:(id<SCCameraKitARInput>)arInput
        cameraPosition:(AVCaptureDevicePosition)cameraPosition
      videoOrientation:(AVCaptureVideoOrientation)videoOrientation
          dataProvider:(SCCameraKitDataProviderComponent *)dataProvider
          hintDelegate:(id<SCCameraKitLensHintDelegate>)hintDelegate __attribute__((deprecated));

/// Deprecated. Use
/// -startWithInput:arInput:cameraPosition:videoOrientation:dataProvider:hintDelegate:textInputContextProvider:agreementsPresentationContextProvider:
- (void)startWithInput:(id<SCCameraKitInput>)input
                                  arInput:(id<SCCameraKitARInput>)arInput
                           cameraPosition:(AVCaptureDevicePosition)cameraPosition
                         videoOrientation:(AVCaptureVideoOrientation)videoOrientation
                             dataProvider:(nullable SCCameraKitDataProviderComponent *)dataProvider
                             hintDelegate:(nullable id<SCCameraKitLensHintDelegate>)hintDelegate
    agreementsPresentationContextProvider:
        (nullable id<SCCameraKitAgreementsPresentationContextProvider>)agreementsPresentationContextProvider
    NS_SWIFT_NAME(start(input:arInput:cameraPosition:videoOrientation:dataProvider:hintDelegate:agreementsPresentationContextProvider:))
        __attribute__((deprecated));
;

/// Begin processing input frames.
/// @param input the input to configure.
/// @param arInput the ARKit input to configure.
/// @param cameraPosition the camera position in use
/// @param videoOrientation the orientation for the outputted video buffers
/// @param dataProvider data provider component to pass in custom data providers (optional -- will create and handle
/// data providers by default if nil)
/// @param hintDelegate lens hint delegate to show/hide hints for applied lenses
/// @param textInputContextProvider context provider for providing keyboard access to lenses
/// @param agreementsPresentationContextProvider context provider for presenting agreements screens
- (void)startWithInput:(id<SCCameraKitInput>)input
                                  arInput:(id<SCCameraKitARInput>)arInput
                           cameraPosition:(AVCaptureDevicePosition)cameraPosition
                         videoOrientation:(AVCaptureVideoOrientation)videoOrientation
                             dataProvider:(nullable SCCameraKitDataProviderComponent *)dataProvider
                             hintDelegate:(nullable id<SCCameraKitLensHintDelegate>)hintDelegate
                 textInputContextProvider:(nullable id<SCCameraKitTextInputContextProvider>)textInputContextProvider
    agreementsPresentationContextProvider:
        (nullable id<SCCameraKitAgreementsPresentationContextProvider>)agreementsPresentationContextProvider
    NS_SWIFT_NAME(start(input:arInput:cameraPosition:videoOrientation:dataProvider:hintDelegate:textInputContextProvider:agreementsPresentationContextProvider:));

/// End processing input frames.
- (void)stop;

/// End processing input frames.
/// @param completion Block to be called after processing is finished and session is stopped
- (void)stopWithCompletion:(nullable void (^)(void))completion NS_SWIFT_NAME(stop(completion:));

/// Add an output. Frames will still be processed if no outputs exist.
- (void)addOutput:(id<SCCameraKitOutput>)output NS_SWIFT_NAME(add(output:));

/// Remove an output.
- (void)removeOutput:(id<SCCameraKitOutput>)listener NS_SWIFT_NAME(remove(output:));

/// The camera position in use. Setting will automatically update the input.
@property (nonatomic, assign) AVCaptureDevicePosition cameraPosition;

/// The orientation for the outputted video buffers
@property (nonatomic, assign) AVCaptureVideoOrientation videoOrientation;

/// The active input. May be either standard camera input or the AR input, depending on lens requirements.
@property (nonatomic, readonly) id<SCCameraKitInput> activeInput;

/// Store containing information above the acceptance state of terms of service
@property (nonatomic, readonly) id<SCCameraKitAgreementsStore> agreementsStore;

/// Presents any agreements such as Terms of Service or Privacy Policy for CameraKit immediately, if needed.
/// @note CameraKit will present this when the user applies a lens if they have new agreements to accept. You can call
/// this explicitly if you wish to present the terms before then (eg during an onboarding experience, alongside your own
/// app's Terms of Service)
- (void)presentAgreementsImmediately;

@end

Swift

protocol CameraKitProtocol : NSObjectProtocol

Objective-C

@protocol SCCameraKitARInputDelegate

Objective-C

@protocol SCCameraKitARInput <SCCameraKitInput>

Objective-C

@protocol SCCameraKitAccessTokenProviderTask <NSObject>

Swift

protocol AccessTokenProviderTask : NSObjectProtocol

Objective-C

@protocol SCCameraKitAccessTokenProvider <NSObject>

Swift

protocol AccessTokenProvider : NSObjectProtocol

Objective-C

@protocol SCCameraKitAdjustment <NSObject>

Objective-C

@protocol SCCameraKitAdjustmentController <NSObject>

Swift

protocol AdjustmentController : NSObjectProtocol

Objective-C

@protocol
    SCCameraKitToneMapAdjustmentController <SCCameraKitAdjustmentController>

Swift

protocol ToneMapAdjustmentController : AdjustmentController

Objective-C

@protocol
    SCCameraKitPortraitAdjustmentController <SCCameraKitAdjustmentController>

Swift

protocol PortraitAdjustmentController : AdjustmentController

Objective-C

@protocol SCCameraKitAdjustmentsProcessor <NSObject>

Objective-C

@protocol SCCameraKitAdjustmentsComponent <NSObject>

Swift

protocol AdjustmentsComponent : NSObjectProtocol

Objective-C

@protocol SCCameraKitAdjustmentsProcessorObserver <NSObject>

Swift

protocol AdjustmentsProcessorObserver : NSObjectProtocol

Objective-C

@protocol SCCameraKitAgreementSet <NSObject>

Swift

protocol AgreementSet : NSObjectProtocol

Objective-C

@protocol SCCameraKitAgreementsPresentationContextProvider <NSObject>

Swift

protocol AgreementsPresentationContextProvider : NSObjectProtocol

Objective-C

@protocol SCCameraKitAgreementsStore <NSObject>

Swift

protocol AgreementsStore : NSObjectProtocol

Objective-C

@protocol SCCameraKitDeviceMotionParameters <NSObject>

Swift

protocol DeviceMotionParameters : NSObjectProtocol

Objective-C

@protocol SCCameraKitDeviceMotionDataProvider <NSObject>

Swift

protocol DeviceMotionDataProvider : NSObjectProtocol

Objective-C

@protocol SCCameraKitErrorHandler

Swift

protocol ErrorHandler

Objective-C

@protocol SCCameraKitInputDestination

Swift

protocol InputDestination

Objective-C

@protocol SCCameraKitInput

Swift

protocol Input

Objective-C

@protocol SCCameraKitLensPreview <NSObject>

Swift

protocol LensPreview : NSObjectProtocol

Objective-C

@protocol SCCameraKitLens <NSObject>

Swift

protocol Lens : NSObjectProtocol

Objective-C

@protocol SCCameraKitLensHintDelegate <NSObject>

Swift

protocol LensHintDelegate : NSObjectProtocol

Objective-C

@protocol SCCameraKitLensHintProvider <NSObject>

Swift

protocol LensHintProvider : NSObjectProtocol

Objective-C

@protocol SCCameraKitLensLaunchData <NSObject>

Swift

protocol LensLaunchData : NSObjectProtocol

Objective-C

@protocol SCCameraKitLensMediaPickerProvider <NSObject>

/// A delegate that must be notified when loadAndApplyOriginalMediaFromAsset: finishes loading an original asset.
/// @warning: DO NOT set this delegate manually. CameraKit will set this property appropriately.
@property (weak, nonatomic) id<SCCameraKitLensMediaPickerProviderMediaApplicationDelegate> mediaApplicationDelegate;

/// A delegate that will be notified when picker-related UI should be shown or hidden.
@property (weak, nonatomic) id<SCCameraKitLensMediaPickerProviderUIDelegate> uiDelegate;

/// The number of assets that have been fetched and may be displayed by the picker UI.
@property (readonly, nonatomic, assign) NSInteger fetchedAssetCount;

/// Whether or not the data provider has more assets available to fetch.
@property (readonly, nonatomic, assign) BOOL hasMoreAssetsToFetch;

/// Fetches a new batch of assets.
/// @param batchSize How many items to fetch. A provider may return less than this if it exhausts available assets
/// without reaching the desired batch size
/// @param queue a dispatch queue to receive callbacks on
/// @param completion a completion block to be called when the fetch has completed
- (void)fetchNextAssetBatchOfSize:(NSInteger)batchSize
                            queue:(dispatch_queue_t)queue
                       completion:(void (^)(NSArray<id<SCCameraKitLensMediaPickerAsset>> *))completion
    NS_SWIFT_NAME(fetchNextAssetBatch(size:queue:completion:));

/// Retrieves a fetched asset at a given index.
/// @param index the index to fetch.
- (id<SCCameraKitLensMediaPickerAsset>)fetchedAssetAtIndex:(NSInteger)index NS_SWIFT_NAME(fetchedAsset(at:));

/// Loads the full resolution backing asset of a specified asset and applies it to lenses.
/// @param asset the asset to load and apply
/// @param completion a completion block called when application is complete
/// @note Implementors of this method MUST call the appropriate method on the uiDelegate when the loading is completed
/// in order for the lens to succesfully apply the media.
- (void)loadAndApplyOriginalMediaFromAsset:(id<SCCameraKitLensMediaPickerAsset>)asset
                                completion:(nullable void (^)(void))completion
    NS_SWIFT_NAME(loadAndApplyOriginalMedia(from:completion:));

/// Invalidates and resets internal state of the provider with a newly specified allowed media type option set.
/// @param assetType The asset types to allow in results.
- (void)reconfigureWithAllowedTypes:(SCCameraKitLensMediaPickerProviderAllowedMediaType)assetType;

@end

Swift

protocol LensMediaPickerProvider : NSObjectProtocol

Objective-C

@protocol SCCameraKitLensMediaPickerAsset <NSObject>

Swift

protocol LensMediaPickerProviderAsset : NSObjectProtocol

Objective-C

@protocol SCCameraKitLensMediaPickerProviderUIDelegate <NSObject>

Swift

protocol LensMediaPickerProviderUIDelegate : NSObjectProtocol

Objective-C

@protocol SCCameraKitLensMediaPickerProviderMediaApplicationDelegate <NSObject>

Swift

protocol LensMediaPickerProviderMediaApplicationDelegate : NSObjectProtocol

Objective-C

@protocol SCCameraKitLensPrefetcherObserver <NSObject>

Swift

protocol LensPrefetcherObserver : NSObjectProtocol

Objective-C

@protocol SCCameraKitLensPrefetcherTask <NSObject>

Swift

protocol LensPrefetcherTask : NSObjectProtocol

Objective-C

@protocol SCCameraKitLensPrefetcher <NSObject>

Swift

protocol LensPrefetcher : NSObjectProtocol

Objective-C

@protocol SCCameraKitLensProcessor <NSObject>

Swift

protocol LensProcessor : NSObjectProtocol

Objective-C

@protocol SCCameraKitLensProcessorObserver <NSObject>

Swift

protocol ProcessorObserver : NSObjectProtocol

Objective-C

@protocol SCCameraKitLensRemoteApiRequest <NSObject>

Swift

protocol LensRemoteApiRequest : NSObjectProtocol

Objective-C

@protocol SCCameraKitLensRemoteApiResponse <NSObject>

Swift

protocol LensRemoteApiResponseProtocol : NSObjectProtocol

Objective-C

@protocol SCCameraKitLensRemoteApiServiceCall <NSObject>

Swift

protocol LensRemoteApiServiceCall : NSObjectProtocol

Objective-C

@protocol SCCameraKitLensRemoteApiService <NSObject>

Swift

protocol LensRemoteApiService : NSObjectProtocol

Objective-C

@protocol SCCameraKitLensRemoteApiServiceProvider <NSObject>

Swift

protocol LensRemoteApiServiceProvider : NSObjectProtocol

Objective-C

@protocol SCCameraKitLensRepositoryGroupObserver <NSObject>

Swift

protocol LensRepositoryGroupObserver : NSObjectProtocol

Objective-C

@protocol SCCameraKitLensRepositorySpecificObserver <NSObject>

Swift

protocol LensRepositorySpecificObserver : NSObjectProtocol

Objective-C

@protocol SCCameraKitLensesComponent <NSObject>

Swift

protocol LensesComponent : NSObjectProtocol

Objective-C

@protocol SCCameraKitLensRepository <NSObject>

Swift

protocol LensRepository : NSObjectProtocol

Objective-C

@protocol SCCameraKitLocationParameters <NSObject>

Swift

protocol LocationParameters : NSObjectProtocol

Objective-C

@protocol SCCameraKitLocationDataProvider <NSObject>

Swift

protocol LocationDataProvider : NSObjectProtocol

Objective-C

@protocol SCCameraKitOutput <NSObject>

Swift

protocol Output : NSObjectProtocol

Objective-C

@protocol SCCameraKitPreferences <NSObject>

Swift

protocol SCCameraKitPreferences : NSObjectProtocol

Objective-C

@protocol SCCameraKitTextInputKeyboardAccessoryProvider <NSObject>

Swift

protocol TextInputKeyboardAccessoryProvider : NSObjectProtocol

Objective-C

@protocol SCCameraKitTextInputContextProvider <NSObject>

Swift

protocol TextInputContextProvider : NSObjectProtocol

Objective-C

@protocol SCCameraKitTexture <NSObject>

Swift

protocol Texture : NSObjectProtocol

Objective-C

@protocol SCCameraKitUserDataProviderDelegate <NSObject>

Swift

protocol UserDataProviderDelegate : NSObjectProtocol

Objective-C

@protocol SCCameraKitUserDataProvider <NSObject>

Swift

protocol UserDataProvider : NSObjectProtocol