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

toJSON(): {
    host: string;
    id: string;
    name: string;
    protocol: NodePyATVProtocol;
}
Returns an object with name, host, id and protocol. Can be used to initiate a new device instance.

Returns {
    host: string;
    id: string;
    name: string;
    protocol: NodePyATVProtocol;
}
- host: string
- id: string
- name: string
- protocol: NodePyATVProtocol
- Defined in src/lib/device.ts:186

toString

toString(): string
Returns a string. Just for debugging, etc.

Returns string
- Defined in src/lib/device.ts:200

Control

down

down(): Promise<void>
Send the "down" command

Returns Promise<void>
- Defined in src/lib/device.ts:478

home

home(): Promise<void>
Send the "home" command

Returns Promise<void>
- Defined in src/lib/device.ts:486

homeHold

homeHold(): Promise<void>
Send the "homeHold" command

Returns Promise<void>
- Defined in src/lib/device.ts:494

left

left(): Promise<void>
Send the "left" command

Returns Promise<void>
- Defined in src/lib/device.ts:502

pause

pause(): Promise<void>
Send the "pause" command

Returns Promise<void>
- Defined in src/lib/device.ts:526

play

play(): Promise<void>
Send the "play" command

Returns Promise<void>
- Defined in src/lib/device.ts:534

playPause

playPause(): Promise<void>
Send the "playPause" command

Returns Promise<void>
- Defined in src/lib/device.ts:542

pressKey

pressKey(key): Promise<void>
Send a key press to the Apple TV
```
await device.pressKey(NodePyATVKeys.home);
```
```
await device.pressKey('home');
```
Parameters
- key: NodePyATVKeys
Returns Promise<void>
- Defined in src/lib/device.ts:458

previous(): Promise<void>
Send the "previous" command

Returns Promise<void>
- Defined in src/lib/device.ts:550

right

right(): Promise<void>
Send the "right" command

Returns Promise<void>
- Defined in src/lib/device.ts:558

select

select(): Promise<void>
Send the "select" command

Returns Promise<void>
- Defined in src/lib/device.ts:566

skipBackward

skipBackward(): Promise<void>
Send the "skipBackward" command

Returns Promise<void>
- Defined in src/lib/device.ts:574

skipForward

skipForward(): Promise<void>
Send the "skipForward" command

Returns Promise<void>
- Defined in src/lib/device.ts:582

stop

stop(): Promise<void>
Send the "stop" command

Returns Promise<void>
- Defined in src/lib/device.ts:590

suspend

suspend(): Promise<void>
Send the "suspend" command

Returns Promise<void>
Deprecated
- Defined in src/lib/device.ts:599

topMenu

topMenu(): Promise<void>
Send the "topMenu" command

Returns Promise<void>
- Defined in src/lib/device.ts:607

turnOff

turnOff(): Promise<void>
Send the "turn_off" command

Returns Promise<void>
- Defined in src/lib/device.ts:648

turnOn

turnOn(): Promise<void>
Send the "turn_on" command

Returns Promise<void>
- Defined in src/lib/device.ts:656

up

up(): Promise<void>
Send the "up" command

Returns Promise<void>
- Defined in src/lib/device.ts:615

volumeDown

volumeDown(): Promise<void>
Send the "volumeDown" command

Returns Promise<void>
- Defined in src/lib/device.ts:623

volumeUp

volumeUp(): Promise<void>
Send the "volumeUp" command

Returns Promise<void>
- Defined in src/lib/device.ts:631

wakeup

wakeup(): Promise<void>
Send the "wakeup" command

Returns Promise<void>
Deprecated
- Defined in src/lib/device.ts:640

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
- event: string | symbol
- listener: ((event) => void)
  - - (event): void
    - Parameters
      event: NodePyATVDeviceEvent
      Returns void
Returns this
Implementation of EventEmitter.addListener
- Defined in src/lib/device.ts:676

emit

emit(event, payload): boolean
Emit an event.
Parameters
- event: string | symbol
- payload: NodePyATVDeviceEvent
Returns boolean
Implementation of EventEmitter.emit
- Defined in src/lib/device.ts:687

eventNames

eventNames(): (string | symbol)[]
Get all event names which are currently known.

Returns (string | symbol)[]
Implementation of EventEmitter.eventNames
- Defined in src/lib/device.ts:695

getMaxListeners

getMaxListeners(): number
Get max number of listeners allowed

Returns number
Implementation of EventEmitter.getMaxListeners
- Defined in src/lib/device.ts:703

listenerCount

listenerCount(event): number
Get number of listeners for event
Parameters
- event: string | symbol
Returns number
Implementation of EventEmitter.listenerCount
- Defined in src/lib/device.ts:712

listeners

listeners(event): Function[]
Get listeners for event. Will also return node-pyatv wrappers (e.g. once)
Parameters
- event: string | symbol
Returns Function[]
Implementation of EventEmitter.listeners
- Defined in src/lib/device.ts:724

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
- event: string | symbol
- listener: ((event) => void)
  - - (event): void
    - Parameters
      event: Error | NodePyATVDeviceEvent
      Returns void
Returns this
Implementation of EventEmitter.off
- Defined in src/lib/device.ts:735

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
- event: string | symbol
- listener: ((event) => void)
  - - (event): void
    - Parameters
      event: Error | NodePyATVDeviceEvent
      Returns void
Returns this
Implementation of EventEmitter.on
- Defined in src/lib/device.ts:747

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
- event: string | symbol
- listener: ((event) => void)
  - - (event): void
    - Parameters
      event: Error | NodePyATVDeviceEvent
      Returns void
Returns this
Implementation of EventEmitter.once
- Defined in src/lib/device.ts:760

prependListener

prependListener(event, listener): this
Parameters
- event: string | symbol
- listener: ((event) => void)
  - - (event): void
    - Parameters
      event: Error | NodePyATVDeviceEvent
      Returns void
Returns this
Implementation of EventEmitter.prependListener
- Defined in src/lib/device.ts:770

prependOnceListener

prependOnceListener(event, listener): this
Parameters
- event: string | symbol
- listener: ((event) => void)
  - - (event): void
    - Parameters
      event: Error | NodePyATVDeviceEvent
      Returns void
Returns this
Implementation of EventEmitter.prependOnceListener
- Defined in src/lib/device.ts:780

rawListeners

rawListeners(event): Function[]
Parameters
- event: string | symbol
Returns Function[]
Implementation of EventEmitter.rawListeners
- Defined in src/lib/device.ts:790

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
- Optional event: string | symbol
Returns this
Implementation of EventEmitter.removeAllListeners
- Defined in src/lib/device.ts:802

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
- event: string | symbol
- listener: ((event) => void)
  - - (event): void
    - Parameters
      event: NodePyATVDeviceEvent
      Returns void
Returns this
Implementation of EventEmitter.removeListener
- Defined in src/lib/device.ts:814

setMaxListeners

setMaxListeners(n): this
Parameters
- n: number
Returns this
Implementation of EventEmitter.setMaxListeners
- Defined in src/lib/device.ts:823

Other

constructor

new NodePyATVDevice(options): NodePyATVDevice
Parameters
- options: NodePyATVDeviceOptions
Returns NodePyATVDevice
- Defined in src/lib/device.ts:35

allIDs

get allIDs(): string[]
Get all IDs of the Apple TV. Requires pyatv >= 0.14.5.

Returns string[]
- Defined in src/lib/device.ts:76

debug

get debug(): true | ((msg) => 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 true | ((msg) => void)
- Defined in src/lib/device.ts:161
set debug(debug): void
Enable or disable debugging or set a custom debugging method to use.
Parameters
- debug: true | ((msg) => void)
Returns void
- Defined in src/lib/device.ts:171

host

get host(): string
Get the IP address of the Apple TV.

Returns string
- Defined in src/lib/device.ts:61

id

get id(): string
Get the ID of the Apple TV.

Returns string
- Defined in src/lib/device.ts:68

mac

get mac(): string
Get the MAC address of the Apple TV. Requires pyatv >= 0.14.5.

Returns string
- Defined in src/lib/device.ts:91

model

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

Returns string
Example
```
device.model → "Gen4K"
```
- Defined in src/lib/device.ts:101

modelName

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

Returns string
Example
```
device.modelName → "Apple TV 4K"
```
- Defined in src/lib/device.ts:111

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(): string
Get the operating system of the device. Only set, if the device was found with [[find()]]. Requires pyatv ≧ 0.10.3.

Returns string
Example
```
device.os → "TvOS"
```
- Defined in src/lib/device.ts:121

protocol

get protocol(): NodePyATVProtocol
Get the used protocol to connect to the Apple TV.

Returns NodePyATVProtocol
- Defined in src/lib/device.ts:83

services

get services(): 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 NodePyATVService[]
Example
```
device.services → [
  {
    "protocol": "airplay",
    "port": 7000
  },
  {
    "protocol": "dmap",
    "port": 3689
  }
]
```
- Defined in src/lib/device.ts:151

version

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

Returns string
Example
```
device.version → "15.5.1"
```
- Defined in src/lib/device.ts:131

launchApp

launchApp(id): Promise<void>
Launch an application. Probably requires companionCredentials, see https://pyatv.dev/documentation/atvremote/#apps for more details.
Parameters
- id: string
  App identifier, e.g. com.netflix.Netflix
Returns Promise<void>
- Defined in src/lib/device.ts:665

listApps

listApps(): Promise<NodePyATVApp[]>
Returns the list of installed apps on the Apple TV. Probably requires companionCredentials, see https://pyatv.dev/documentation/atvremote/#apps for more details.

Returns Promise<NodePyATVApp[]>
- Defined in src/lib/device.ts:402

State

clearState

clearState(): void
Removes the state node-pyatv cached for this device.

Returns void
- Defined in src/lib/device.ts:250

getAlbum

getAlbum(options?): Promise<string>
Returns the album of the current playing media
Parameters
- options: NodePyATVGetStateOptions = {}
Returns Promise<string>
- Defined in src/lib/device.ts:323

getApp

getApp(options?): Promise<string>
Returns the currently used app
Parameters
- options: NodePyATVGetStateOptions = {}
Returns Promise<string>
- Defined in src/lib/device.ts:383

getAppId

getAppId(options?): Promise<string>
Returns the id of the currently used app
Parameters
- options: NodePyATVGetStateOptions = {}
Returns Promise<string>
- Defined in src/lib/device.ts:393

getArtist

getArtist(options?): Promise<string>
Returns the artist of the current playing media
Parameters
- options: NodePyATVGetStateOptions = {}
Returns Promise<string>
- Defined in src/lib/device.ts:313

getDateTime

getDateTime(options?): Promise<Date>
Get the date and time when the state was last updated.
Parameters
- options: NodePyATVGetStateOptions = {}
Returns Promise<Date>
- Defined in src/lib/device.ts:263

getDeviceState

getDeviceState(options?): Promise<NodePyATVDeviceState>
Get the state of this device (e.g. playing, etc.)
Parameters
- options: NodePyATVGetStateOptions = {}
Returns Promise<NodePyATVDeviceState>
- Defined in src/lib/device.ts:293

getGenre

getGenre(options?): Promise<string>
Returns the genre of the current playing media
Parameters
- options: NodePyATVGetStateOptions = {}
Returns Promise<string>
- Defined in src/lib/device.ts:333

getHash

getHash(options?): Promise<string>
Get the hash of the current media
Parameters
- options: NodePyATVGetStateOptions = {}
Returns Promise<string>
- Defined in src/lib/device.ts:273

getMediaType

getMediaType(options?): Promise<NodePyATVMediaType>
Get the media type of the current media
Parameters
- options: NodePyATVGetStateOptions = {}
Returns Promise<NodePyATVMediaType>
- Defined in src/lib/device.ts:283

getPosition

getPosition(options?): Promise<number>
Returns the title of the current playing media
Parameters
- options: NodePyATVGetStateOptions = {}
Returns Promise<number>
- Defined in src/lib/device.ts:353

getRepeat

getRepeat(options?): Promise<NodePyATVRepeatState>
Returns the repeat state
Parameters
- options: NodePyATVGetStateOptions = {}
Returns Promise<NodePyATVRepeatState>
- Defined in src/lib/device.ts:373

getShuffle

getShuffle(options?): Promise<NodePyATVShuffleState>
Returns the shuffle state
Parameters
- options: NodePyATVGetStateOptions = {}
Returns Promise<NodePyATVShuffleState>
- Defined in src/lib/device.ts:363

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
- options: NodePyATVGetStateOptions = {}
Returns Promise<NodePyATVState>
- Defined in src/lib/device.ts:216

getTitle

getTitle(options?): Promise<string>
Returns the title of the current playing media
Parameters
- options: NodePyATVGetStateOptions = {}
Returns Promise<string>
- Defined in src/lib/device.ts:303

getTotalTime

getTotalTime(options?): Promise<number>
Returns the media length of the current playing media
Parameters
- options: NodePyATVGetStateOptions = {}
Returns Promise<number>
- Defined in src/lib/device.ts:343

Class NodePyATVDevice

Implements

Index

Basic

Control

Event

Other

State

Basic

toJSON

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

host: string

id: string

name: string

protocol: NodePyATVProtocol

toString

Returns string

Control

down

Returns Promise<void>

home

Returns Promise<void>

homeHold

Returns Promise<void>

left

Returns Promise<void>

menu

Returns Promise<void>

next

Returns Promise<void>

pause

Returns Promise<void>

play

Returns Promise<void>

playPause

Returns Promise<void>

pressKey

Parameters

key: NodePyATVKeys

Returns Promise<void>

previous

Returns Promise<void>

right

Returns Promise<void>

select

Returns Promise<void>

skipBackward

Returns Promise<void>

skipForward

Returns Promise<void>

stop

Returns Promise<void>

suspend

Returns Promise<void>

Deprecated

topMenu

Returns Promise<void>

turnOff

Returns Promise<void>

turnOn

Returns Promise<void>

up

Returns Promise<void>

volumeDown

Returns Promise<void>

volumeUp

Returns Promise<void>

wakeup

Returns Promise<void>

Deprecated

Event

addListener

Parameters

event: string | symbol

listener: ((event) => void)

Parameters

event: NodePyATVDeviceEvent

Returns void

Returns this

emit

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

`Optional` event: string | symbol