README.md

Documentation / API / Output

(Interface) Stream extends Output

Interface

Implements Stream interface using:

import {Stream} from 'shairport-sync';

class CustomStream extends Stream
{
    // This method must return a readeable stream containing PCM Audio from 'shairport-sync' command
    get stream () {
        return myStream;
    }
}

Read Output reference for full implementation.

Properties

Output instances expose the folowing properties:

Name	Type	Read-Only	Default	Desciption
stream	stream.Readable	true		A readable stream that can be piped to any other library.

Built-in childs

Class	Type	Default	Description
Pipe	Class	false	Pipe the output stream through a file.
Stdout	Class	true	Pipe the output stream through stdout.