heos-api/dist/types/connection/heosConnection.d.ts

🎵 A zero-dependency low level api-wrapper for communicating with HEOS devices 🎵

/// <reference types="node" />
import { HeosEventEmitter, HeosConnectionEventEmitter, HeosAllEventEmitter, HeosConnectionAllEventEmitter } from '../listen/responseEventHandler';
import { HeosCommandAttribute } from '../types';
import { Socket } from 'net';
/**
 * An object representing a connection with a HEOS device, and provides methods to communicate with the connected HEOS device.
 * @remark All the methods returns a HeosConnection which means that they are chainable.
 */
export declare class HeosConnection {
    constructor(on: HeosEventEmitter, once: HeosEventEmitter, onAll: HeosAllEventEmitter, socket: Socket);
    private socket;
    private closed;
    /**
     * Adds listener to events. When the event happens the listener will be triggered with the response.
     * @param event The event to trigger the listener on.
     * @param listener A callback function that will be triggered when the event happens.
     * @returns A HeosConnection
     */
    on: HeosConnectionEventEmitter;
    /**
     * Adds a **one-time** listener for an event. When the event happens the listener will be triggered with the response.
     * @param event The event to trigger the listener on.
     * @param listener A callback function that will be triggered when the event happens.
     * @returns A HeosConnection
     */
    once: HeosConnectionEventEmitter;
    /**
     * Adds listener to all events. When any event happens the listener will be triggered with the response.
     * @param listener A callback function that will be triggered when the event happens.
     * @returns A HeosConnection
     */
    onAll: HeosConnectionAllEventEmitter;
    /**
     * Sends a command to the connected HEOS device. Check the [HEOS CLI Protocol Specification](http://rn.dmglobal.com/euheos/HEOS_CLI_ProtocolSpecification.pdf) to learn all the commands that can be sent.
     * @param commandGroup The command group
     * @param command The command to send
     * @param attributes Optional attributes to include with the command
     * @returns A HeosConnection
     */
    write(commandGroup: string, command: string, attributes?: HeosCommandAttribute): HeosConnection;
    /**
     * Closes the HeosConnection. It is still possible that the connected HEOS Device will send messages after calling this command.
     * @returns A promise that resolves when the connection is finished. No messages will be sent from the HEOS Device after the promise is resolved.
     */
    close(): Promise<void>;
    /**
     * Adds an event listener for when the connection is closed
     * @param listener A callback that is called when the connection is closed. `hadError` is true if there was a transmission error.
     */
    onClose(listener: (hadError: boolean) => void): HeosConnection;
    /**
     * Adds an event listener for when an error occurs.
     * @param listener A callback thar is called when an error occurs.
     */
    onError(listener: (error: Error) => void): HeosConnection;
}