Camera Settings#

Defined under the namespace Scandit.Datacapture.Core

CameraPosition#

Added in version 6.1.0

WorldFacing#

Added in version 6.1.0

The camera is attached at the back of the device and is facing away from the user.

UserFacing#

Added in version 6.1.0

The camera is attached on the front of the device and facing towards the user.

Unspecified#

Added in version 6.1.0

The camera position is unspecified.

VideoResolution#

Added in version 6.1.0

HD#

Added in version 6.1.0

Resolution is 1280x720.

FullHD#

Added in version 6.1.0

Resolution is 1920x1080.

UHD4K#

Added in version 6.1.0

Resolution is 3840x2160. Usage of this resolution is not part of the base license. If you would like to use it, please contact us at support@scandit.com.

On Android this requires camera API 2. Devices that are known to support API 2 well will automatically switch to use it when this resolution is set.

Note

To make use of the automatic switch to API 2, make sure that you instantiate the camera directly with the settings instead of using Camera.applySettings().

Auto#

Added in version 6.1.0

In contrast to FullHD, and HD, Auto will select the resolution based on hardware capabilities and/or scan-performance considerations. The chosen resolution may change in future versions of the software.

FocusRange#

Added in version 6.1.0

Enumeration of possible focus ranges to use. This can be used to restrict the auto-focus system to only consider objects in a certain range to focus on.

Full#

Added in version 6.1.0

Use the full focus range supported by the camera.

Near#

Added in version 6.1.0

Only focus on objects that are near to the camera.

Far#

Added in version 6.1.0

Only focus on objects that are far from the camera.

CameraSettings#
class CameraSettings

Added in version 6.1.0

Holds camera-specific settings such as preferred resolution, maximum frame rate etc. The defaults are chosen such that they work for a wide variety of use cases. You may apply custom settings to further optimize scan performance for your particular use case. There is typically no need to customize the camera settings beyond changing the preferred resolution.

constructor()#
constructor()

Added in version 6.1.0

Creates new default camera settings. maxFrameRate is set to 30, zoomFactor is set to 1 and preferredResolution is set to VideoResolution.Auto.

constructor(settings)
constructor(settings: CameraSettings)

Added in version 6.1.0

Creates a copy of the provided settings.

Holds camera related settings such as preview resolution and maximum frame rate to use.

preferredResolution#
preferredResolution: VideoResolution

Added in version 6.1.0

The preferred resolution to use for the camera. The camera will use the resolution that is closests to the resolution preference. For example, if only lower resolutions than the preferred resolution are available, the highest available resolution will be used.

The resolution chosen by the camera only takes the preferredResolution into account, it does not consider the resolution limit of your license key. When the device selects a resolution that is larger than what you have licensed, the data capture context will report a license status error.

The default value is VideoResolution.Auto.

maxFrameRate#
maxFrameRate: number

Added in version 6.1.0

The maximum frame rate to use for the camera. If the value is higher than the maximum available frame rate of the device, it will be set to the device’s maximum.

The default value is 30 Hz.

zoomFactor#
zoomFactor: number

Added in version 6.1.0

The zoom factor to use for the camera. This value is a multiplier, a value of 1.0 means no zoom, while a value of 2.0 doubles the size of the image, but halves the field of view.

Values less than 1.0 are treated as 1.0. Values greater than the maximum available zoom factor are clamped to the maximum accepted value.

The default zoom factor is 1.0.

focusRange#
focusRange: FocusRange

Added in version 6.1.0

The focus range to primarily use, if supported by the device.

On Android changing this property has no effect.

setProperty(name, value)#
setProperty(name: string,
        value: any): void

Added in version 6.2.1

Set camera property to the provided value. Use this method to set properties that are not yet part of a stable API. Properties set through this method may or may not be used or change in a future release.

getProperty(name)#
getProperty(name: string): any

Added in version 6.2.1

Retrieves the value of a previously set camera property. In case the property does not exist, null is returned.