Class NodePyATVDevice

Represents an Apple TV. Use [[getState]] to query the current state (e.g. media type and title). You can also use the attribute methods (e.g. [[getTitle]] to get the state. If you want realtime updates, subscribe to it's events with an EventEmitter like API, so for example by using [[on]], [[once]] or [[addListener]]. It's also possible to send key commands by using [[pressKey]] or methods like [[pause]].

Implements

  • EventEmitter

Basic

toJSON toString

Control

down home homeHold left menu next pause play playPause pressKey previous right select skipBackward skipForward stop suspend topMenu turnOff turnOn up volumeDown volumeUp wakeup

Event

addListener emit eventNames getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener setMaxListeners

Other

constructor allIDs debug host id mac model modelName name os protocol services version getiTunesStoreIdentifier launchApp listApps

State

clearState getAlbum getApp getAppId getArtist getContentIdentifier getDateTime getDeviceState getEpisodeNumber getFocusState getGenre getHash getITunesStoreIdentifier getMediaType getOutputDevices getPosition getPowerState getRepeat getSeasonNumber getSeriesName getShuffle getState getTitle getTotalTime getVolume

Basic

toJSON

  • toJSON(): {
        host: string;
        id: undefined | string;
        name: string;
        protocol: undefined | NodePyATVProtocol;
    }

  • Returns an object with name, host, id and protocol. Can be used to initiate a new device instance.

    Returns {
        host: string;
        id: undefined | string;
        name: string;
        protocol: undefined | NodePyATVProtocol;
    }

    • host: string
    • id: undefined | string
    • name: string
    • protocol: undefined | NodePyATVProtocol

toString

  • toString(): string

  • Returns a string. Just for debugging, etc.

    Returns string

Control

down

home

homeHold

  • homeHold(): Promise<void>

  • Send the "homeHold" command

    Returns Promise<void>

left

menu

next

pause

play

playPause

  • playPause(): Promise<void>

  • Send the "playPause" command

    Returns Promise<void>

pressKey

  • pressKey(key): Promise<void>

  • Send a key press to the Apple TV

    await device.pressKey(NodePyATVKeys.home);


    await device.pressKey('home');

    Parameters

    Returns Promise<void>

previous

  • previous(): Promise<void>

  • Send the "previous" command

    Returns Promise<void>

right

select

skipBackward

  • skipBackward(): Promise<void>

  • Send the "skipBackward" command

    Returns Promise<void>

skipForward

  • skipForward(): Promise<void>

  • Send the "skipForward" command

    Returns Promise<void>

stop

suspend

  • suspend(): Promise<void>

  • Send the "suspend" command

    Returns Promise<void>

    Deprecated

topMenu

turnOff

  • turnOff(): Promise<void>

  • Send the "turn_off" command

    Returns Promise<void>

turnOn

up

volumeDown

  • volumeDown(): Promise<void>

  • Send the "volumeDown" command

    Returns Promise<void>

volumeUp

  • volumeUp(): Promise<void>

  • Send the "volumeUp" command

    Returns Promise<void>

wakeup

  • wakeup(): Promise<void>

  • Send the "wakeup" command

    Returns Promise<void>

    Deprecated

Event

addListener

  • addListener(event, listener): this

  • Add an event listener. Will start the event subscription with the Apple TV as long as there are listeners for any event registered.

    Parameters

    Returns this

emit

eventNames

  • eventNames(): (string | symbol)[]

  • Get all event names which are currently known.

    Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

  • Get max number of listeners allowed

    Returns number

listenerCount

  • listenerCount(event): number

  • Get number of listeners for event

    Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event): Function[]

  • Get listeners for event. Will also return node-pyatv wrappers (e.g. once)

    Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event, listener): this

  • Remove an event listener. Will stop the event subscription with the Apple TV if this was the last event listener.

    Parameters

    Returns this

on

  • on(event, listener): this

  • Add an event listener. Will start the event subscription with the Apple TV as long as there are listeners for any event registered.

    Parameters

    Returns this

once

  • once(event, listener): this

  • Add an event listener. Will start the event subscription with the Apple TV as long as there are listeners for any event registered. Removes the listener automatically after the first occurrence.

    Parameters

    Returns this

prependListener

prependOnceListener

rawListeners

  • rawListeners(event): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?): this

  • Removes all listeners, either for the given event or for every event. Will stop the event subscription with the Apple TV if this was the last event listener.

    Parameters

    • Optionalevent: string | symbol

    Returns this

removeListener

  • removeListener(event, listener): this

  • Remove an event listener. Will stop the event subscription with the Apple TV if this was the last event listener.

    Parameters

    Returns this

setMaxListeners

  • setMaxListeners(n): this

  • Parameters

    • n: number

    Returns this

Other

constructor

allIDs

  • get allIDs(): undefined | string[]

  • Get all IDs of the Apple TV. Requires pyatv >= 0.14.5.

    Returns undefined | string[]

debug

  • get debug(): undefined | true | ((msg: string) => void)

  • Returns true, if debugging is enabled. Returns the custom logging method, if one was specified. Otherwise, if debug log is disabled, returns undefined.

    Returns undefined | true | ((msg: string) => void)

  • set debug(debug): void

  • Enable or disable debugging or set a custom debugging method to use.

    Parameters

    • debug: undefined | true | ((msg: string) => void)

    Returns void

host

id

  • get id(): undefined | string

  • Get the ID of the Apple TV.

    Returns undefined | string

mac

  • get mac(): undefined | string

  • Get the MAC address of the Apple TV. Requires pyatv >= 0.14.5.

    Returns undefined | string

model

  • get model(): undefined | string

  • Get the model identifier of the device. Only set, if the device was found using [[find()]]. Requires pyatv ≧ 0.10.3.

    Returns undefined | string

    Example

    device.model → "Gen4K"

modelName

  • get modelName(): undefined | string

  • Get the model name of the device. Only set, if the device was found with [[find()]]. Requires pyatv ≧ 0.10.3.

    Returns undefined | string

    Example

    device.modelName → "Apple TV 4K"

name

  • get name(): string

  • Get the name of the Apple TV.

    import pyatv from '@sebbo2002/node-pyatv';
    const devices = await pyatv.find();
    devices.forEach(device =>
        console.log(device.name)
    );

    Returns string

os

  • get os(): undefined | string

  • Get the operating system of the device. Only set, if the device was found with [[find()]]. Requires pyatv ≧ 0.10.3.

    Returns undefined | string

    Example

    device.os → "TvOS"

protocol

services

  • get services(): undefined | NodePyATVService[]

  • Returns a list of services supported by the device. Ony set, if the device was found during a scan using [[find()]]. Requires pyatv ≧ 0.10.3.

    Returns undefined | NodePyATVService[]

    Example

    device.services → [
      {
        "protocol": "airplay",
        "port": 7000
      },
      {
        "protocol": "dmap",
        "port": 3689
      }
    ]

version

  • get version(): undefined | string

  • Get the device version. Only set, if the device was found during a scan using [[find()]]. Requires pyatv ≧ 0.10.3.

    Returns undefined | string

    Example

    device.version → "15.5.1"

getiTunesStoreIdentifier

launchApp

listApps

State

clearState

  • clearState(): void

  • Removes the state node-pyatv cached for this device.

    Returns void

getAlbum

getApp

getAppId

getArtist

getContentIdentifier

getDateTime

getDeviceState

getEpisodeNumber

getFocusState

  • getFocusState(options?): Promise<null | NodePyATVFocusState>

  • Returns the current focus state of the device

    Parameters

    Returns Promise<null | NodePyATVFocusState>

getGenre

getHash

getITunesStoreIdentifier

  • getITunesStoreIdentifier(options?): Promise<null | number>

  • Returns the iTunes Store identifier if available. Requires pyatv >= 0.16.0

    Parameters

    Returns Promise<null | number>

    Alias

    getiTunesStoreIdentifier

getMediaType

getOutputDevices

  • getOutputDevices(options?): Promise<null | {
        identifier: string;
        name: string;
    }[]>

  • Returns the current output devices of the device

    Parameters

    Returns Promise<null | {
        identifier: string;
        name: string;
    }[]>

getPosition

getPowerState

getRepeat

getSeasonNumber

getSeriesName

getShuffle

getState

  • getState(options?): Promise<NodePyATVState>

  • Returns an [[NodePyATVState]] object representing the current state of the device. Has an internal cache, which has a default TTL of 5s. You can change this default value by passing the maxAge option.

    await device.getState({maxAge: 10000}); // cache TTL: 10s

    Parameters

    Returns Promise<NodePyATVState>

getTitle

getTotalTime

getVolume

Settings

Member Visibility

On This Page

Basic
Control
Event
Other
State