RemoteControl

abstract class RemoteControl : Instrument.Provider, Peripheral.Provider
Content copied to clipboard

A generic remote control. This is the base class to manage a specific remote control.

Types

Model
Link copied to clipboard
enum Model : Enum<RemoteControl.Model> , DeviceModel
Content copied to clipboard

Drone model.

Functions

connect
Link copied to clipboard
abstract fun connect(): Boolean
Content copied to clipboard

Connects the remote control.

abstract fun connect(connector: DeviceConnector, vararg parameters: ConnectionParameter): Boolean
Content copied to clipboard

Connects the remote control using the specified device connector and custom parameters.

disconnect
Link copied to clipboard
abstract fun disconnect(): Boolean
Content copied to clipboard

Disconnects the remote control.

forget
Link copied to clipboard
abstract fun forget(): Boolean
Content copied to clipboard

Forgets the remote control.

getInstrument
Link copied to clipboard
@Nullable
abstract fun <I : Instrument> getInstrument(@NonNull instrumentClass: Class<I>): I?
Content copied to clipboard
@NonNull
abstract fun <I : Instrument> getInstrument(@NonNull instrumentClass: Class<I>, @NonNull observer: Ref.Observer<I>): Ref<I>
Content copied to clipboard
getName
Link copied to clipboard
abstract fun getName(observer: Ref.Observer<String>): Ref<String>
Content copied to clipboard

Gets the remote control friendly name and registers an observer notified each time it changes.

getPeripheral
Link copied to clipboard
@Nullable
abstract fun <P : Peripheral> getPeripheral(@NonNull peripheralClass: Class<P>): P?
Content copied to clipboard
@NonNull
abstract fun <P : Peripheral> getPeripheral(@NonNull peripheralClass: Class<P>, @NonNull observer: Ref.Observer<P>): Ref<P>
Content copied to clipboard
getState
Link copied to clipboard
abstract fun getState(observer: Ref.Observer<DeviceState>): Ref<DeviceState>
Content copied to clipboard

Gets current remote control state and registers an observer notified each time it changes.

Properties

model
Link copied to clipboard
abstract val model: RemoteControl.Model
Content copied to clipboard

Remote control model.

name
Link copied to clipboard
abstract val name: String
Content copied to clipboard

Remote control friendly name.

state
Link copied to clipboard
abstract val state: DeviceState
Content copied to clipboard

Remote control current state

uid
Link copied to clipboard
abstract val uid: String
Content copied to clipboard

Remote control unique identifier.