Class WSStreamData

WSStreamData is the WebSocket implementation of IStreamData

Example

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

Implements

Constructors

constructor

Properties

_tracks _url _ws log

Accessors

closed tracks url

Methods

_sendTracks close off on once

Events

onClose onData

Constructors

constructor

Properties

Private _tracks

_tracks: number[]

Private _url

_url: string

Private _ws

_ws: WebSocketReliable

log

log: ILog

Start a log

Param

Returns

a Log object with the levels of log to call

Accessors

closed

  • get closed(): boolean

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

    Returns boolean

tracks

  • get tracks(): number[]

  • The list of tracks currently receiving

    Returns number[]

  • set tracks(tracks): void

  • Set the data tracks to receive

    Parameters

    • tracks: number[]

    Returns void

url

Methods

Private _sendTracks

close

off

  • Event unsubscription

    Parameters

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

      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

on

  • Event subscription

    Parameters

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

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

    • event: Function

      Subscriber Function

    • Optional options: {
          signal?: AbortSignal;
      }
      • Optional signal?: AbortSignal

        Optional AbortSignal to stop this or multiple subscriptions in same time

    Returns void

once

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

    Parameters

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

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

    • event: Function

      Subscriber Function

    • Optional options: {
          signal?: AbortSignal;
      }
      • Optional signal?: AbortSignal

    Returns void

Events

onClose

onData

  • 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

Theme

On This Page

Generated using TypeDoc