Everysight SDK/UIKit.app.interfaces/IEvsApp

IEvsApp

abstract class IEvsApp

The SDK Main entry point

The IEvsApp interface enables access to all SDK capabilities

Typical application flow:

start or startExt must be called in order to start working wth the SDK
The ApiKey should exist in the application assets (see UI guidelines or the samples projects)
comm for defining the glasses address and connect them
screens for displaying information on the glasses
stop to stop working with the SDK (terminates the SDK)

Constructors

constructor()

Functions

abstract fun auth(): IEvsAuthService

receive the SDK authentication service to handle the licensing flow

abstract fun comm(): IEvsCommunicationService

receive the communication service to handle the communication to the glasses

abstract fun display(): IEvsDisplayService

receive the display service to handle the glasses display

abstract fun getAddOn(addOnName: String): IEvsAddOn?

Get an add-on handling interface (if supported by the SDK)

abstract fun getSDKVersion(): String

Return the SDK version string

abstract fun glasses(): IEvsGlassesStateService

receive the glasses service to handle the glasses state

abstract fun hasOption(option: String): Boolean

The function return true if the option string exists in the options given in the startExt

abstract fun isReady(): Boolean

Returns true when the glasses are connected and authenticated with the SDK

abstract fun ota(): IEvsOtaService

receive the OTA service to handle the glasses firmware updates

registerAppEvents

abstract fun registerAppEvents(listener: IEvsAppEvents)

register to the application events

abstract fun screens(): IEvsScreenService

receive the screens service to handle the glasses UI screens

abstract fun sensors(): IEvsSensorsService

receive the sensors service to handle the glasses sensors

abstract fun showUI(name: String): Boolean

Enables to display a stock ui on the phone application, for ease development kickoff

abstract fun start(): Boolean

Starts the SDK

abstract fun startExt(options: HashSet<String>): Boolean

Starts the SDK with options

abstract fun stop(): Boolean

Stops the SDK

unregisterAppEvents

abstract fun unregisterAppEvents(listener: IEvsAppEvents)

unregister from application events