SlyceScanner Class Reference

Inherits from	NSObject
Declared in	SlyceScanner.h

`+ scannerWithSession:lensIdentifier:lensConfiguration:error:`

Creates a new scanner matching the spec of the provided lens identifier.

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

Parameters

`session`	A valid Slyce session to link to the scanner.
`lensIdentifier`	The identifier of the lens to create.
`lensConfiguration`	The configuration for this lens.
`outError`	A pointer to an error that may be emitted.

Return Value

a new headless lens.

Declared In

SlyceScanner.h

`lensIdentifier`

The lens identifier associated with this scanner instance.

@property (nonatomic, readonly) NSString *lensIdentifier

Declared In

SlyceScanner.h

`captureSession`

A reference to the captureSession that the scanner is attached to.

@property (nonatomic, strong, readonly, nullable) AVCaptureSession *captureSession

Declared In

SlyceScanner.h

`detectionSuspended`

The current state of detection

@property (readonly, getter=isDetectionSuspended) BOOL detectionSuspended

Declared In

SlyceScanner.h

`– attachToCaptureSession:error:NS_SWIFT_NAME:`

Attaches the scanner to the provided capture session.

- (BOOL)attachToCaptureSession:(AVCaptureSession *)captureSession error:(NSError *_Nullable __autoreleasing *_Nullable)error NS_SWIFT_NAME

Parameters

`captureSession`	The AVCaptureSession.
`error`	An optional error that may be passed back.

Return Value

YES if the operation was successful.

Discussion

Use this method to attach your existing captureSession to the scanner.

Declared In

SlyceScanner.h

`– detachFromCaptureSession`

Detaches the scanner to the provided capture session.

- (void)detachFromCaptureSession

Declared In

SlyceScanner.h

`– suspendDetection`

Suspends result detection for the scanner.

- (void)suspendDetection

Declared In

SlyceScanner.h

`– resumeDetection`

Resumes result detection for the scanner.

- (void)resumeDetection

Declared In

SlyceScanner.h

`avCaptureVideoDataOutputSampleBufferDelegate`

Pass-through AVCaptureVideoDataOutputSampleBufferDelegate

@property (nonatomic, weak, nullable) id<AVCaptureVideoDataOutputSampleBufferDelegate> avCaptureVideoDataOutputSampleBufferDelegate

Discussion

Setting this property will pass-through all AVCaptureVideoDataOutputSampleBufferDelegate delegate methods after Slyce has finished processing. This can be use to do your own processing of video frames.

Declared In

SlyceScanner.h

`avCaptureMetadataOutputObjectsDelegate`

Pass-through AVCaptureMetadataOutputObjectsDelegate

@property (nonatomic, weak, nullable) id<AVCaptureMetadataOutputObjectsDelegate> avCaptureMetadataOutputObjectsDelegate

Discussion

Setting this property will pass-through all AVCaptureMetadataOutputObjectsDelegate delegate methods after Slyce has finished processing. This can be used to do your own processing of any detected barcodes.

Declared In

SlyceScanner.h

`)`

The SlyceScannerDelegate for the scanner instance.

@property (nonatomic, weak, nullable) id<SlyceScannerDelegate> delegate __deprecated_msg ( "Please use SlyceSession and SlyceSearchTask instead, SlyceScannerDelegate will be removed in a future release." )

Declared In

SlyceScanner.h