Torch Switch Control

Defined in framework ScanditCaptureCore

TorchSwitchControl

open class TorchSwitchControl : NSObject, Control

Added in version 6.0.0

Control that allows to toggle the torch on and off. The torch switch control hides itself automatically in case the active frame source doesn’t have a torch.

You can add this control to a view by calling DataCaptureView.addControl().

init

init()

Added in version 6.0.0

Constructor.

init

convenience init(fromJSONString JSONString: String) throws

Added in version 6.8.0

Constructs a new torch switch control with the provided JSON serialization.

torchOffImage

open var torchOffImage: UIImage { get, set }

Added in version 6.2.0

Sets the image encoded as a base64 string to use for the control button when the torch is off.

torchOffPressedImage

open var torchOffPressedImage: UIImage { get, set }

Added in version 6.2.0

Sets the image encoded as a base64 string to use for the control button when the torch is off and the button is pressed.

torchOnImage

open var torchOnImage: UIImage { get, set }

Added in version 6.2.0

Sets the image encoded as a base64 string to use for the control button when the torch is on.

torchOnPressedImage

open var torchOnPressedImage: UIImage { get, set }

Added in version 6.2.0

Sets the image encoded as a base64 string to use for the control button when the torch is on and the button is pressed.

accessibilityLabelWhenOff

open var accessibilityLabelWhenOff: String? { get, set }

Added in version 6.14.0

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

accessibilityHintWhenOff

open var accessibilityHintWhenOff: String? { get, set }

Added in version 6.14.0

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

accessibilityLabelWhenOn

open var accessibilityLabelWhenOn: String? { get, set }

Added in version 6.14.0

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

accessibilityHintWhenOn

open var accessibilityHintWhenOn: String? { get, set }

Added in version 6.14.0

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

update

open func update(fromJSONString JSONString: String) throws -> Void

Added in version 6.8.0

Updates the control according to a JSON serialization.

defaultTorchOffImage

open class var defaultTorchOffImage: UIImage { get }

Added in version 6.10.0

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

defaultTorchOffPressedImage

open class var defaultTorchOffPressedImage: UIImage { get }

Added in version 6.10.0

The default image used for the control button when the torch is off and the button is pressed.

defaultTorchOnImage

open class var defaultTorchOnImage: UIImage { get }

Added in version 6.10.0

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

defaultTorchOnPressedImage

open class var defaultTorchOnPressedImage: UIImage { get }

Added in version 6.10.0

The default image used for the control button when the torch is on and the button is pressed.