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

Indicator

interface Indicator

Interface that provides methods for controlling scanner indicator options.

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

Functions

Link copied to clipboard
abstract fun getBuzzerDuration(deviceId: String): BuzzerDuration

Gets the current buzzer duration from the SDK's runtime settings state.

Link copied to clipboard
abstract fun getBuzzerType(deviceId: String): BuzzerType

Gets the current buzzer type from the SDK's runtime settings state.

Link copied to clipboard
abstract fun getBuzzerVolume(deviceId: String): Int

Gets the current persistent buzzer volume from the SDK's runtime settings state.

Link copied to clipboard
abstract fun getGoodReadLedDuration(deviceId: String): GoodReadLedDuration

Gets the current good-read LED duration from the SDK's runtime settings state.

Link copied to clipboard
abstract fun getLED(deviceId: String): LEDColor

Gets the current persistent LED color from the SDK's runtime settings state.

Link copied to clipboard
abstract fun getVibratorDuration(deviceId: String): VibratorDuration

Gets the current vibrator duration from the SDK's runtime settings state.

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

Gets the current buzzer enabled state from the SDK's runtime settings state.

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

Gets the current vibrator enabled state from the SDK's runtime settings state.

Link copied to clipboard
abstract suspend fun setBuzzerDuration(deviceId: String, duration: BuzzerDuration): CommandResponse

Sets the duration of the buzzer sound for the given deviceId.

abstract fun setBuzzerDuration(deviceId: String, duration: BuzzerDuration, callback: Callback<CommandResponse>)

Callback-based version of setBuzzerDuration for Java interoperability.

Link copied to clipboard
abstract suspend fun setBuzzerType(deviceId: String, type: BuzzerType): CommandResponse

Sets the buzzer type for the given deviceId.

abstract fun setBuzzerType(deviceId: String, type: BuzzerType, callback: Callback<CommandResponse>)

Callback-based version of setBuzzerType for Java interoperability.

Link copied to clipboard
abstract suspend fun setBuzzerVolume(deviceId: String, volume: Int): CommandResponse

Sets the volume of the buzzer for the given deviceId.

abstract fun setBuzzerVolume(deviceId: String, volume: Int, callback: Callback<CommandResponse>)

Callback-based version of setBuzzerVolume for Java interoperability.

Link copied to clipboard
abstract suspend fun setGoodReadLedDuration(deviceId: String, duration: GoodReadLedDuration): CommandResponse

Sets the good read LED duration for the given deviceId.

abstract fun setGoodReadLedDuration(deviceId: String, duration: GoodReadLedDuration, callback: Callback<CommandResponse>)

Callback-based version of setGoodReadLedDuration for Java interoperability.

Link copied to clipboard
abstract suspend fun setLED(deviceId: String, color: LEDColor): CommandResponse

Sets the LED color for the given deviceId.

abstract fun setLED(deviceId: String, color: LEDColor, callback: Callback<CommandResponse>)

Callback-based version of setLED for Java interoperability.

Link copied to clipboard
abstract suspend fun setVibratorDuration(deviceId: String, duration: VibratorDuration): CommandResponse

Sets the duration of the vibration for the given deviceId.

abstract fun setVibratorDuration(deviceId: String, duration: VibratorDuration, callback: Callback<CommandResponse>)

Callback-based version of setVibratorDuration for Java interoperability.

Link copied to clipboard
abstract suspend fun testBuzzerVolume(deviceId: String, volume: Int): CommandResponse

Tests the volume without storing it (non-persistent).

abstract fun testBuzzerVolume(deviceId: String, volume: Int, callback: Callback<CommandResponse>)

Callback-based version of testBuzzerVolume for Java interoperability.

Link copied to clipboard
abstract suspend fun testLED(deviceId: String, color: LEDColor): CommandResponse

Tests the LED by setting the color temporarily (non-persistent).

abstract fun testLED(deviceId: String, color: LEDColor, callback: Callback<CommandResponse>)

Callback-based version of testLED for Java interoperability.

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

Toggles the buzzer on or off for the given deviceId.

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

Callback-based version of toggleBuzzer for Java interoperability.

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

Toggles the vibrator on or off for the given deviceId.

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

Callback-based version of toggleVibrator for Java interoperability.