Spotlight Viewfinder

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

Deprecated since version 6.8.0: Use RectangularViewfinder with style ROUNDED or SQUARE and non-zero dimming instead.

SpotlightViewfinder

class SpotlightViewfinder : Viewfinder

Added in version 6.0.0

Spotlight viewfinder with an embedded Scandit logo. The spotlight is always centered on the point of interest of the view.

The spotlight viewfinder is always displayed but the color of the border around the spotlight changes depending on whether the data capture mode is enabled or not.

To use this viewfinder, create a new instance and assign it to the overlay, e.g. the barcode capture overlay by assigning to the BarcodeCaptureOverlay.viewfinder property.

SpotlightViewfinder()

SpotlightViewfinder()

Added in version 6.0.0

Returns a new spotlight viewfinder with default parameters.

sizeWithUnitAndAspect

@NonNull SizeWithUnitAndAspect getSizeWithUnitAndAspect()

Added in version 6.0.0

The size and sizing mode of the viewfinder.

setSize(size)

void setSize(@NonNull SizeWithUnit size)

Added in version 6.0.0

Sets the horizontal and vertical size of the viewfinder to the provided value. When the unit is relative (unit in either x or y is MeasureUnit.FRACTION) the size is computed relative to the view size minus the scan area margins.

setWidthAndAspectRatio(width, heightToWidthAspectRatio)

void setWidthAndAspectRatio(@NonNull FloatWithUnit width,
        float heightToWidthAspectRatio)

Added in version 6.0.0

Sets the width of the viewfinder and compute height automatically based on the provided height/width aspect ratio. When the unit is relative (MeasureUnit.FRACTION), the width is computed relative to the view size minus the scan area margins.

setHeightAndAspectRatio(height, widthToHeightAspectRatio)

void setHeightAndAspectRatio(@NonNull FloatWithUnit height,
        float widthToHeightAspectRatio)

Added in version 6.0.0

Sets the height of the viewfinder and compute width automatically based on the provided width/height aspect ratio. When the unit is relative (MeasureUnit.FRACTION), the height is computed relative to the view size minus the scan area margins.

enabledBorderColor

int getEnabledBorderColor()
void setEnabledBorderColor(int value)

Added in version 6.0.0

The color used to draw the spotlight border when the data capture mode is enabled.

disabledBorderColor

int getDisabledBorderColor()
void setDisabledBorderColor(int value)

Added in version 6.0.0

The color used to draw the spotlight border when the data capture mode is disabled.

backgroundColor

int getBackgroundColor()
void setBackgroundColor(int value)

Added in version 6.0.0

The color used to draw the darkened area surrounding the spotlight.