Class RemoteController

Handles everything needed to implement a fully working HomeKit remote controller.

Hierarchy

EventEmitter
- RemoteController
  - HomeKitRemoteController

Implements

Index

Constructors

constructor

new RemoteController(audioProducerConstructor?: SiriAudioStreamProducerConstructor, producerOptions?: any): RemoteController
Creates a new RemoteController. If siri voice input is supported the constructor to an SiriAudioStreamProducer needs to be supplied. Otherwise, a remote without voice support will be created.

For every audio session a new SiriAudioStreamProducer will be constructed.
Parameters
- Optional audioProducerConstructor: SiriAudioStreamProducerConstructor
  
  constructor for a SiriAudioStreamProducer
- Optional producerOptions: any
  
  if supplied this argument will be supplied as third argument of the SiriAudioStreamProducer constructor. This should be used to supply configurations to the stream producer.
Returns RemoteController
- Defined in lib/controller/RemoteController.ts:464

Properties

activeIdentifier

activeIdentifier: number = 0

targetConfigurations

targetConfigurations: Map<number, TargetConfiguration> = ...

Methods

addServicesToAccessory

addServicesToAccessory(accessory: Accessory): void
This method adds and configures the remote services for a give accessory.

Deprecated
- use configureController instead
Parameters
- accessory: Accessory
  
  the give accessory this remote should be added to
Returns void
- Defined in lib/controller/RemoteController.ts:590

emit

emit(event: "active-change", active: boolean): boolean
Parameters
- event: "active-change"
- active: boolean
Returns boolean
- Defined in lib/controller/RemoteController.ts:374
emit(event: "active-identifier-change", activeIdentifier: number): boolean
Parameters
- event: "active-identifier-change"
- activeIdentifier: number
Returns boolean
- Defined in lib/controller/RemoteController.ts:375
emit(event: "target-add", targetConfiguration: TargetConfiguration): boolean
Parameters
- event: "target-add"
- targetConfiguration: TargetConfiguration
Returns boolean
- Defined in lib/controller/RemoteController.ts:377
emit(event: "target-update", targetConfiguration: TargetConfiguration, updates: TargetUpdates[]): boolean
Parameters
- event: "target-update"
- targetConfiguration: TargetConfiguration
- updates: TargetUpdates[]
Returns boolean
- Defined in lib/controller/RemoteController.ts:378
emit(event: "target-remove", targetIdentifier: number): boolean
Parameters
- event: "target-remove"
- targetIdentifier: number
Returns boolean
- Defined in lib/controller/RemoteController.ts:379
emit(event: "targets-reset"): boolean
Parameters
- event: "targets-reset"
Returns boolean
- Defined in lib/controller/RemoteController.ts:380

getTargetIdentifierByName

getTargetIdentifierByName(name: string): undefined | number
Returns the targetIdentifier for a give device name

Returns
The targetIdentifier of the device or undefined if not existent.
Parameters
- name: string
  
  The name of the device.
Returns undefined | number
- Defined in lib/controller/RemoteController.ts:545

isActive

isActive(): boolean
Returns
if the current target is active, meaning the active device is listening for button events or audio sessions

Returns boolean
- Defined in lib/controller/RemoteController.ts:526

isConfigured

isConfigured(targetIdentifier: number): boolean
Checks if the supplied targetIdentifier is configured.
Parameters
- targetIdentifier: number
  
  The target identifier.
Returns boolean
- Defined in lib/controller/RemoteController.ts:535

on

on(event: "active-change", listener: ((active: boolean) => void)): RemoteController
Parameters
- event: "active-change"
- listener: ((active: boolean) => void)
  - - (active: boolean): void
    - Parameters
      
      active: boolean
      
      Returns void
Returns RemoteController
- Defined in lib/controller/RemoteController.ts:366
on(event: "active-identifier-change", listener: ((activeIdentifier: number) => void)): RemoteController
Parameters
- event: "active-identifier-change"
- listener: ((activeIdentifier: number) => void)
  - - (activeIdentifier: number): void
    - Parameters
      
      activeIdentifier: number
      
      Returns void
Returns RemoteController
- Defined in lib/controller/RemoteController.ts:367
on(event: "target-add", listener: ((targetConfiguration: TargetConfiguration) => void)): RemoteController
Parameters
- event: "target-add"
- listener: ((targetConfiguration: TargetConfiguration) => void)
  - - (targetConfiguration: TargetConfiguration): void
    - Parameters
      
      targetConfiguration: TargetConfiguration
      
      Returns void
Returns RemoteController
- Defined in lib/controller/RemoteController.ts:369
on(event: "target-update", listener: ((targetConfiguration: TargetConfiguration, updates: TargetUpdates[]) => void)): RemoteController
Parameters
- event: "target-update"
- listener: ((targetConfiguration: TargetConfiguration, updates: TargetUpdates[]) => void)
  - - (targetConfiguration: TargetConfiguration, updates: TargetUpdates[]): void
    - Parameters
      
      targetConfiguration: TargetConfiguration
      
      updates: TargetUpdates[]
      
      Returns void
Returns RemoteController
- Defined in lib/controller/RemoteController.ts:370
on(event: "target-remove", listener: ((targetIdentifier: number) => void)): RemoteController
Parameters
- event: "target-remove"
- listener: ((targetIdentifier: number) => void)
  - - (targetIdentifier: number): void
    - Parameters
      
      targetIdentifier: number
      
      Returns void
Returns RemoteController
- Defined in lib/controller/RemoteController.ts:371
on(event: "targets-reset", listener: (() => void)): RemoteController
Parameters
- event: "targets-reset"
- listener: (() => void)
  - - (): void
    - Returns void
Returns RemoteController
- Defined in lib/controller/RemoteController.ts:372

pushAndReleaseButton

pushAndReleaseButton(button: ButtonType, time?: number): void
Presses a supplied button for a given time.
Parameters
- button: ButtonType
  
  button to be pressed and released
- time: number = 200
  
  time in milliseconds (defaults to 200ms)
Returns void
- Defined in lib/controller/RemoteController.ts:579

pushButton

pushButton(button: ButtonType): void
Sends a button event to press the supplied button.
Parameters
- button: ButtonType
  
  button to be pressed
Returns void
- Defined in lib/controller/RemoteController.ts:560

releaseButton

releaseButton(button: ButtonType): void
Sends a button event that the supplied button was released.
Parameters
- button: ButtonType
  
  button which was released
Returns void
- Defined in lib/controller/RemoteController.ts:569

setActiveIdentifier

setActiveIdentifier(activeIdentifier: number): void
Set a new target as active target. A value of 0 indicates that no target is selected currently.
Parameters
- activeIdentifier: number
  
  target identifier
Returns void
- Defined in lib/controller/RemoteController.ts:502

Class RemoteController

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional audioProducerConstructor: SiriAudioStreamProducerConstructor

Optional producerOptions: any

Returns RemoteController

Properties

activeIdentifier

targetConfigurations

Methods

addServicesToAccessory

Deprecated

Parameters

accessory: Accessory

Returns void

emit

Parameters

event: "active-change"

active: boolean

Returns boolean

Parameters

event: "active-identifier-change"

activeIdentifier: number

Returns boolean

Parameters

event: "target-add"

targetConfiguration: TargetConfiguration

Returns boolean

Parameters

event: "target-update"

targetConfiguration: TargetConfiguration

updates: TargetUpdates[]

Returns boolean

Parameters

event: "target-remove"

targetIdentifier: number

Returns boolean

Parameters

event: "targets-reset"

Returns boolean

getTargetIdentifierByName

Returns

Parameters

name: string

Returns undefined | number

isActive

Returns

Returns boolean

isConfigured

Parameters

targetIdentifier: number

Returns boolean

on

Parameters

event: "active-change"

listener: ((active: boolean) => void)

Parameters

active: boolean

Returns void

Returns RemoteController

Parameters

event: "active-identifier-change"

listener: ((activeIdentifier: number) => void)

Parameters

activeIdentifier: number

Returns void

Returns RemoteController

Parameters

event: "target-add"

listener: ((targetConfiguration: TargetConfiguration) => void)

Parameters

targetConfiguration: TargetConfiguration

Returns void

`Optional` audioProducerConstructor: SiriAudioStreamProducerConstructor

`Optional` producerOptions: any