Everysight SDK/UIKit.services/IEvsAutoBrightnessController

IEvsAutoBrightnessController

interface IEvsAutoBrightnessController

Auto brightness controller interface for controlling the auto brightness mechanism

The auto brightness controller manages the auto brightness functionality, with the help of the supplied IEvsAutoBrightnessProvider

The auto brightness controller can be accessed via the IEvsDisplayService.autoBrightness function

The controller will persist and restore its last enable state, when having a provider via setProvider

Note:

Auto brightness can be achieved also by directly registering the Ambient sensor (see IEvsSensorsEvents). Using both mechanisms in parallel wil result in unexpected behaviour

See also

Functions

Link copied to clipboard
abstract fun addGain(deltaGain: Int)

Add deltaGain to the current gain

Link copied to clipboard
abstract fun enable(isEnabled: Boolean): Boolean

Enables the auto brightness functionality

Link copied to clipboard
abstract fun getGain(): Int

Returns the auto brightness gain 0-100 or -1 if no provider was set

Link copied to clipboard
abstract fun getIsAmbientSensorControl(): Boolean

Get the Ambient sensors control state

Link copied to clipboard
Link copied to clipboard
abstract fun hasProvider(): Boolean

Returns true if the auth brightness provider was set

Link copied to clipboard
abstract fun isEnabled(): Boolean

Returns the current enable state

Link copied to clipboard
abstract fun registerForAutoBriEvents(listener: IEvsAutoBrightnessEvents)

Register for the auto brightness events

Link copied to clipboard
abstract fun setGain(gain: Int)

Set the auto brightness gain 0-100

Link copied to clipboard
abstract fun setIsAmbientSensorControl(control: Boolean)

When true (default) the controller will enable\disable the glassed ambient sensor according to its internal logic

Link copied to clipboard
Link copied to clipboard
abstract fun unregisterForAutoBriEvents(listener: IEvsAutoBrightnessEvents)

Unregister for the auto brightness events