Macro Mode Control

Defined in framework ScanditDataCaptureCore

SDCMacroModeControl
@interface SDCMacroModeControl : NSObject <SDCControl>

Added in version 6.17.0

Control that allows to switch between the available macro modes. The control hides itself automatically in case the active frame source doesn’t support macro mode.

You can add this control to a view by calling SDCDataCaptureView.addControl:. Please note that this control has the same default placement anchor as SDCCameraSwitchControl, so it will replace it when added to the view using the default settings. If you need to place multiple controls at the same anchor, consider using SDCLinearControlGroup.

+ macroModeControlFromJSONString:error:
+ (nullable instancetype)macroModeControlFromJSONString:(nonnull NSString *)JSONString
                                                  error:(NSError **)error

Added in version 6.17.0

Constructs a new macro mode control with the provided JSON serialization. See Serialization for details.

autoImage
@property (nonatomic, strong, nonnull) UIImage *autoImage

Added in version 6.17.0

The button image displayed when the macro mode is auto.

offImage
@property (nonatomic, strong, nonnull) UIImage *offImage

Added in version 6.17.0

The button image displayed when the macro mode is off.

onImage
@property (nonatomic, strong, nonnull) UIImage *onImage

Added in version 6.17.0

The button image displayed when the macro mode is on.

accessibilityLabelWhenAuto
@property (nonatomic, copy, nullable) NSString *accessibilityLabelWhenAuto

Added in version 6.17.0

Accessibility label text used for the control button when the macro mode is auto.

accessibilityHintWhenAuto
@property (nonatomic, copy, nullable) NSString *accessibilityHintWhenAuto

Added in version 6.17.0

Accessibility hint text used for the control button when the macro mode is auto.

accessibilityLabelWhenOff
@property (nonatomic, copy, nullable) NSString *accessibilityLabelWhenOff

Added in version 6.17.0

Accessibility label text used for the control button when the macro mode is off.

accessibilityHintWhenOff
@property (nonatomic, copy, nullable) NSString *accessibilityHintWhenOff

Added in version 6.17.0

Accessibility hint text used for the control button when the macro mode is off.

accessibilityLabelWhenOn
@property (nonatomic, copy, nullable) NSString *accessibilityLabelWhenOn

Added in version 6.17.0

Accessibility label text used for the control button when the macro mode is on.

accessibilityHintWhenOn
@property (nonatomic, copy, nullable) NSString *accessibilityHintWhenOn

Added in version 6.17.0

Accessibility hint text used for the control button when the macro mode is on.

- updateFromJSONString:error:
- (BOOL)updateFromJSONString:(nonnull NSString *)JSONString
                       error:(NSError **)error

Added in version 6.17.0

Updates the control according to a JSON serialization. See Serialization for details.

defaultAutoImage
@property (class, nonatomic, nonnull, readonly) UIImage *defaultAutoImage

Added in version 6.17.0

The default image used for the control button when the macro mode is auto.

defaultOffImage
@property (class, nonatomic, nonnull, readonly) UIImage *defaultOffImage

Added in version 6.17.0

The default image used for the control button when the macro mode is off.

defaultOnImage
@property (class, nonatomic, nonnull, readonly) UIImage *defaultOnImage

Added in version 6.17.0

The default image used for the control button when the macro mode is on.