Interface InputController

Represents a human interface device like a mouse or keyboard that emits events for controls.

interface InputController {
    doCommand(command): Promise<JsonValue>;
    getEvents(extra?): Promise<PlainMessage<Event>[]>;
    triggerEvent(event, extra?): Promise<void>;
}

Hierarchy (view full)

Resource
- InputController

Implemented by

InputControllerClient

Index

Methods

doCommand getEvents triggerEvent

Methods

doCommand

doCommand(command): Promise<JsonValue>
Send/Receive arbitrary commands to the resource.
Parameters
- command: Struct
  The command to execute.
Returns Promise<JsonValue>
Inherited from Resource.doCommand

getEvents

getEvents(extra?): Promise<PlainMessage<Event>[]>
Returns a list of events representing the last event on each control.
Parameters
- Optional extra: Struct
Returns Promise<PlainMessage<Event>[]>

triggerEvent

triggerEvent(event, extra?): Promise<void>
TriggerEvent, where supported, injects an InputControllerEvent into an input controller to (virtually) generate events like button presses or axis movements
Parameters
- event: PlainMessage<Event>
- Optional extra: Struct
Returns Promise<void>

Generated using TypeDoc