Class StreamMetadata

Use StreamMetadata to get real-time information on a server stream, including:

the list of tracks and their properties,
the list of availables sources and their properties,

Example

const streamMetadata = new StreamMetadata(Connect.buildURL(endPoint, streamName));
streamMetadata.onMetadata = metadata => {
   console.log(metadata);
}

Hierarchy

EventEmitter
- StreamMetadata

Index

Constructors

constructor

new StreamMetadata(connectParams): StreamMetadata
Create a new StreamMetadata instance, connects to the server using WebSocket and listen to metadata events.
Parameters
- connectParams: Params
Returns StreamMetadata
Overrides EventEmitter.constructor
- Defined in src/metadata/StreamMetadata.ts:109

Properties

`Private` _connectParams

_connectParams: Params

`Private` `Optional` _metadata

_metadata?: Metadata

`Private` _streamState

_streamState: StreamState

`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
Returns true if the connection is closed

Returns boolean
- Defined in src/metadata/StreamMetadata.ts:97

connectParams

get connectParams(): Params
Returns the Connect.Params object containing the connection parameters

Returns Params
- Defined in src/metadata/StreamMetadata.ts:84

metadata

get metadata(): undefined | Metadata
Returns the Metadata object description

Returns undefined | Metadata
- Defined in src/metadata/StreamMetadata.ts:90

streamState

get streamState(): StreamState
State of the stream as indicated by the server

Returns StreamState
- Defined in src/metadata/StreamMetadata.ts:77

url

get url(): string
URL of the connection

Returns string
- Defined in src/metadata/StreamMetadata.ts:70

Methods

`Private` _addSortedTrack

_addSortedTrack(medias, tracks): void
Parameters
- medias: MTrack[]
- tracks: Map<number, MTrack>
Returns void
- Defined in src/metadata/StreamMetadata.ts:205

close

close(error?): void
Close the stream metadata channel
Parameters
- Optional error: StreamMetadataError
  error description on an improper closure
Returns void
- Defined in src/metadata/StreamMetadata.ts:195

off

off(name, event): boolean
Event unsubscription
Parameters
- name: "state" | "metadata" | "close" | "Close" | "State" | "Metadata"
  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: "state" | "metadata" | "close" | "Close" | "State" | "Metadata"
  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

onState

onState(state): void
Event fired when stream state is changing
Parameters
- state: StreamState
Returns void
- Defined in src/metadata/StreamMetadata.ts:46

once

once(name, event, options?): void
Event subscription only one time, once time fired it's automatically unsubscribe
Parameters
- name: "state" | "metadata" | "close" | "Close" | "State" | "Metadata"
  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
Event fired when the stream is closed
Parameters
- Optional error: StreamMetadataError
  error description on an improper closure
Returns void
- Defined in src/metadata/StreamMetadata.ts:54

onMetadata

onMetadata(metadata): void
Event fired when metadata is present in the stream
Parameters
- metadata: Metadata
Returns void
- Defined in src/metadata/StreamMetadata.ts:63

Class StreamMetadata

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Events

Constructors

constructor

Parameters

connectParams: Params

Returns StreamMetadata

Properties

Private _connectParams

Private Optional _metadata

Private _streamState

Private _ws

log

Param

Returns

Accessors

closed

Returns boolean

connectParams

Returns Params

metadata

Returns undefined | Metadata

streamState

Returns StreamState

url

Returns string

Methods

Private _addSortedTrack

Parameters

medias: MTrack[]

tracks: Map<number, MTrack>

Returns void

close

Parameters

Optional error: StreamMetadataError

Returns void

off

Parameters

name: "state" | "metadata" | "close" | "Close" | "State" | "Metadata"

event: Function

Returns boolean

on

Parameters

name: "state" | "metadata" | "close" | "Close" | "State" | "Metadata"

event: Function

Optional options: { signal?: AbortSignal; }

Optional signal?: AbortSignal

Returns void

onState

Parameters

state: StreamState

Returns void

once

Parameters

name: "state" | "metadata" | "close" | "Close" | "State" | "Metadata"

event: Function

Optional options: { signal?: AbortSignal; }

Optional signal?: AbortSignal

Returns void

Events

onClose

Parameters

Optional error: StreamMetadataError

Returns void

onMetadata

Parameters

metadata: Metadata

Returns void

Settings

Member Visibility

Theme

On This Page

`Private` _connectParams

`Private` `Optional` _metadata

`Private` _streamState

`Private` _ws

`Private` _addSortedTrack

`Optional` error: StreamMetadataError

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

`Optional` signal?: AbortSignal

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

`Optional` signal?: AbortSignal

`Optional` error: StreamMetadataError