Zoom Switch Control

Defined in package com.scandit.datacapture.core.ui

ZoomSwitchControl
class ZoomSwitchControl : Control

Added in version 6.10.0

Control that allows switching between configurable camera zoom levels. The available zoom levels are filtered based on the camera hardware capabilities.

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

ZoomSwitchControl()
ZoomSwitchControl(context: Context)

Added in version 6.10.0

Initializes a new ZoomSwitchControl.

zoomedOutImage
var zoomedOutImage: Bitmap

Added in version 6.10.0

Deprecated since version 8.4: This property is deprecated and will be removed in a future release.

The button image displayed when the zoom level is set to 1x.

zoomedOutPressedImage
var zoomedOutPressedImage: Bitmap

Added in version 6.10.0

Deprecated since version 8.4: This property is deprecated and will be removed in a future release.

The button image displayed when the zoom level is set to 1x and the button is pressed.

zoomedInImage
var zoomedInImage: Bitmap

Added in version 6.10.0

Deprecated since version 8.4: This property is deprecated and will be removed in a future release.

The button image displayed when the zoom level is set to 2x.

zoomedInPressedImage
var zoomedInPressedImage: Bitmap

Added in version 6.10.0

Deprecated since version 8.4: This property is deprecated and will be removed in a future release.

The button image displayed when the zoom level is set to 2x and pressed.

setZoomedOutImage(resId)
fun setZoomedOutImage(resId: Int)

Added in version 6.10.0

Deprecated since version 8.4: This method is deprecated and will be removed in a future release.

The button image resource displayed when the zoom level is set to 1x.

setZoomedOutPressedImage(resId)
fun setZoomedOutPressedImage(resId: Int)

Added in version 6.10.0

Deprecated since version 8.4: This method is deprecated and will be removed in a future release.

The button image resource displayed when the zoom level is set to 1x and the button is pressed.

setZoomedInImage(resId)
fun setZoomedInImage(resId: Int)

Added in version 6.10.0

Deprecated since version 8.4: This method is deprecated and will be removed in a future release.

The button image resource displayed when the zoom level is set to 2x.

setZoomedInPressedImage(resId)
fun setZoomedInPressedImage(resId: Int)

Added in version 6.10.0

Deprecated since version 8.4: This method is deprecated and will be removed in a future release.

The button image resource displayed when the zoom level is set to 2x and pressed.

defaultZoomedOutImage
val defaultZoomedOutImage: Bitmap

Added in version 6.10.0

Deprecated since version 8.4: This property is deprecated and will be removed in a future release.

The default button image displayed when the zoom level is set to 1x.

defaultZoomedOutPressedImage
val defaultZoomedOutPressedImage: Bitmap

Added in version 6.10.0

Deprecated since version 8.4: This property is deprecated and will be removed in a future release.

The default button image displayed when the zoom level is set to 1x and the button is pressed.

defaultZoomedInImage
val defaultZoomedInImage: Bitmap

Added in version 6.10.0

Deprecated since version 8.4: This property is deprecated and will be removed in a future release.

The default button image displayed when the zoom level is set to 2x.

defaultZoomedInPressedImage
val defaultZoomedInPressedImage: Bitmap

Added in version 6.10.0

Deprecated since version 8.4: This property is deprecated and will be removed in a future release.

The default button image displayed when the zoom level is set to 2x and pressed.

contentDescriptionWhenZoomedOut
var contentDescriptionWhenZoomedOut: String

Added in version 7.4.1

Deprecated since version 8.4: Use accessibilityLabel instead.

Content description text used for the control button when zoomed out (Android only).

contentDescriptionWhenZoomedIn
var contentDescriptionWhenZoomedIn: String

Added in version 7.4.1

Deprecated since version 8.4: Use accessibilityLabel instead.

Content description text used for the control button when zoomed in (Android only).

orientation
var orientation: ZoomSwitchOrientation

Added in version 8.4.0

The orientation of the zoom switch control. Defaults to ZoomSwitchOrientation.DEFAULT.

isAlwaysExpanded
var isAlwaysExpanded: Boolean

Added in version 8.4.0

When true, the control is always shown in its expanded state, displaying all zoom levels regardless of user interaction, and isExpanded is always true. When false, the control can be collapsed. Defaults to false.

isExpanded
var isExpanded: Boolean

Added in version 8.4.0

Whether the control is currently expanded, showing all zoom levels. Can be set programmatically to expand or collapse the control. When isAlwaysExpanded is true, this property always returns true and setting it has no effect.

selectedZoomLevel
val selectedZoomLevel: Float

Added in version 8.4.0

The currently selected zoom level.

accessibilityLabel
var accessibilityLabel: String

Added in version 8.4.0

The accessibility label. The placeholder <level> is replaced with the zoom factor of each button. Defaults to "Zoom <level>".

selectZoomLevel(zoomLevel)
fun selectZoomLevel(zoomLevel: Float): Float

Added in version 8.4.0

Selects the given zoom level, clamped to the range supported by the camera hardware. Returns the actual zoom level that was applied.