media-stream-library/dist/src/components/component.d.ts

Media stream library for Node & the Web.

import { Duplex, Readable, Stream, Writable } from 'stream';
import { GenericMessage, MessageHandler } from './message';
export type Component = Source | Tube | Sink;
type ErrorEventHandler = (err: Error) => void;
/**
 * Component
 *
 * A component is a set of bi-directional streams consisting of an 'incoming'
 * and 'outgoing' stream.
 *
 * They contain references to other components so they can form a linked list of
 * components, i.e. a pipeline. When linking components, the incoming and
 * outgoing streams are piped, so that data flowing through the incoming stream
 * is transfered to the next component, and data in the outgoing stream flows
 * to the previous component.
 *
 * Components at the end of such a pipeline typically connect the incoming and
 * outgoing streams to a data source or data sink.
 *
 * Typically, for a component that is connected to two other components, both
 * incoming and outgoing will be Transform streams. For a source, 'incoming'
 * will be a Readable stream and 'outgoing' a Writable stream, while for a sink
 * it is reversed. Both source and sink could also use a single Duplex stream,
 * with incoming === outgoing.
 *
 * server end-point                          client end-point
 *  /-------------      -----------------      -------------\
 *  |  Writable  |  <-  |   Transform   |  <-  |  Readable  |
 *  |   source   |      |      tube     |      |    sink    |
 *  |  Readable  |  ->  |   Transform   |  ->  |  Writable  |
 *  \-------------      -----------------      -------------/
 */
declare abstract class AbstractComponent {
    /**
     * The stream going towards the client end-point
     */
    abstract incoming: Stream;
    /**
     * The stream going back to the server end-point
     */
    abstract outgoing: Stream;
    /**
     * The next component (downstream, towards the client)
     */
    abstract next: Tube | Sink | null;
    /**
     * The previous component (upstream, towards the server)
     */
    abstract prev: Tube | Source | null;
    protected _incomingErrorHandler?: ErrorEventHandler;
    protected _outgoingErrorHandler?: ErrorEventHandler;
    /**
     * Connect a downstream component (towards the client)
     */
    abstract connect(next: Tube | Sink | null): Component;
    /**
     * Disconnect a downstream component downstream (towards the client)
     */
    abstract disconnect(): Component;
}
/**
 * Source component
 *
 * A component that can only have a next component connected (no previous) and
 * where the incoming and outgoing streams are connected to an external data
 * source.
 */
export declare class Source extends AbstractComponent {
    /**
     * Set up a source component that has a message list as data source.
     *
     * @param messages - List of objects (with data property) to emit on the
     * incoming stream
     */
    static fromMessages(messages: GenericMessage[]): Source;
    incoming: Readable;
    outgoing: Writable;
    next: Tube | Sink | null;
    prev: null;
    constructor(incoming?: Readable, outgoing?: Writable);
    /**
     * Attach another component so the the 'down' stream flows into the
     * next component 'down' stream and the 'up' stream of the other component
     * flows into the 'up' stream of this component. This is what establishes the
     * meaning of 'up' and 'down'.
     * @param  next - The component to connect.
     * @return A reference to the connected component.
     *
     *      -------------- pipe --------------
     *  <-  |  outgoing  |  <-  |  outgoing  | <-
     *      |    this    |      |    next    |
     *  ->  |  incoming  |  ->  |  incoming  | ->
     *      -------------- pipe --------------
     */
    connect(next: Tube | Sink | null): Component;
    /**
     * Disconnect the next connected component. When there is no next component
     * the function will just do nothing.
     * @return {Component} - A reference to this component.
     */
    disconnect(): Component;
}
/**
 * Tube component
 *
 * A component where both incoming and outgoing streams are Duplex streams, and
 * can be connected to a previous and next component, typically in the middle of
 * a pipeline.
 */
export declare class Tube extends Source {
    /**
     * Create a component that calls a handler function for each message passing
     * through, but otherwise just passes data through.
     *
     * Can be used to log messages passing through a pipeline.
     */
    static fromHandlers(fnIncoming: MessageHandler | undefined, fnOutgoing: MessageHandler | undefined): Tube;
    incoming: Duplex;
    outgoing: Duplex;
    constructor(incoming?: Duplex, outgoing?: Duplex);
}
/**
 * Sink component
 *
 * A component that can only have a previous component connected (no next) and
 * where the incoming and outgoing streams are connected to an external data
 * source.
 */
export declare class Sink extends AbstractComponent {
    /**
     * Create a component that swallows incoming data (calling fn on it).  To
     * print data, you would use fn = console.log.
     *
     * @param fn - The callback to use for the incoming data.
     */
    static fromHandler(fn: MessageHandler): Sink;
    incoming: Writable;
    outgoing: Readable;
    next: null;
    prev: Tube | Source | null;
    constructor(incoming?: Writable, outgoing?: Readable);
    connect(): Component;
    disconnect(): Component;
}
export {};