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.

Hierarchy

EventEmitter
- IStreamData

Implemented by

WSStreamData

Index

Properties

Accessors

closed tracks url

Methods

close off on once

Events

Properties

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
- Defined in src/metadata/IStreamData.ts:49

tracks

get tracks(): number[]
The list of tracks currently receiving

Returns number[]
- Defined in src/metadata/IStreamData.ts:39
set tracks(tracks): void
Set the data tracks to receive
Parameters
- tracks: number[]
Returns void
- Defined in src/metadata/IStreamData.ts:44

url

get url(): string
URL of connction

Returns string
- Defined in src/metadata/IStreamData.ts:34

Methods

close

close(): void
Close the Stream Data connection

Returns void
- Defined in src/metadata/IStreamData.ts:54

off

off(name, event): boolean
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
Inherited from EventEmitter.off
- Defined in node_modules/@ceeblue/web-utils/dist/web-utils.d.ts:439

on

on(name, event, options?): void
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
Inherited from EventEmitter.on
- Defined in node_modules/@ceeblue/web-utils/dist/web-utils.d.ts:422

once

once(name, event, options?): void
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
Inherited from EventEmitter.once
- Defined in node_modules/@ceeblue/web-utils/dist/web-utils.d.ts:431

Events

onClose

onClose(error?): void
Call when the stream is closed
Parameters
- Optional error: WebSocketReliableError
  error description on an improper closure
Returns void
- Defined in src/metadata/IStreamData.ts:19

onData

onData(time, track, data): void
Call on every data reception
Parameters
- time: number
  timestamp of the data
- track: number
  data track
- data: any
  JS data object received
Returns void
- Defined in src/metadata/IStreamData.ts:29

Generated using TypeDoc