@ceeblue/webrtc-client
    Preparing search index...

    Interface IStreamData

    IStreamData is an interface to get JSON data from a stream, parse it and fire the onData callback It can receive data from multiple tracks.

    interface IStreamData {
        log: ILog;
        get closed(): boolean;
        get tracks(): number[];
        set tracks(tracks: number[]): void;
        get url(): string;
        close(): void;
        off(name: "data" | "close" | "Close" | "Data", event: Function): boolean;
        on(
            name: "data" | "close" | "Close" | "Data",
            event: Function,
            options?: { signal?: AbortSignal },
        ): void;
        once(
            name: "data" | "close" | "Close" | "Data",
            event: Function,
            options?: { signal?: AbortSignal },
        ): void;
        onClose(error?: WebSocketReliableError): void;
        onData(time: number, track: number, data: any): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    log

    Accessors

    closed tracks url

    Methods

    close off on once

    Events

    onClose onData

    Properties

    log: ILog

    Start a log

    a Log object with the levels of log to call

    Accessors

    • get closed(): boolean

      True when connection is closed, in other words when onClose event is fired

      Returns boolean

    Methods

    • Event unsubscription

      Parameters

      • name: "data" | "close" | "Close" | "Data"

        Name of event without the 'on' prefix (ex: 'log' to 'onLog' event declared)

      • event: Function

        Unsubscriber Function, must be the one passed to on or once subscription methods

      Returns boolean

    • Event subscription

      Parameters

      • name: "data" | "close" | "Close" | "Data"

        Name of event without the on prefix (ex: log to onLog event declared)

      • event: Function

        Subscriber Function

      • Optionaloptions: { signal?: AbortSignal }
        • Optionalsignal?: AbortSignal

          Optional AbortSignal to stop this or multiple subscriptions in same time

      Returns void

    • Event subscription only one time, once time fired it's automatically unsubscribe

      Parameters

      • name: "data" | "close" | "Close" | "Data"

        Name of event without the on prefix (ex: log to onLog event declared)

      • event: Function

        Subscriber Function

      • Optionaloptions: { signal?: AbortSignal }
        • Optionalsignal?: AbortSignal

          Optional AbortSignal to stop this or multiple subscriptions in same time

      Returns void

    Events

    • Call on every data reception

      Parameters

      • time: number

        timestamp of the data

      • track: number

        data track

      • data: any

        JS data object received

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    Events