Interface InputController

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

interface InputController {
    doCommand: ((command) => Promise<StructType>);
    getEvents(extra?): Promise<inputControllerApi.Event.AsObject[]>;
    triggerEvent(event, extra?): Promise<void>;
}

Hierarchy (view full)

Resource
- InputController

Implemented by

InputControllerClient

Index

Properties

Methods

getEvents triggerEvent

Properties

doCommand

doCommand: ((command) => Promise<StructType>)

Send/Receive arbitrary commands to the resource.

Type declaration

- (command): Promise<StructType>
- Parameters
  - command: StructType
    The command to execute.
  Returns Promise<StructType>

Methods

getEvents

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

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: inputControllerApi.Event.AsObject
- Optional extra: StructType
Returns Promise<void>

Generated using TypeDoc