Symbology Description

Defined in package com.scandit.datacapture.barcode.data

Range

class Range

Added in version 6.0.0

Range()

Range(minimum: Int,
        maximum: Int,
        step: Int)

Added in version 6.0.0

Creates a new range object.

minimum

val minimum: Int

Added in version 6.0.0

Minimum of the range.

maximum

val maximum: Int

Added in version 6.0.0

Maximum of the range.

step

val step: Int

Added in version 6.0.0

Step of the range.

SymbologyDescription

class SymbologyDescription

Added in version 6.0.0

Description specific to a particular barcode symbology.

create(symbology)

fun SymbologyDescription.create(symbology: Symbology): SymbologyDescription

Added in version 6.0.0

Creates a new symbology description for a given barcode symbology.

forIdentifier(identifier)

fun SymbologyDescription.forIdentifier(identifier: String): SymbologyDescription?

Added in version 6.1.0

Gets the symbology description for a given identifier.

all()

fun SymbologyDescription.all(): List<SymbologyDescription>

Added in version 6.0.0

Gets a description of each available barcode symbology.

identifier

val identifier: String

Added in version 6.0.0

Identifier of the symbology associated with this description.

readableName

val readableName: String

Added in version 6.0.0

The human readable name of the symbology associated with this description.

isAvailable

val isAvailable: Boolean

Added in version 6.0.0

Determines whether the symbology associated with this description is available.

isColorInvertible

val isColorInvertible: Boolean

Added in version 6.0.0

Determines whether decoding of color-inverted (bright on dark) codes for the symbology associated with this description is available.

activeSymbolCountRange

val activeSymbolCountRange: Range

Added in version 6.0.0

The supported active symbol count range for the symbology associated with this description.

defaultSymbolCountRange

val defaultSymbolCountRange: Range

Added in version 6.1.0

The default symbol count range for the symbology associated with this description.

supportedExtensions

val supportedExtensions: Set<String>

Added in version 6.0.0

A list of extensions supported by the symbology associated with this description.

symbology

val symbology: Symbology

Added in version 6.1.0

The symbology associated with this description.

supportedChecksums

val supportedChecksums: EnumSet<Checksum>

Added in version 6.11.0

The supported checksums associated with this description.

toJson()

fun toJson(): String

Added in version 6.1.0

Returns the JSON representation of the symbology description.