@sebbo2002/node-pyatv 8.1.3-develop.2 → 9.0.0-develop.2

package/dist/lib/index.d.ts

@@ -1,41 +1,6 @@
 import { SpawnOptions, ChildProcess } from 'child_process';
 import { EventEmitter } from 'events';
 
-/**
- * @internal
- */
-declare class FakeChildProcessStdIn extends EventEmitter {
-    write(data: string): void;
-}
-/**
- * @internal
- */
-declare class FakeChildProcess extends EventEmitter {
-    cmd: string;
-    args: ReadonlyArray<string>;
-    timeout: NodeJS.Timeout | undefined;
-    stdout: EventEmitter;
-    stderr: EventEmitter;
-    stdin: FakeChildProcessStdIn;
-    constructor(command: string, args: ReadonlyArray<string>, options: SpawnOptions, callback: (cp: FakeChildProcessController) => void);
-    kill(): void;
-}
-/**
- * @internal
- */
-declare class FakeChildProcessController {
-    _cp: FakeChildProcess;
-    _code: number | null;
-    constructor(cp: FakeChildProcess);
-    cmd(): string;
-    stdout(content: string | Record<string, unknown>): this;
-    stderr(content: string): this;
-    onStdIn(listener: (...args: any[]) => void): this;
-    error(error: Error): this;
-    code(exitCode: number): this;
-    end(content?: string | Record<string, unknown>): this;
-}
-
 /**
  * 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
@@ -44,39 +9,32 @@ declare class FakeChildProcessController {
  * It's also possible to send key commands by using [[pressKey]] or methods like [[pause]].
  */
 declare class NodePyATVDevice implements EventEmitter {
-    private readonly options;
-    private readonly state;
-    private readonly events;
-    constructor(options: NodePyATVDeviceOptions);
     /**
-     * Get the name of the Apple TV.
-     *
-     * ```typescript
-     * import pyatv from '@sebbo2002/node-pyatv';
-     * const devices = await pyatv.find();
-     * devices.forEach(device =>
-     *     console.log(device.name)
-     * );
-     * ```
+     * Get all IDs of the Apple TV.
+     * Requires pyatv >= 0.14.5.
      */
-    get name(): string;
+    get allIDs(): string[] | undefined;
     /**
-     * Get the IP address of the Apple TV.
+     * Returns true, if debugging is enabled. Returns the custom
+     * logging method, if one was specified. Otherwise, if debug
+     * log is disabled, returns undefined.
      */
-    get host(): string;
+    get debug(): ((msg: string) => void) | true | undefined;
     /**
-     * Get the ID of the Apple TV.
+     * Enable or disable debugging or set a custom
+     * debugging method to use.
+     *
+     * @param debug
      */
-    get id(): string | undefined;
+    set debug(debug: ((msg: string) => void) | true | undefined);
     /**
-     * Get all IDs of the Apple TV.
-     * Requires pyatv >= 0.14.5.
+     * Get the IP address of the Apple TV.
      */
-    get allIDs(): string[] | undefined;
+    get host(): string | undefined;
     /**
-     * Get the used protocol to connect to the Apple TV.
+     * Get the ID of the Apple TV.
      */
-    get protocol(): NodePyATVProtocol | undefined;
+    get id(): string | undefined;
     /**
      * Get the MAC address of the Apple TV.
      * Requires pyatv >= 0.14.5.
@@ -96,6 +54,18 @@ declare class NodePyATVDevice implements EventEmitter {
      * @example device.modelName → "Apple TV 4K"
      */
     get modelName(): string | undefined;
+    /**
+     * Get the name of the Apple TV.
+     *
+     * ```typescript
+     * import pyatv from '@sebbo2002/node-pyatv';
+     * const devices = await pyatv.find();
+     * devices.forEach(device =>
+     *     console.log(device.name)
+     * );
+     * ```
+     */
+    get name(): string;
     /**
      * Get the operating system of the device. Only set, if the
      * device was found with [[find()]]. Requires pyatv ≧ 0.10.3.
@@ -104,12 +74,9 @@ declare class NodePyATVDevice implements EventEmitter {
      */
     get os(): string | undefined;
     /**
-     * Get the device version. Only set, if the device was found
-     * during a scan using [[find()]]. Requires pyatv ≧ 0.10.3.
-     *
-     * @example device.version → "15.5.1"
+     * Get the used protocol to connect to the Apple TV.
      */
-    get version(): string | undefined;
+    get protocol(): NodePyATVProtocol | undefined;
     /**
      * Returns a list of services supported by the device. Ony set, if
      * the device was found during a scan using [[find()]]. Requires
@@ -128,232 +95,212 @@ declare class NodePyATVDevice implements EventEmitter {
      */
     get services(): NodePyATVService[] | undefined;
     /**
-     * Returns true, if debugging is enabled. Returns the custom
-     * logging method, if one was specified. Otherwise, if debug
-     * log is disabled, returns undefined.
-     */
-    get debug(): true | ((msg: string) => void) | undefined;
-    /**
-     * Enable or disable debugging or set a custom
-     * debugging method to use.
-     *
-     * @param debug
-     */
-    set debug(debug: true | ((msg: string) => void) | undefined);
-    /**
-     * Returns an object with `name`, `host`, `id` and `protocol`.
-     * Can be used to initiate a new device instance.
-     *
-     * @category Basic
-     */
-    toJSON(): {
-        name: string;
-        host: string;
-        id: string | undefined;
-        protocol: NodePyATVProtocol | undefined;
-    };
-    /**
-     * Returns a string. Just for debugging, etc.
+     * Get the device version. Only set, if the device was found
+     * during a scan using [[find()]]. Requires pyatv ≧ 0.10.3.
      *
-     * @category Basic
+     * @example device.version → "15.5.1"
      */
-    toString(): string;
+    get version(): string | undefined;
+    private readonly events;
+    private readonly options;
+    private readonly state;
+    constructor(options: NodePyATVDeviceOptions);
     /**
-     * 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.
-     *
-     * ```typescript
-     * await device.getState({maxAge: 10000}); // cache TTL: 10s
-     * ```
-     *
-     * @param options
-     * @category State
+     * Add an event listener. Will start the event subscription with the
+     * Apple TV as long as there are listeners for any event registered.
+     * @param event
+     * @param listener
+     * @category Event
      */
-    getState(options?: NodePyATVGetStateOptions): Promise<NodePyATVState>;
+    addListener(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this;
     /**
      * Removes the state node-pyatv cached for this device.
      *
      * @category State
      */
     clearState(): void;
-    private applyState;
     /**
-     * Get the date and time when the state was last updated.
-     * @param options
-     * @category State
+     * Send the "down" command
+     * @category Control
      */
-    getDateTime(options?: NodePyATVGetStateOptions): Promise<Date | null>;
+    down(): Promise<void>;
     /**
-     * Get the hash of the current media
-     * @param options
-     * @category State
+     * Emit an event.
+     * @param event
+     * @param payload
+     * @category Event
      */
-    getHash(options?: NodePyATVGetStateOptions): Promise<string | null>;
+    emit(event: string | symbol, payload: NodePyATVDeviceEvent): boolean;
     /**
-     * Get the media type of the current media
-     * @param options
-     * @category State
+     * Get all event names which are currently known.
+     * @category Event
      */
-    getMediaType(options?: NodePyATVGetStateOptions): Promise<NodePyATVMediaType | null>;
+    eventNames(): Array<string | symbol>;
     /**
-     * Get the state of this device (e.g. playing, etc.)
+     * Returns the album of the current playing media
      * @param options
      * @category State
      */
-    getDeviceState(options?: NodePyATVGetStateOptions): Promise<NodePyATVDeviceState | null>;
+    getAlbum(options?: NodePyATVGetStateOptions): Promise<null | string>;
     /**
-     * Returns the title of the current playing media
+     * Returns the currently used app
      * @param options
      * @category State
      */
-    getTitle(options?: NodePyATVGetStateOptions): Promise<string | null>;
+    getApp(options?: NodePyATVGetStateOptions): Promise<null | string>;
     /**
-     * Returns the artist of the current playing media
+     * Returns the id of the currently used app
      * @param options
      * @category State
      */
-    getArtist(options?: NodePyATVGetStateOptions): Promise<string | null>;
+    getAppId(options?: NodePyATVGetStateOptions): Promise<null | string>;
     /**
-     * Returns the album of the current playing media
+     * Returns the artist of the current playing media
      * @param options
      * @category State
      */
-    getAlbum(options?: NodePyATVGetStateOptions): Promise<string | null>;
+    getArtist(options?: NodePyATVGetStateOptions): Promise<null | string>;
     /**
-     * Returns the genre of the current playing media
+     * Returns the app specific content identifier
      * @param options
      * @category State
      */
-    getGenre(options?: NodePyATVGetStateOptions): Promise<string | null>;
+    getContentIdentifier(options?: NodePyATVGetStateOptions): Promise<null | string>;
     /**
-     * Returns the media length of the current playing media
+     * Get the date and time when the state was last updated.
      * @param options
      * @category State
      */
-    getTotalTime(options?: NodePyATVGetStateOptions): Promise<number | null>;
+    getDateTime(options?: NodePyATVGetStateOptions): Promise<Date | null>;
     /**
-     * Returns the title of the current playing media
+     * Get the state of this device (e.g. playing, etc.)
      * @param options
      * @category State
      */
-    getPosition(options?: NodePyATVGetStateOptions): Promise<number | null>;
+    getDeviceState(options?: NodePyATVGetStateOptions): Promise<NodePyATVDeviceState | null>;
     /**
-     * Returns the shuffle state
+     * Returns the episode number.
+     * Probably only set [if MRP is used](https://pyatv.dev/development/metadata/#currently-playing).
      * @param options
      * @category State
      */
-    getShuffle(options?: NodePyATVGetStateOptions): Promise<NodePyATVShuffleState | null>;
+    getEpisodeNumber(options?: NodePyATVGetStateOptions): Promise<null | number>;
     /**
-     * Returns the repeat state
+     * Returns the current focus state of the device
      * @param options
      * @category State
      */
-    getRepeat(options?: NodePyATVGetStateOptions): Promise<NodePyATVRepeatState | null>;
+    getFocusState(options?: NodePyATVGetStateOptions): Promise<NodePyATVFocusState | null>;
     /**
-     * Returns the currently used app
+     * Returns the genre of the current playing media
      * @param options
      * @category State
      */
-    getApp(options?: NodePyATVGetStateOptions): Promise<string | null>;
+    getGenre(options?: NodePyATVGetStateOptions): Promise<null | string>;
     /**
-     * Returns the id of the currently used app
+     * Get the hash of the current media
      * @param options
      * @category State
      */
-    getAppId(options?: NodePyATVGetStateOptions): Promise<string | null>;
+    getHash(options?: NodePyATVGetStateOptions): Promise<null | string>;
     /**
-     * Returns the current power state (= is it on or off, see [[NodePyATVPowerState]]) of the device.
+     * Returns the iTunes Store identifier if available.
+     * Requires pyatv >= 0.16.0
      * @param options
      * @category State
+     * @alias getiTunesStoreIdentifier
      */
-    getPowerState(options?: NodePyATVGetStateOptions): Promise<NodePyATVPowerState | null>;
+    getITunesStoreIdentifier(options?: NodePyATVGetStateOptions): Promise<null | number>;
+    getiTunesStoreIdentifier(options?: NodePyATVGetStateOptions): Promise<null | number>;
     /**
-     * Returns the current volume of the device in percent (0 - 100)
-     * @param options
-     * @category State
+     * Get max number of listeners allowed
+     * @category Event
      */
-    getVolume(options?: NodePyATVGetStateOptions): Promise<number | null>;
+    getMaxListeners(): number;
     /**
-     * Returns the current focus state of the device
+     * Get the media type of the current media
      * @param options
      * @category State
      */
-    getFocusState(options?: NodePyATVGetStateOptions): Promise<NodePyATVFocusState | null>;
+    getMediaType(options?: NodePyATVGetStateOptions): Promise<NodePyATVMediaType | null>;
     /**
      * Returns the current output devices of the device
      * @param options
      * @category State
      */
     getOutputDevices(options?: NodePyATVGetStateOptions): Promise<Array<{
-        name: string;
         identifier: string;
+        name: string;
     }> | null>;
     /**
-     * Returns the app specific content identifier
+     * Returns the title of the current playing media
      * @param options
      * @category State
      */
-    getContentIdentifier(options?: NodePyATVGetStateOptions): Promise<string | null>;
+    getPosition(options?: NodePyATVGetStateOptions): Promise<null | number>;
     /**
-     * Returns the iTunes Store identifier if available.
-     * Requires pyatv >= 0.16.0
+     * Returns the current power state (= is it on or off, see [[NodePyATVPowerState]]) of the device.
      * @param options
      * @category State
-     * @alias getiTunesStoreIdentifier
      */
-    getITunesStoreIdentifier(options?: NodePyATVGetStateOptions): Promise<number | null>;
-    getiTunesStoreIdentifier(options?: NodePyATVGetStateOptions): Promise<number | null>;
+    getPowerState(options?: NodePyATVGetStateOptions): Promise<NodePyATVPowerState | null>;
     /**
-     * Returns the episode number.
-     * Probably only set [if MRP is used](https://pyatv.dev/development/metadata/#currently-playing).
+     * Returns the repeat state
      * @param options
      * @category State
      */
-    getEpisodeNumber(options?: NodePyATVGetStateOptions): Promise<number | null>;
+    getRepeat(options?: NodePyATVGetStateOptions): Promise<NodePyATVRepeatState | null>;
     /**
      * Returns the season number.
      * Probably only set [if MRP is used](https://pyatv.dev/development/metadata/#currently-playing).
      * @param options
      * @category State
      */
-    getSeasonNumber(options?: NodePyATVGetStateOptions): Promise<number | null>;
+    getSeasonNumber(options?: NodePyATVGetStateOptions): Promise<null | number>;
     /**
      * Returns the season name.
      * Probably only set [if MRP is used](https://pyatv.dev/development/metadata/#currently-playing).
      * @param options
      * @category State
      */
-    getSeriesName(options?: NodePyATVGetStateOptions): Promise<string | null>;
+    getSeriesName(options?: NodePyATVGetStateOptions): Promise<null | string>;
     /**
-     * Returns the list of installed apps on the Apple TV. Probably requires `companionCredentials`,
-     * see https://pyatv.dev/documentation/atvremote/#apps for more details.
+     * Returns the shuffle state
+     * @param options
+     * @category State
      */
-    listApps(): Promise<NodePyATVApp[]>;
-    private _pressKeyWithScript;
-    private _pressKeyWithRemote;
+    getShuffle(options?: NodePyATVGetStateOptions): Promise<NodePyATVShuffleState | null>;
     /**
-     * Send a key press to the Apple TV
+     * 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.
      *
      * ```typescript
-     * await device.pressKey(NodePyATVKeys.home);
-     * ```
-     *
-     * <br />
-     *
-     * ```javascript
-     * await device.pressKey('home');
+     * await device.getState({maxAge: 10000}); // cache TTL: 10s
      * ```
      *
-     * @param key
-     * @category Control
+     * @param options
+     * @category State
      */
-    pressKey(key: NodePyATVKeys): Promise<void>;
+    getState(options?: NodePyATVGetStateOptions): Promise<NodePyATVState>;
     /**
-     * Send the "down" command
-     * @category Control
+     * Returns the title of the current playing media
+     * @param options
+     * @category State
      */
-    down(): Promise<void>;
+    getTitle(options?: NodePyATVGetStateOptions): Promise<null | string>;
+    /**
+     * Returns the media length of the current playing media
+     * @param options
+     * @category State
+     */
+    getTotalTime(options?: NodePyATVGetStateOptions): Promise<null | number>;
+    /**
+     * Returns the current volume of the device in percent (0 - 100)
+     * @param options
+     * @category State
+     */
+    getVolume(options?: NodePyATVGetStateOptions): Promise<null | number>;
     /**
      * Send the "home" command
      * @category Control
@@ -364,11 +311,36 @@ declare class NodePyATVDevice implements EventEmitter {
      * @category Control
      */
     homeHold(): Promise<void>;
+    /**
+     * Launch an application. Probably requires `companionCredentials`, see
+     * https://pyatv.dev/documentation/atvremote/#apps for more details.
+     * @param id App identifier, e.g. `com.netflix.Netflix`
+     */
+    launchApp(id: string): Promise<void>;
     /**
      * Send the "left" command
      * @category Control
      */
     left(): Promise<void>;
+    /**
+     * Returns the list of installed apps on the Apple TV. Probably requires `companionCredentials`,
+     * see https://pyatv.dev/documentation/atvremote/#apps for more details.
+     */
+    listApps(): Promise<NodePyATVApp[]>;
+    /**
+     * Get number of listeners for event
+     * @param event
+     * @category Event
+     */
+    listenerCount(event: string | symbol): number;
+    /**
+     * Get listeners for event. Will also return
+     * node-pyatv wrappers (e.g. once)
+     *
+     * @param event
+     * @category Event
+     */
+    listeners(event: string | symbol): Function[];
     /**
      * Send the "menu" command
      * @category Control
@@ -379,6 +351,31 @@ declare class NodePyATVDevice implements EventEmitter {
      * @category Control
      */
     next(): Promise<void>;
+    /**
+     * Remove an event listener. Will stop the event subscription with the
+     * Apple TV if this was the last event listener.
+     * @param event
+     * @param listener
+     * @category Event
+     */
+    off(event: string | symbol, listener: (event: Error | NodePyATVDeviceEvent) => void): this;
+    /**
+     * Add an event listener. Will start the event subscription with the
+     * Apple TV as long as there are listeners for any event registered.
+     * @param event
+     * @param listener
+     * @category Event
+     */
+    on(event: string | symbol, listener: (event: Error | NodePyATVDeviceEvent) => void): 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.
+     * @param event
+     * @param listener
+     * @category Event
+     */
+    once(event: string | symbol, listener: (event: Error | NodePyATVDeviceEvent) => void): this;
     /**
      * Send the "pause" command
      * @category Control
@@ -394,11 +391,62 @@ declare class NodePyATVDevice implements EventEmitter {
      * @category Control
      */
     playPause(): Promise<void>;
+    /**
+     * @param event
+     * @param listener
+     * @category Event
+     */
+    prependListener(event: string | symbol, listener: (event: Error | NodePyATVDeviceEvent) => void): this;
+    /**
+     * @param event
+     * @param listener
+     * @category Event
+     */
+    prependOnceListener(event: string | symbol, listener: (event: Error | NodePyATVDeviceEvent) => void): this;
+    /**
+     * Send a key press to the Apple TV
+     *
+     * ```typescript
+     * await device.pressKey(NodePyATVKeys.home);
+     * ```
+     *
+     * <br />
+     *
+     * ```javascript
+     * await device.pressKey('home');
+     * ```
+     *
+     * @param key
+     * @category Control
+     */
+    pressKey(key: NodePyATVKeys): Promise<void>;
     /**
      * Send the "previous" command
      * @category Control
      */
     previous(): Promise<void>;
+    /**
+     * @param event
+     * @category Event
+     */
+    rawListeners(event: string | symbol): Function[];
+    /**
+     * 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.
+     *
+     * @param event
+     * @category Event
+     */
+    removeAllListeners(event?: string | symbol): this;
+    /**
+     * Remove an event listener. Will stop the event subscription with the
+     * Apple TV if this was the last event listener.
+     * @param event
+     * @param listener
+     * @category Event
+     */
+    removeListener(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this;
     /**
      * Send the "right" command
      * @category Control
@@ -409,6 +457,11 @@ declare class NodePyATVDevice implements EventEmitter {
      * @category Control
      */
     select(): Promise<void>;
+    /**
+     * @param n
+     * @category Event
+     */
+    setMaxListeners(n: number): this;
     /**
      * Send the "skipBackward" command
      * @category Control
@@ -431,31 +484,23 @@ declare class NodePyATVDevice implements EventEmitter {
      */
     suspend(): Promise<void>;
     /**
-     * Send the "topMenu" command
-     * @category Control
-     */
-    topMenu(): Promise<void>;
-    /**
-     * Send the "up" command
-     * @category Control
-     */
-    up(): Promise<void>;
-    /**
-     * Send the "volumeDown" command
-     * @category Control
+     * Returns an object with `name`, `host`, `mac`, `id` and `protocol`.
+     * Can be used to initiate a new device instance.
+     *
+     * @category Basic
      */
-    volumeDown(): Promise<void>;
+    toJSON(): Pick<NodePyATVDeviceOptions, 'host' | 'id' | 'mac' | 'name' | 'protocol'>;
     /**
-     * Send the "volumeUp" command
+     * Send the "topMenu" command
      * @category Control
      */
-    volumeUp(): Promise<void>;
+    topMenu(): Promise<void>;
     /**
-     * Send the "wakeup" command
-     * @category Control
-     * @deprecated
+     * Returns a string. Just for debugging, etc.
+     *
+     * @category Basic
      */
-    wakeup(): Promise<void>;
+    toString(): string;
     /**
      * Send the "turn_off" command
      * @category Control
@@ -467,132 +512,66 @@ declare class NodePyATVDevice implements EventEmitter {
      */
     turnOn(): Promise<void>;
     /**
-     * Launch an application. Probably requires `companionCredentials`, see
-     * https://pyatv.dev/documentation/atvremote/#apps for more details.
-     * @param id App identifier, e.g. `com.netflix.Netflix`
-     */
-    launchApp(id: string): Promise<void>;
-    /**
-     * Add an event listener. Will start the event subscription with the
-     * Apple TV as long as there are listeners for any event registered.
-     * @param event
-     * @param listener
-     * @category Event
-     */
-    addListener(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this;
-    /**
-     * Emit an event.
-     * @param event
-     * @param payload
-     * @category Event
-     */
-    emit(event: string | symbol, payload: NodePyATVDeviceEvent): boolean;
-    /**
-     * Get all event names which are currently known.
-     * @category Event
-     */
-    eventNames(): Array<string | symbol>;
-    /**
-     * Get max number of listeners allowed
-     * @category Event
-     */
-    getMaxListeners(): number;
-    /**
-     * Get number of listeners for event
-     * @param event
-     * @category Event
-     */
-    listenerCount(event: string | symbol): number;
-    /**
-     * Get listeners for event. Will also return
-     * node-pyatv wrappers (e.g. once)
-     *
-     * @param event
-     * @category Event
-     */
-    listeners(event: string | symbol): Function[];
-    /**
-     * Remove an event listener. Will stop the event subscription with the
-     * Apple TV if this was the last event listener.
-     * @param event
-     * @param listener
-     * @category Event
-     */
-    off(event: string | symbol, listener: (event: NodePyATVDeviceEvent | Error) => void): this;
-    /**
-     * Add an event listener. Will start the event subscription with the
-     * Apple TV as long as there are listeners for any event registered.
-     * @param event
-     * @param listener
-     * @category Event
-     */
-    on(event: string | symbol, listener: (event: NodePyATVDeviceEvent | Error) => void): 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.
-     * @param event
-     * @param listener
-     * @category Event
-     */
-    once(event: string | symbol, listener: (event: NodePyATVDeviceEvent | Error) => void): this;
-    /**
-     * @param event
-     * @param listener
-     * @category Event
-     */
-    prependListener(event: string | symbol, listener: (event: NodePyATVDeviceEvent | Error) => void): this;
-    /**
-     * @param event
-     * @param listener
-     * @category Event
-     */
-    prependOnceListener(event: string | symbol, listener: (event: NodePyATVDeviceEvent | Error) => void): this;
-    /**
-     * @param event
-     * @category Event
+     * Send the "up" command
+     * @category Control
      */
-    rawListeners(event: string | symbol): Function[];
+    up(): Promise<void>;
     /**
-     * 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.
-     *
-     * @param event
-     * @category Event
+     * Send the "volumeDown" command
+     * @category Control
      */
-    removeAllListeners(event?: string | symbol): this;
+    volumeDown(): Promise<void>;
     /**
-     * Remove an event listener. Will stop the event subscription with the
-     * Apple TV if this was the last event listener.
-     * @param event
-     * @param listener
-     * @category Event
+     * Send the "volumeUp" command
+     * @category Control
      */
-    removeListener(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this;
+    volumeUp(): Promise<void>;
     /**
-     * @param n
-     * @category Event
+     * Send the "wakeup" command
+     * @category Control
+     * @deprecated
      */
-    setMaxListeners(n: number): this;
+    wakeup(): Promise<void>;
+    private _pressKeyWithRemote;
+    private _pressKeyWithScript;
+    private applyState;
 }
 
-declare enum NodePyATVExecutableType {
-    atvremote = "atvremote",
-    atvscript = "atvscript"
+/**
+ * @internal
+ */
+declare class FakeChildProcess extends EventEmitter {
+    args: ReadonlyArray<string>;
+    cmd: string;
+    stderr: EventEmitter;
+    stdin: FakeChildProcessStdIn;
+    stdout: EventEmitter;
+    timeout: NodeJS.Timeout | undefined;
+    constructor(command: string, args: ReadonlyArray<string>, options: SpawnOptions, callback: (cp: FakeChildProcessController) => void);
+    kill(): void;
 }
-declare enum NodePyATVProtocol {
-    dmap = "dmap",
-    mrp = "mrp",
-    airplay = "airplay",
-    mdns = "mdns"
+/**
+ * @internal
+ */
+declare class FakeChildProcessController {
+    _code: null | number;
+    _cp: FakeChildProcess;
+    constructor(cp: FakeChildProcess);
+    cmd(): string;
+    code(exitCode: number): this;
+    end(content?: Record<string, unknown> | string): this;
+    error(error: Error): this;
+    onStdIn(listener: (...args: any[]) => void): this;
+    stderr(content: string): this;
+    stdout(content: Record<string, unknown> | string): this;
 }
-declare enum NodePyATVMediaType {
-    music = "music",
-    tv = "tv",
-    video = "video",
-    unknown = "unknown"
+/**
+ * @internal
+ */
+declare class FakeChildProcessStdIn extends EventEmitter {
+    write(data: string): void;
 }
+
 declare enum NodePyATVDeviceState {
     idle = "idle",
     loading = "loading",
@@ -601,19 +580,9 @@ declare enum NodePyATVDeviceState {
     seeking = "seeking",
     stopped = "stopped"
 }
-declare enum NodePyATVRepeatState {
-    all = "all",
-    track = "track",
-    off = "off"
-}
-declare enum NodePyATVShuffleState {
-    albums = "albums",
-    songs = "songs",
-    off = "off"
-}
-declare enum NodePyATVPowerState {
-    on = "on",
-    off = "off"
+declare enum NodePyATVExecutableType {
+    atvremote = "atvremote",
+    atvscript = "atvscript"
 }
 declare enum NodePyATVFocusState {
     focued = "focused",
@@ -638,12 +607,12 @@ declare enum NodePyATVKeys {
     stop = "stop",
     suspend = "suspend",
     topMenu = "topMenu",
+    turnOff = "turnOff",
+    turnOn = "turnOn",
     up = "up",
     volumeDown = "volumeDown",
     volumeUp = "volumeUp",
-    wakeup = "wakeup",
-    turnOff = "turnOff",
-    turnOn = "turnOn"
+    wakeup = "wakeup"
 }
 declare enum NodePyATVListenerState {
     stopped = 0,
@@ -651,159 +620,185 @@ declare enum NodePyATVListenerState {
     started = 2,
     stopping = 3
 }
-type NodePyATVStateIndex = keyof NodePyATVState;
-type NodePyATVEventValueType = (string | number | NodePyATVMediaType | NodePyATVDeviceState | NodePyATVShuffleState | NodePyATVRepeatState);
-interface NodePyATVInstanceOptions {
-    atvremotePath?: string;
-    atvscriptPath?: string;
-    debug?: true | ((msg: string) => void);
-    noColors?: true;
-    spawn?: (command: string, args: Array<string>, options: SpawnOptions) => (ChildProcess | FakeChildProcess);
+declare enum NodePyATVMediaType {
+    music = "music",
+    tv = "tv",
+    unknown = "unknown",
+    video = "video"
 }
-interface NodePyATVRequestOptions extends NodePyATVInstanceOptions {
-    allowMultipleResponses?: boolean;
+declare enum NodePyATVPowerState {
+    off = "off",
+    on = "on"
 }
-interface NodePyATVVersionResponse {
-    pyatv: string | null;
-    module: string | null;
+declare enum NodePyATVProtocol {
+    airplay = "airplay",
+    dmap = "dmap",
+    mdns = "mdns",
+    mrp = "mrp"
+}
+declare enum NodePyATVRepeatState {
+    all = "all",
+    off = "off",
+    track = "track"
+}
+declare enum NodePyATVShuffleState {
+    albums = "albums",
+    off = "off",
+    songs = "songs"
+}
+interface NodePyATVApp {
+    id: string;
+    launch: () => Promise<void>;
+    name: string;
+}
+interface NodePyATVDeviceOptions extends NodePyATVFindAndInstanceOptions {
+    allIDs?: string[];
+    host?: string;
+    mac?: string;
+    model?: string;
+    modelName?: string;
+    name: string;
+    os?: string;
+    services?: NodePyATVService[];
+    version?: string;
+}
+type NodePyATVEventValueType = NodePyATVDeviceState | NodePyATVMediaType | NodePyATVRepeatState | NodePyATVShuffleState | number | string;
+interface NodePyATVFindAndInstanceOptions extends NodePyATVFindOptions, NodePyATVInstanceOptions {
 }
 interface NodePyATVFindOptions {
+    airplayCredentials?: string;
+    companionCredentials?: string;
+    dmapCredentials?: string;
     host?: string;
     hosts?: string[];
     id?: string;
-    protocol?: NodePyATVProtocol;
-    dmapCredentials?: string;
     mrpCredentials?: string;
-    airplayCredentials?: string;
-    companionCredentials?: string;
+    protocol?: NodePyATVProtocol;
     raopCredentials?: string;
 }
-interface NodePyATVFindAndInstanceOptions extends NodePyATVInstanceOptions, NodePyATVFindOptions {
-}
 interface NodePyATVFindResponseObject {
     devices: NodePyATVDevice[];
     errors: Record<string, unknown>[];
 }
-interface NodePyATVDeviceOptions extends NodePyATVFindAndInstanceOptions {
-    host: string;
-    name: string;
-    mac?: string;
-    model?: string;
-    modelName?: string;
-    os?: string;
-    version?: string;
-    services?: NodePyATVService[];
-    allIDs?: string[];
-}
 interface NodePyATVGetStateOptions {
     maxAge?: number;
 }
+interface NodePyATVInstanceOptions {
+    atvremotePath?: string;
+    atvscriptPath?: string;
+    debug?: ((msg: string) => void) | true;
+    noColors?: true;
+    spawn?: (command: string, args: Array<string>, options: SpawnOptions) => ChildProcess | FakeChildProcess;
+}
+interface NodePyATVRequestOptions extends NodePyATVInstanceOptions {
+    allowMultipleResponses?: boolean;
+}
 interface NodePyATVService {
-    protocol: NodePyATVProtocol;
     port: number;
+    protocol: NodePyATVProtocol;
 }
 interface NodePyATVState {
+    album: null | string;
+    app: null | string;
+    appId: null | string;
+    artist: null | string;
+    contentIdentifier: null | string;
     dateTime: Date | null;
-    hash: string | null;
-    mediaType: NodePyATVMediaType | null;
     deviceState: NodePyATVDeviceState | null;
-    title: string | null;
-    artist: string | null;
-    album: string | null;
-    genre: string | null;
-    totalTime: number | null;
-    position: number | null;
-    shuffle: NodePyATVShuffleState | null;
-    repeat: NodePyATVRepeatState | null;
-    app: string | null;
-    appId: string | null;
-    powerState: NodePyATVPowerState | null;
-    volume: number | null;
+    episodeNumber: null | number;
     focusState: NodePyATVFocusState | null;
+    genre: null | string;
+    hash: null | string;
+    iTunesStoreIdentifier: null | number;
+    mediaType: NodePyATVMediaType | null;
     outputDevices: Array<{
-        name: string;
         identifier: string;
+        name: string;
     }> | null;
-    contentIdentifier: string | null;
-    iTunesStoreIdentifier: number | null;
-    episodeNumber: number | null;
-    seasonNumber: number | null;
-    seriesName: string | null;
+    position: null | number;
+    powerState: NodePyATVPowerState | null;
+    repeat: NodePyATVRepeatState | null;
+    seasonNumber: null | number;
+    seriesName: null | string;
+    shuffle: NodePyATVShuffleState | null;
+    title: null | string;
+    totalTime: null | number;
+    volume: null | number;
 }
-interface NodePyATVApp {
-    id: string;
-    name: string;
-    launch: () => Promise<void>;
+type NodePyATVStateIndex = keyof NodePyATVState;
+interface NodePyATVVersionResponse {
+    module: null | string;
+    pyatv: null | string;
 }
 
 declare class NodePyATVDeviceEvent {
-    protected readonly values: {
-        key: NodePyATVStateIndex;
-        old: NodePyATVEventValueType;
-        new: NodePyATVEventValueType;
-        device: NodePyATVDevice;
-    };
     /**
-     *
-     * @param values
-     * @internal
+     * References the device instance this
+     * event originates from
      */
-    constructor(values: {
-        key: NodePyATVStateIndex;
-        old: NodePyATVEventValueType;
-        new: NodePyATVEventValueType;
-        device: NodePyATVDevice;
-    });
+    get device(): NodePyATVDevice;
     /**
      * References the attribute name which was changed. So if the
      * title has been updated, this would be `title`.
      */
     get key(): NodePyATVStateIndex;
+    /**
+     * @alias value
+     */
+    get newValue(): NodePyATVEventValueType;
     /**
      * Holds the old value which was there
      * before the value was changed.
      */
     get oldValue(): NodePyATVEventValueType;
-    /**
-     * @alias value
-     */
-    get newValue(): NodePyATVEventValueType;
     /**
      * New, current value for `key`
      */
     get value(): NodePyATVEventValueType;
+    protected readonly values: {
+        device: NodePyATVDevice;
+        key: NodePyATVStateIndex;
+        new: NodePyATVEventValueType;
+        old: NodePyATVEventValueType;
+    };
     /**
-     * References the device instance this
-     * event originates from
+     *
+     * @param values
+     * @internal
      */
-    get device(): NodePyATVDevice;
+    constructor(values: {
+        device: NodePyATVDevice;
+        key: NodePyATVStateIndex;
+        new: NodePyATVEventValueType;
+        old: NodePyATVEventValueType;
+    });
 }
 
 /**
  * @internal
  */
 declare class NodePyATVDeviceEvents extends EventEmitter {
-    private readonly options;
-    private readonly state;
     private readonly device;
+    private listenerState;
+    private readonly options;
     private pyatv;
+    private readonly state;
     private timeout;
-    private listenerState;
     constructor(state: NodePyATVState, device: NodePyATVDevice, options: NodePyATVDeviceOptions);
-    applyStateAndEmitEvents(newState: NodePyATVState): void;
-    private parsePushUpdate;
-    private applyPushUpdate;
-    private checkListener;
-    private startListening;
-    protected stopListening(reqId: string): Promise<void>;
     addListener(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this;
+    applyStateAndEmitEvents(newState: NodePyATVState): void;
+    listenerCount(event?: string | symbol): number;
+    off(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this;
     on(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this;
     once(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this;
     prependListener(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this;
-    off(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this;
     removeAllListeners(event?: string | symbol): this;
     removeListener(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this;
-    listenerCount(event?: string | symbol): number;
+    protected stopListening(reqId: string): Promise<void>;
+    private applyPushUpdate;
+    private checkListener;
+    private parsePushUpdate;
+    private startListening;
 }
 
 /**
@@ -816,6 +811,19 @@ declare class NodePyATVDeviceEvents extends EventEmitter {
  */
 declare class NodePyATVInstance {
     private readonly options;
+    /**
+     * Use this to apply [[NodePyATVInstanceOptions]]
+     * (e.g. debug log method) to all further requests
+     *
+     * ```typescript
+     * import pyatv from '@sebbo2002/node-pyatv';
+     * const myPyatv = new pyatv({debug: true});
+     * const devices = myPyatv.find();
+     * console.log(devices);
+     * ```
+     * @param options
+     */
+    constructor(options?: NodePyATVInstanceOptions);
     /**
      * Checks if pyatv is installed and ready to be used.
      * Will throw an error if not.
@@ -824,12 +832,12 @@ declare class NodePyATVInstance {
      */
     static check(options?: NodePyATVInstanceOptions): Promise<void>;
     /**
-     * Resolves with the version of pyatv and of the module itself.
-     * If a value can't be found, null is returned instead.
+     * Create a [[NodePyATVDevice]] to query the state and control it.
+     * At least `host` and `name` are required.
      *
      * @param options
      */
-    static version(options?: NodePyATVInstanceOptions): Promise<NodePyATVVersionResponse>;
+    static device(options: NodePyATVDeviceOptions): NodePyATVDevice;
     /**
      * Scan the network for Apple TVs by using pyatv's atvscript. See [[NodePyATVFindAndInstanceOptions]]
      * for the options allowed. Use the `host` / `hosts` attribute to filter by IP addresses. Resolves with
@@ -855,25 +863,12 @@ declare class NodePyATVInstance {
     static find(options?: NodePyATVFindAndInstanceOptions): Promise<NodePyATVDevice[]>;
     static find(options: NodePyATVFindAndInstanceOptions, returnDevicesAndErrors: true): Promise<NodePyATVFindResponseObject>;
     /**
-     * Create a [[NodePyATVDevice]] to query the state and control it.
-     * At least `host` and `name` are required.
-     *
-     * @param options
-     */
-    static device(options: NodePyATVDeviceOptions): NodePyATVDevice;
-    /**
-     * Use this to apply [[NodePyATVInstanceOptions]]
-     * (e.g. debug log method) to all further requests
+     * Resolves with the version of pyatv and of the module itself.
+     * If a value can't be found, null is returned instead.
      *
-     * ```typescript
-     * import pyatv from '@sebbo2002/node-pyatv';
-     * const myPyatv = new pyatv({debug: true});
-     * const devices = myPyatv.find();
-     * console.log(devices);
-     * ```
      * @param options
      */
-    constructor(options?: NodePyATVInstanceOptions);
+    static version(options?: NodePyATVInstanceOptions): Promise<NodePyATVVersionResponse>;
     /**
      * Checks if pyatv is installed and ready to be used.
      * Will throw an error if not.
@@ -882,12 +877,12 @@ declare class NodePyATVInstance {
      */
     check(options?: NodePyATVInstanceOptions): Promise<void>;
     /**
-     * Resolves with the version of pyatv and of the module itself.
-     * If a value can't be found, null is returned instead.
+     * Create a [[NodePyATVDevice]] to query the state and control it.
+     * At least `host` and `name` are required.
      *
      * @param options
      */
-    version(options?: NodePyATVInstanceOptions): Promise<NodePyATVVersionResponse>;
+    device(options: NodePyATVDeviceOptions): NodePyATVDevice;
     /**
      * Scan the network for Apple TVs by using pyatv's atvscript. See [[NodePyATVFindAndInstanceOptions]]
      * for the options allowed. Use the `host` / `hosts` attribute to filter by IP addresses. Resolves with
@@ -904,12 +899,12 @@ declare class NodePyATVInstance {
      */
     find(options?: NodePyATVFindAndInstanceOptions): Promise<NodePyATVDevice[]>;
     /**
-     * Create a [[NodePyATVDevice]] to query the state and control it.
-     * At least `host` and `name` are required.
+     * Resolves with the version of pyatv and of the module itself.
+     * If a value can't be found, null is returned instead.
      *
      * @param options
      */
-    device(options: NodePyATVDeviceOptions): NodePyATVDevice;
+    version(options?: NodePyATVInstanceOptions): Promise<NodePyATVVersionResponse>;
 }
 
 export { NodePyATVDevice, NodePyATVDeviceEvent, NodePyATVDeviceEvents, type NodePyATVDeviceOptions, NodePyATVDeviceState, type NodePyATVEventValueType, NodePyATVExecutableType, type NodePyATVFindAndInstanceOptions, type NodePyATVFindOptions, type NodePyATVFindResponseObject, type NodePyATVGetStateOptions, NodePyATVInstance, type NodePyATVInstanceOptions, NodePyATVKeys, NodePyATVListenerState, NodePyATVMediaType, NodePyATVPowerState, NodePyATVProtocol, NodePyATVRepeatState, type NodePyATVRequestOptions, type NodePyATVService, NodePyATVShuffleState, type NodePyATVState, type NodePyATVVersionResponse, NodePyATVInstance as default };