Interface IController

IController is a controller interface extending a stream connector with the capability of sending and receiving commands with the server.

This interface can serve the both roles: player or streamer.

Hierarchy

IConnector
- IController

Implemented by

WSController

Index

Properties

`Readonly` closed

closed: boolean

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

`Readonly` codecs

codecs: Set<string>

Indicate codecs supported, should be set before than onOpen happen

log

log: ILog

Start a log

Param

Returns

a Log object with the levels of log to call

`Readonly` opened

opened: boolean

True when connector is opened, in other words when onOpen event is fired

`Optional` `Readonly` stream

stream?: MediaStream

Media Stream description delivred from the server if we are player, or build from the local camera if we are the streamer.

`Readonly` streamName

streamName: string

Stream name, for example as+bc3f535f-37f3-458b-8171-b4c5e77a6137

Methods

close

close(error?): void
Close the connector
Parameters
- Optional error: ConnectorError
  the error reason if is not a proper close
Returns void
Inherited from IConnector.close
- Defined in src/connectors/IConnector.ts:110

connectionInfos

connectionInfos(cacheDuration?): Promise<ConnectionInfos>
Request connections infos with caching option to save loading cost
Parameters
- Optional cacheDuration: number
  indicate how many time we can cache the last connection informations
Returns Promise<ConnectionInfos>
Promise with a ConnectionInfos on success
Inherited from IConnector.connectionInfos
- Defined in src/connectors/IConnector.ts:105

off

off(name, event): boolean
Event unsubscription
Parameters
- name: "open" | "close" | "playing" | "Close" | "RTPProps" | "MediaReport" | "VideoBitrate" | "Playing" | "Open" | "rtpprops" | "mediareport" | "videobitrate"
  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 IConnector.off
- Defined in node_modules/@ceeblue/web-utils/dist/web-utils.d.ts:439

on

on(name, event, options?): void
Event subscription
Parameters
- name: "open" | "close" | "playing" | "Close" | "RTPProps" | "MediaReport" | "VideoBitrate" | "Playing" | "Open" | "rtpprops" | "mediareport" | "videobitrate"
  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 IConnector.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: "open" | "close" | "playing" | "Close" | "RTPProps" | "MediaReport" | "VideoBitrate" | "Playing" | "Open" | "rtpprops" | "mediareport" | "videobitrate"
  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 IConnector.once
- Defined in node_modules/@ceeblue/web-utils/dist/web-utils.d.ts:431

send

send(type, params): void
Send a generic command to control the streaming session
Parameters
- type: string
  type of command
- params: object
  parameters of the command
Returns void
Example
```
controller.send('video_bitrate', {video_bitrate: 0});
```
- Defined in src/connectors/IController.ts:114

setRTPProps

setRTPProps(nack?, drop?): void
Sets server properties for packet error (nack) and delayed packet loss (drop) for a streamer controller and fires an onRTPProps event if changed successfully. NOTE: Method can also retrieve current server values if called without arguments.
Parameters
- Optional nack: number
  Waiting period before declaring a packet error
- Optional drop: number
  Waiting period before considering delayed packets as lost
Returns void
- Defined in src/connectors/IController.ts:95

setTracks

setTracks(tracks): void
Configure the audio and video track to play for a player controller
Parameters
- tracks: {
  audio?: number;
  video?: number;
  }
  - Optional audio?: number
    Audio track
  - Optional video?: number
    Video track
Returns void
- Defined in src/connectors/IController.ts:106

setVideoBitrate

setVideoBitrate(value): void
Configure the video bitrate on the server side for a streamer controller
Parameters
- value: number
  video bitrate in bps
Returns void
- Defined in src/connectors/IController.ts:100

Events

onClose

onClose(error?): void
Call when connector is closed
Parameters
- Optional error: ConnectorError
  error description on an improper closure
Returns void
Inherited from IConnector.onClose
- Defined in src/connectors/IConnector.ts:78

onMediaReport

onMediaReport(mediaReport): void
Call to distribute MediaReport
Parameters
- mediaReport: MediaReport
  Media report informations
Returns void
- Defined in src/connectors/IController.ts:74

onOpen

onOpen(stream): void
Call when connector is open
Parameters
- stream: MediaStream
  MediaStream description provided from the server if we are the player, or build from the local camera if we are the streamer.
Returns void
Inherited from IConnector.onOpen
- Defined in src/connectors/IConnector.ts:72

onPlaying

onPlaying(playingInfos): void
Call to distribute PlayingInfos
Parameters
- playingInfos: PlayingInfos
  Current playing informations
Returns void
- Defined in src/connectors/IController.ts:87

onRTPProps

onRTPProps(rtpProps): void
Call to distribute RTPProps
Parameters
- rtpProps: RTPProps
  RTP properties
Returns void
- Defined in src/connectors/IController.ts:68

onVideoBitrate

onVideoBitrate(videoBitrate, videoBitrateConstraint): void
Call to distribute video bitrate informations
Parameters
- videoBitrate: number
  Current video bitrate
- videoBitrateConstraint: number
  Video bitrate constraint computed by the server
Returns void
- Defined in src/connectors/IController.ts:81

Interface IController

Hierarchy

Implemented by

Index

Properties

Methods

Events

Properties

Readonly closed

Readonly codecs

log

Param

Returns

Readonly opened

Optional Readonly stream

Readonly streamName

Methods

close

Parameters

Optional error: ConnectorError

Returns void

connectionInfos

Parameters

Optional cacheDuration: number

Returns Promise<ConnectionInfos>

off

Parameters

name: "open" | "close" | "playing" | "Close" | "RTPProps" | "MediaReport" | "VideoBitrate" | "Playing" | "Open" | "rtpprops" | "mediareport" | "videobitrate"

event: Function

Returns boolean

on

Parameters

name: "open" | "close" | "playing" | "Close" | "RTPProps" | "MediaReport" | "VideoBitrate" | "Playing" | "Open" | "rtpprops" | "mediareport" | "videobitrate"

event: Function

Optional options: { signal?: AbortSignal; }

Optional signal?: AbortSignal

Returns void

once

Parameters

name: "open" | "close" | "playing" | "Close" | "RTPProps" | "MediaReport" | "VideoBitrate" | "Playing" | "Open" | "rtpprops" | "mediareport" | "videobitrate"

event: Function

Optional options: { signal?: AbortSignal; }

Optional signal?: AbortSignal

Returns void

send

Parameters

type: string

params: object

Returns void

Example

setRTPProps

Parameters

Optional nack: number

Optional drop: number

Returns void

setTracks

Parameters

tracks: { audio?: number; video?: number; }

Optional audio?: number

Optional video?: number

Returns void

setVideoBitrate

Parameters

value: number

Returns void

Events

onClose

Parameters

Optional error: ConnectorError

Returns void

onMediaReport

Parameters

mediaReport: MediaReport

Returns void

onOpen

Parameters

stream: MediaStream

Returns void

onPlaying

Parameters

`Readonly` closed

`Readonly` codecs

`Readonly` opened

`Optional` `Readonly` stream

`Readonly` streamName

`Optional` error: ConnectorError

`Optional` cacheDuration: number

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

`Optional` signal?: AbortSignal

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

`Optional` signal?: AbortSignal

`Optional` nack: number

`Optional` drop: number

tracks: {
audio?: number;
video?: number;
}

`Optional` audio?: number

`Optional` video?: number

`Optional` error: ConnectorError