Deprecation warning

Please note that this is outdated documentation for an older release of the Scandit Barcode Scanner SDK.

We are deprecating the 5.x API on all platforms (except Linux). Release 5.19 in April 2021 will be our final. Applications running 5.x will continue to work, and we will continue to release critical bug fixes and security patches only, for one year. We encourage you to migrate to 6.x and take advantage of our latest / advanced features and improved performance.

You'll find the updated documentation at: Data Capture SDK Documentation for Xamarin.Android and Data Capture SDK Documentation for Xamarin.iOS

ScanOverlay Class Reference

Public Member Functions

 ScanOverlay ()
 

Properties

bool BeepEnabled [get, set]
 
CameraSwitchVisibility CameraSwitchVisibility [get, set]
 
GuiStyle GuiStyle [get, set]
 
bool TorchButtonVisible [get, set]
 
bool VibrateEnabled [get, set]
 
bool ViewFinderVisible [get, set]
 
Size ViewFinderSizePortrait [get, set]
 
Size ViewFinderSizeLandscape [get, set]
 

Detailed Description

Scan UI on top of the video preview stream.

The scan overlay is responsible for displaying the scan UI, e.g. the view finder as well as the highlighted barcodes. The scan overlay provides a variety of options to configure the look and feel of the UI.

Constructor & Destructor Documentation

Construct new ScanOverlay

You will not have to construct scan overlays yourself. This constructor is public for implementation purposes.

Property Documentation

bool BeepEnabled
getset

Whether the picker should beep whenever a code is scanned.

By default, a beep sound is played whenever a barcode is scanned. Set this property to false if you do not want beeping to be enabled.

Controls the visibility of the camera switch button

The camera switch button is shown as part of the barcode picker scan UI. It allows to switch between front and back cameras. By default, it is not visible. Use this property to make the button visible on all devices (CameraSwitchVisibility.Always) that have a front and back camera, or to enable it only on tablets (CameraSwitchVisibility.OnTablets) with front and back cameras.

Controls the scan UI style

Use this property to configure the scan UI style used. By default, a white rectangle is shown in the middle of the barcode picker view. Use this property to change the scan UI to show a laser line (GuiStyle.Laser), or to not show a view finder at all (GuiStyle.None).

bool TorchButtonVisible
getset

Whether the torch on/off button should be shown in the scan UI.

By default the torch button is visible. The torch icon is never shown when the camera does not have a torch (most tablets, front cameras, etc).

bool VibrateEnabled
getset

Whether the picker should vibrate whenever a code is scanned.

By default, the device vibrates whenever a code is scanned. Set this property to false to disable vibration.

bool ViewFinderVisible
getset

Whether the view finder frame should be shown.

By default the view finder is drawn as a white rectangle. By setting this property to false, the view finder rectangle is hidden. The logo remains visible, even if this property is set to false.

Size ViewFinderSizePortrait
getset

Set the view finder size in relative coordinate when the picker is in portrait.

Use this property to override the width and height of the view finder rectangle. To shift the center of the view finder rectangle, use ScanSettings.ScanningHotSpot. If your application supports rotation, make sure to also change the landscape view finder size (ViewFinderSizePortrait).

Size ViewFinderSizeLandscape
getset

Set the view finder size in relative coordinate when the picker is in landscape orientation

Use this property to override the width and height of the view finder rectangle. To shift the center of the view finder rectangle, use ScanSettings.ScanningHotSpot. If your application supports rotation, make sure to also change the portrait view finder size (ViewFinderSizePortrait).