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

    Class WSStreamData

    WSStreamData is the WebSocket implementation of IStreamData

    const streamData = new WSStreamData({endPoint, streamName});
    streamData.tracks = [0, 1]; // subscribe to data tracks 0 and 1
    streamData.onData = track, time, data => {
       console.log(`Data received on track ${track} at ${time} : ${Util.stringify(data)}`);
    }

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    log

    Accessors

    closed tracks url

    Methods

    close off on once

    Events

    onClose onData

    Constructors

    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

    • get tracks(): number[]

      The list of tracks currently receiving

      Returns number[]

    • set tracks(tracks: number[]): void

      Set the data tracks to receive

      Parameters

      • tracks: number[]

      Returns void

    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

      • track: number

        timestamp of the data

      • time: number

        data track

      • data: any

        JS data object received

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    Events