Class HomeKitRemoteController

constructor

• new HomeKitRemoteController(audioProducerConstructor?, producerOptions?): HomeKitRemoteController

• 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 HomeKitRemoteController

activeIdentifier

targetConfigurations

addServicesToAccessory

• addServicesToAccessory(accessory): void

• This method adds and configures the remote services for a give accessory.

  Parameters

  • accessory: Accessory

    the give accessory this remote should be added to

  Returns void

  Deprecated

  • use Accessory.configureController instead

emit

• emit(event, active): boolean

• Parameters

  • event: "active-change"
  • active: boolean

  Returns boolean

• emit(event, activeIdentifier): boolean

• Parameters

  • event: "active-identifier-change"
  • activeIdentifier: number

  Returns boolean

• emit(event, targetConfiguration): boolean

• Parameters

  • event: "target-add"
  • targetConfiguration: TargetConfiguration

  Returns boolean

• emit(event, targetConfiguration, updates): boolean

• Parameters

  • event: "target-update"
  • targetConfiguration: TargetConfiguration
  • updates: TargetUpdates[]

  Returns boolean

• emit(event, targetIdentifier): boolean

• Parameters

  • event: "target-remove"
  • targetIdentifier: number

  Returns boolean

• emit(event): boolean

• Parameters

  • event: "targets-reset"

  Returns boolean

getTargetIdentifierByName

• getTargetIdentifierByName(name): undefined | number

• Returns the targetIdentifier for a give device name

  Parameters

  • name: string

    The name of the device.

  Returns undefined | number

  The targetIdentifier of the device or undefined if not existent.

isActive

• isActive(): boolean

• Returns boolean

  if the current target is active, meaning the active device is listening for button events or audio sessions

isConfigured

• isConfigured(targetIdentifier): boolean

• Checks if the supplied targetIdentifier is configured.

  Parameters

  • targetIdentifier: number

    The target identifier.

  Returns boolean

on

• on(event, listener): this

• Parameters

  • event: "active-change"
  • listener: ((active) => void)
    • • (active): void

      • Parameters

        • active: boolean

        Returns void

  Returns this

• on(event, listener): this

• Parameters

  • event: "active-identifier-change"
  • listener: ((activeIdentifier) => void)
    • • (activeIdentifier): void

      • Parameters

        • activeIdentifier: number

        Returns void

  Returns this

• on(event, listener): this

• Parameters

  • event: "target-add"
  • listener: ((targetConfiguration) => void)
    • • (targetConfiguration): void

      • Parameters

        • targetConfiguration: TargetConfiguration

        Returns void

  Returns this

• on(event, listener): this

• Parameters

  • event: "target-update"
  • listener: ((targetConfiguration, updates) => void)
    • • (targetConfiguration, updates): void

      • Parameters

        • targetConfiguration: TargetConfiguration
        • updates: TargetUpdates[]

        Returns void

  Returns this

• on(event, listener): this

• Parameters

  • event: "target-remove"
  • listener: ((targetIdentifier) => void)
    • • (targetIdentifier): void

      • Parameters

        • targetIdentifier: number

        Returns void

  Returns this

• on(event, listener): this

• Parameters

  • event: "targets-reset"
  • listener: (() => void)
    • • (): void

      • Returns void

  Returns this

pushAndReleaseButton

• pushAndReleaseButton(button, time?): 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

pushButton

• pushButton(button): void

• Sends a button event to press the supplied button.

  Parameters

  • button: ButtonType

    button to be pressed

  Returns void

releaseButton

• releaseButton(button): void

• Sends a button event that the supplied button was released.

  Parameters

  • button: ButtonType

    button which was released

  Returns void

setActiveIdentifier

• setActiveIdentifier(activeIdentifier): 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