SlyceLensView Class Reference

Inherits from	UIView
Declared in	SlyceLensView.h

`+ lensViewWithSession:lensIdentifier:options:error:`

Initializes a new Slyce object using valid Account Identifier, API Key, and Space Identifier.

+ (nullable instancetype)lensViewWithSession:(SlyceSession *)session lensIdentifier:(NSString *)lensIdentifier options:(nullable NSDictionary<NSString*,id> *)options error:(SlyceOutError)outError

Parameters

`session`	An instance of `SlyceSession`.
`lensIdentifier`	The identifier of the lens to be used by this instance.
`options`	TODO:
`outError`	An error that is assigned if an instance of `SlyceLensView` cannot be created.

Discussion

Use this method to open the SDK for ‘Public’ recognition functionality.

Declared In

SlyceLensView.h

`+ lensViewWithSession:lensIdentifier:options:settings:error:`

Initializes a new Slyce object using valid Account Identifier, API Key, and Space Identifier.

+ (nullable instancetype)lensViewWithSession:(SlyceSession *)session lensIdentifier:(NSString *)lensIdentifier options:(nullable NSDictionary<NSString*,id> *)options settings:(nullable SlyceLensSettings *)settings error:(SlyceOutError)outError

Parameters

`session`	An instance of `SlyceSession`.
`lensIdentifier`	The identifier of the lens to be used by this instance.
`options`	TODO:
`settings`	An optional `SlyceLensConfiguration` object.
`outError`	An error that is assigned if an instance of `SlyceLensView` cannot be created.

Discussion

Use this method to open the SDK for ‘Public’ recognition functionality.

Declared In

SlyceLensView.h

`lensIdentifier`

The identifier of the lens used by this instance.

@property (nonatomic, readonly) NSString *lensIdentifier

Declared In

SlyceLensView.h

`lensSettings`

The SlyceLensSettings used to configure this instance.

@property (nonatomic, readonly) SlyceLensSettings *lensSettings

Declared In

SlyceLensView.h

`camera`

The SlyceCameraControls for this instance.

@property (nonatomic, readonly) id<SlyceCameraControls> camera

Declared In

SlyceLensView.h

`– suspendDetection`

Suspends result detection of the underlying scanner.

- (void)suspendDetection

Declared In

SlyceLensView.h

`– resumeDetection`

Resumes result detection of the underlying scanner.

- (void)resumeDetection

Declared In

SlyceLensView.h

`– isDetectionSuspended`

Yes is the underlying scanner is suspended.

- (BOOL)isDetectionSuspended

Declared In

SlyceLensView.h

`– resetAnimations`

Resets the animation view to its default state.

- (void)resetAnimations

Declared In

SlyceLensView.h

`+ lensViewWithSession:lensIdentifier:lensConfiguration:error:`

Initializes a new Slyce object using valid Account Identifier, API Key, and Space Identifier.

+ (nullable instancetype)lensViewWithSession:(SlyceSession *)session lensIdentifier:(NSString *)lensIdentifier lensConfiguration:(nullable SlyceLensSettings *)lensConfiguration error:(SlyceOutError)outError

Parameters

`session`	An instance of `SlyceSession`.
`lensIdentifier`	The identifier of the lens to be used by this instance.
`lensConfiguration`	An optional `SlyceLensConfiguration` object.
`outError`	An error that is assigned if an instance of `SlyceLensView` cannot be created.

Discussion

Use this method to open the SDK for ‘Public’ recognition functionality.

Declared In

SlyceLensView.h

`session`

The SlyceSession used to configure this instance.

@property (nonatomic, readonly) SlyceSession *session

Declared In

SlyceLensView.h

`)`

The SlyceLensConfiguration used to configure this instance.

@property (nonatomic, readonly) SlyceLensSettings *__deprecated_msg ( "lensConfiguration has been renamed to lensSettings" )

Declared In

SlyceLensView.h