SCCameraKitSession

Objective-C


@interface SCCameraKitSession : NSObject <SCCameraKitProtocol>

Swift

class Session : NSObject, CameraKitProtocol

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


                    
                    
                    -initWithSessionConfig:lensesConfig:errorHandler:initializationExtensions:

Init with session and lenses config instance to configure properties within lenses component

Note

Only add extensions that are specifically designed for session initialization. This requirement should be explicitly mentioned in the extension’s documentation.

Declaration

Objective-C

- (nonnull instancetype)
       initWithSessionConfig:(nullable SCCameraKitSessionConfig *)sessionConfig
                lensesConfig:(nonnull SCCameraKitLensesConfig *)lensesConfig
                errorHandler:(nullable id<SCCameraKitErrorHandler>)errorHandler
    initializationExtensions:
        (nullable NSArray<id<SCCameraKitExtension>> *)initializationExtensions;

Swift

init(sessionConfig: SCCameraKitSessionConfig?, lensesConfig: SCCameraKitLensesConfig, errorHandler: (any SCCameraKitErrorHandler)?, initializationExtensions: [any SCCameraKitExtension]?)

Parameters

`sessionConfig`	session config to configure session with application id and api token
`lensesConfig`	lenses config to configure lenses component such as caches
`errorHandler`	optional error handler instance to handle exceptions thrown by CameraKit
`initializationExtensions`	extensions that should be registered to the session on initialization.


                    
                    
                    -initWithSessionConfig:lensesConfig:errorHandler:

Init with session and lenses config instance to configure properties within lenses component

Declaration

Objective-C

- (nonnull instancetype)
    initWithSessionConfig:(nullable SCCameraKitSessionConfig *)sessionConfig
             lensesConfig:(nonnull SCCameraKitLensesConfig *)lensesConfig
             errorHandler:(nullable id<SCCameraKitErrorHandler>)errorHandler;

Swift

init(sessionConfig: SCCameraKitSessionConfig?, lensesConfig: SCCameraKitLensesConfig, errorHandler: (any SCCameraKitErrorHandler)?)

Parameters

`sessionConfig`	session config to configure session with application id and api token
`lensesConfig`	lenses config to configure lenses component such as caches
`errorHandler`	optional error handler instance to handle exceptions thrown by CameraKit


                    
                    
                    -initWithLensesConfig:errorHandler:

Init with lenses config instance to configure properties within lenses component

Declaration

Objective-C

- (nonnull instancetype)
    initWithLensesConfig:(nonnull SCCameraKitLensesConfig *)lensesConfig
            errorHandler:(nullable id<SCCameraKitErrorHandler>)errorHandler;

Swift

init(lensesConfig: SCCameraKitLensesConfig, errorHandler: (any SCCameraKitErrorHandler)?)

Parameters

`lensesConfig`	lenses config to configure lenses components such as caches
`errorHandler`	optional error handler instance to handle exceptions thrown by CameraKit