Text Capture
Defined in framework ScanditTextCapture
- SDCTextCapture
@interface SDCTextCapture : NSObject <SDCDataCaptureMode>
Added in version 6.1.0
Deprecated since version 6.26.0.
Capture mode for reading text.
- + textCaptureWithContext:settings:
+ (
instancetype)textCaptureWithContext:(nullable SDCDataCaptureContext *)context settings:(nonnull SDCTextCaptureSettings *)settingsAdded in version 6.1.0
Construct a new text capture mode with the provided context and settings. Then the context is not nil, the capture mode is automatically added to the context.
- + textCaptureFromJSONString:context:error:
+ (nullable
instancetype)textCaptureFromJSONString:(nonnull NSString *)JSONString context:(nonnull SDCDataCaptureContext *)context error:(NSError **)errorAdded in version 6.3.0
Construct a new text capture mode with the provided JSON serialization. The capture mode is automatically added to the context.
- enabled
@property (nonatomic, assign, getter=isEnabled)
BOOLenabledAdded in version 6.1.0
Implemented from SDCDataCaptureMode. See SDCDataCaptureMode.enabled.
- pointOfInterest
@property (nonatomic, assign) SDCPointWithUnit pointOfInterest
Added in version 6.1.0
The point of interest overwriting the point of interest of the data capture view. By default, this overwriting point of interest is not set and the one from the data capture view is used.
Use SDCPointWithUnitNull (FloatWithUnit.null in Swift) to unset the point of interest.
The overwriting point of interest is used to control the center of attention for the following subsystems:
Location selection. When no location selection is set, the point of interest defines the location at which the recognition optimizes for reading barcodes.
Rendered viewfinders.
- - applySettings:completionHandler:
- (
void)applySettings:(nonnull SDCTextCaptureSettings *)settings completionHandler:(nullable void (^)(void))completionHandlerAdded in version 6.1.0
Asynchronously apply the new settings to the text capture mode. If text capture is currently running, the task will complete when the next frame is processed, and will use the new settings for that frame. If text capture is currently not running, the task will complete as soon as the settings have been stored and won’t wait until the next frame is going to be processed.
- feedback
@property (nonatomic, strong, nonnull) SDCTextCaptureFeedback *feedback
Added in version 6.1.0
Instance of SDCTextCaptureFeedback that is used by text capture to notify users about Success events.
The default instance of the Feedback will have both sound and vibration enabled. A default beep sound will be used for the sound.
To change the feedback emitted, the SDCTextCaptureFeedback can be modified as shown below, or a new one can be assigned.
let textCapture: TextCapture = ... textCapture.feedback.success = Feedback(vibration: nil, sound: Sound.default)
- - addListener:
- (
void)addListener:(nonnull id<SDCTextCaptureListener>)listenerAdded in version 6.1.0
Add the listener to observe this text capture instance.
In case the same listener is already observing this instance, calling this method will not add the listener again. The listener is stored using a weak reference and must thus be retained by the caller for it to not go out of scope.
- - removeListener:
- (
void)removeListener:(nonnull id<SDCTextCaptureListener>)listenerAdded in version 6.1.0
Remove a previously added listener from this text capture instance.
In case the listener is not currently observing this instance, calling this method has no effect.
- recommendedCameraSettings
@property (class, nonatomic, nonnull, readonly) SDCCameraSettings *recommendedCameraSettings
Added in version 6.1.0
Returns the recommended camera settings for use with text capture.
- context
@property (nonatomic, nullable, readonly) SDCDataCaptureContext *context
Added in version 6.1.0
Implemented from SDCDataCaptureMode. See SDCDataCaptureMode.context.