opticonnect sdk/com.opticon.opticonnect.sdk.api.scanner_settings.interfaces/ReadOptions

ReadOptions

interface ReadOptions

Interface defining methods for configuring scan options such as read modes, illumination, and barcode settings.

Provides both coroutine-based suspend functions for Kotlin and callback-based methods for Java interoperability.

Functions

Link copied to clipboard
abstract fun getIlluminationMode(deviceId: String): IlluminationMode

Gets the currently known illumination mode from the runtime settings state.

Link copied to clipboard
abstract fun getPositiveAndNegativeBarcodesMode(deviceId: String): PositiveAndNegativeBarcodesMode

Gets the currently known positive/negative barcode mode from the runtime settings state.

Link copied to clipboard
abstract fun getReadMode(deviceId: String): ReadMode

Gets the currently known read mode from the runtime settings state.

Link copied to clipboard
abstract fun getReadTime(deviceId: String): ReadTime

Gets the currently known read time from the runtime settings state.

Link copied to clipboard
abstract fun isAimingEnabled(deviceId: String): Boolean

Returns whether aiming is currently known to be enabled.

Link copied to clipboard
abstract fun isDeleteKeyEnabled(deviceId: String): Boolean

Returns whether the delete key is currently known to be enabled.

Link copied to clipboard
abstract fun isTriggerRepeatEnabled(deviceId: String): Boolean

Returns whether trigger repeat is currently known to be enabled.

Link copied to clipboard
abstract suspend fun setAiming(deviceId: String, enabled: Boolean): CommandResponse

Toggles the aiming feature for the scanner based on the enabled flag.

abstract fun setAiming(deviceId: String, enabled: Boolean, callback: Callback<CommandResponse>)

Callback-based version of setAiming for Java interoperability.

Link copied to clipboard
abstract suspend fun setDeleteKey(deviceId: String, enabled: Boolean): CommandResponse

Toggles the delete key feature for the scanner based on the enabled flag.

abstract fun setDeleteKey(deviceId: String, enabled: Boolean, callback: Callback<CommandResponse>)

Callback-based version of setDeleteKey for Java interoperability.

Link copied to clipboard
abstract suspend fun setIlluminationMode(deviceId: String, mode: IlluminationMode): CommandResponse

Sets the illumination mode for the scanner.

abstract fun setIlluminationMode(deviceId: String, mode: IlluminationMode, callback: Callback<CommandResponse>)

Callback-based version of setIlluminationMode for Java interoperability.

Link copied to clipboard
abstract suspend fun setPositiveAndNegativeBarcodesMode(deviceId: String, mode: PositiveAndNegativeBarcodesMode): CommandResponse

Sets the mode for reading positive and negative barcodes.

abstract fun setPositiveAndNegativeBarcodesMode(deviceId: String, mode: PositiveAndNegativeBarcodesMode, callback: Callback<CommandResponse>)

Callback-based version of setPositiveAndNegativeBarcodesMode for Java interoperability.

Link copied to clipboard
abstract suspend fun setReadMode(deviceId: String, mode: ReadMode): CommandResponse

Sets the read mode for the scanner.

abstract fun setReadMode(deviceId: String, mode: ReadMode, callback: Callback<CommandResponse>)

Callback-based version of setReadMode for Java interoperability.

Link copied to clipboard
abstract suspend fun setReadTime(deviceId: String, time: ReadTime): CommandResponse

Sets the read time for the scanner.

abstract fun setReadTime(deviceId: String, time: ReadTime, callback: Callback<CommandResponse>)

Callback-based version of setReadTime for Java interoperability.

Link copied to clipboard
abstract suspend fun setTriggerRepeat(deviceId: String, enabled: Boolean): CommandResponse

Toggles the trigger repeat feature for the scanner based on the enabled flag.

abstract fun setTriggerRepeat(deviceId: String, enabled: Boolean, callback: Callback<CommandResponse>)

Callback-based version of setTriggerRepeat for Java interoperability.