Class Streamer

Use Streamer to broadcast to a WebRTC server.

You can use a controllable version using a WSController as connector, or change it to use a HTTPConnector (HTTP WHIP). By default it uses a WSController excepting if on Streamer.start you use a Connect.Params.endPoint prefixed with a http:// protocol. With a controllable connector you can change video bitrate during the streaming, what is not possible with a HTTP(WHIP) connector.

Example

const streamer = new Streamer();
// const streamer = new Streamer(isWHEP ? HTTPConnector : WSController);
streamer.onStart = stream => {
   console.log('start streaming');
}
streamer.onStop = _ => {
   console.log('stop streaming');
}
navigator.mediaDevices
.getUserMedia({ audio: true, video: true })
.then(stream => {
   streamer.start(stream, {
      endPoint: address, // if address is prefixed by `http://` it uses a HTTPConnector (HTTP-WHIP) if Streamer is build without contructor argument
      streamName: 'as+bc3f535f-37f3-458b-8171-b4c5e77a6137'
   });
   ...
   streamer.stop();
});

Hierarchy

EventEmitter
- Streamer

Constructors

constructor

new Streamer(Connector?): Streamer
Constructs a new Streamer instance, optionally with a custom connector This doesn't start the broadcast, you must call start() method
Parameters
- Optional Connector: (new (connectParams, stream) => IConnector)
  Connector class to use for signaling, can be determined automatically from URL in the start() method
  - - new (connectParams, stream): IConnector
    - Parameters
      connectParams: Params
      stream: MediaStream
      Returns IConnector
Returns Streamer
Overrides EventEmitter.constructor
- Defined in src/Streamer.ts:212

Properties

`Private` `Optional` Connector

Connector?: (new (connectParams, stream) => IConnector)

Type declaration

- new (connectParams, stream): IConnector
- Connector class to use for signaling, can be determined automatically from URL in the start() method
  Parameters
  - connectParams: Params
  - stream: MediaStream
  Returns IConnector

`Private` `Optional` _connector

_connector?: IConnector

`Private` `Optional` _controller

_controller?: IController

`Private` `Optional` _mediaReport

_mediaReport?: MediaReport

`Private` `Optional` _rtpProps

_rtpProps?: RTPProps

`Private` `Optional` _videoBitrate

_videoBitrate?: number

`Private` `Optional` _videoBitrateConstraint

_videoBitrateConstraint?: number

`Private` _videoBitrateFixed

_videoBitrateFixed: boolean

log

log: ILog

Start a log

Param

Returns

a Log object with the levels of log to call

Accessors

audioTrack

get audioTrack(): null | MediaStreamTrack
The current audio track of the stream, or null if audio track is disabled.

Returns null | MediaStreamTrack
- Defined in src/Streamer.ts:187

connector

get connector(): undefined | IConnector
Returns the IConnector instance, or undefined if stream is not starting.

Returns undefined | IConnector
- Defined in src/Streamer.ts:127

controller

get controller(): undefined | IController
Returns the IController instance when starting with a connector with controllable ability, or undefined if stream is not starting or stream is not controllable.

Returns undefined | IController
- Defined in src/Streamer.ts:120

mediaReport

get mediaReport(): undefined | MediaReport
Last MediaReport statistics

Returns undefined | MediaReport
- Defined in src/Streamer.ts:134

rtpProps

get rtpProps(): undefined | RTPProps
Last RTPProps statistics

Returns undefined | RTPProps
- Defined in src/Streamer.ts:141

running

get running(): boolean
Returns true when streamer is running (between a Streamer.start and a Streamer.stop)

Returns boolean
- Defined in src/Streamer.ts:112

stream

get stream(): undefined | MediaStream
Camera media stream as specified by MediaStream

Returns undefined | MediaStream
- Defined in src/Streamer.ts:105

streamName

get streamName(): string
Stream name, for example as+bc3f535f-37f3-458b-8171-b4c5e77a6137

Returns string
- Defined in src/Streamer.ts:98

videoBitrate

get videoBitrate(): undefined | number
Video bitrate configured by the server, can be undefined on start or when there is no controllable connector

Returns undefined | number
Note
Use connectionInfos to get the current precise audio or video bitrate
- Defined in src/Streamer.ts:150
set videoBitrate(value): void
Configure the video bitrate from the server, possible only if your Streamer instance is built with a controllable connector Set undefined to remove this configuration
Parameters
- value: undefined | number
Returns void
- Defined in src/Streamer.ts:159

videoBitrateConstraint

get videoBitrateConstraint(): undefined | number
Video bitrate constraint configured by the server, can be undefined on start or when there is no controllable connector

Returns undefined | number
Note
Use connectionInfos to get the current precise audio or video bitrate
- Defined in src/Streamer.ts:180

videoTrack

get videoTrack(): null | MediaStreamTrack
The current video track of the stream, or null if video track is disabled.

Returns null | MediaStreamTrack
- Defined in src/Streamer.ts:195

Methods

`Private` _computeVideoBitrate

_computeVideoBitrate(abr): void
Parameters
- abr: ABRAbstract
Returns void
- Defined in src/Streamer.ts:401

`Private` _replaceTrack

_replaceTrack(kind, media): Promise<void>
Replace a single track while streaming.
- If the underlying connector exposes a replaceTrack(kind, track) method, this will hot-swap the sender track (no full restart).
- Otherwise, we update the exposed MediaStream for consistency and throw, so callers can decide to stop/start with a new stream.
Parameters
- kind: "audio" | "video"
  'audio' | 'video'
- media: null | MediaStreamTrack
  A MediaStreamTrack, a MediaStream (first track of kind is used), or null to remove/mute that kind.
Returns Promise<void>
- Defined in src/Streamer.ts:369

connectionInfos

connectionInfos(): Promise<ConnectionInfos>
Returns connection info, such as round trip time, requests sent and received, bytes sent and received, and bitrates NOTE: This call is resource-intensive for the CPU.

Returns Promise<ConnectionInfos>
A promise for a ConnectionInfos
- Defined in src/Streamer.ts:257

off

off(name, event): boolean
Event unsubscription
Parameters
- name: "stop" | "start" | "RTPProps" | "MediaReport" | "VideoBitrate" | "rtpprops" | "mediareport" | "videobitrate" | "Start" | "Stop"
  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:480

on

on(name, event, options?): void
Event subscription
Parameters
- name: "stop" | "start" | "RTPProps" | "MediaReport" | "VideoBitrate" | "rtpprops" | "mediareport" | "videobitrate" | "Start" | "Stop"
  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:463

onMediaReport

onMediaReport(mediaReport): void
Event fired to report media statistics
Parameters
- mediaReport: MediaReport
Returns void
- Defined in src/Streamer.ts:84

onRTPProps

onRTPProps(props): void
Event fired when an RTP setting change occurs
Parameters
- props: RTPProps
Returns void
- Defined in src/Streamer.ts:78

onVideoBitrate

onVideoBitrate(videoBitrate, videoBitrateConstraint): void
Event fired when a video bitrate change occurs
Parameters
- videoBitrate: number
- videoBitrateConstraint: number
Returns void
- Defined in src/Streamer.ts:91

once

once(name, event, options?): void
Event subscription only one time, once time fired it's automatically unsubscribe
Parameters
- name: "stop" | "start" | "RTPProps" | "MediaReport" | "VideoBitrate" | "rtpprops" | "mediareport" | "videobitrate" | "Start" | "Stop"
  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.once
- Defined in node_modules/@ceeblue/web-utils/dist/web-utils.d.ts:472

setAudioTrack

setAudioTrack(track): Promise<void>
Replace the audio track while streaming.
Parameters
- track: null | MediaStreamTrack
  MediaStreamTrack to set as audio track, or null to remove the audio track
Returns Promise<void>
A promise that resolves when the track is set or removed
- Defined in src/Streamer.ts:223

setRTPProps

setRTPProps(nack?, drop?): void
Sets server properties for packet error (nack) and delayed packet loss (drop) 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/Streamer.ts:244

setVideoTrack

setVideoTrack(track): Promise<void>
Replace the video track while streaming.
Parameters
- track: null | MediaStreamTrack
  MediaStreamTrack to set as video track, or null to remove the video track
Returns Promise<void>
A promise that resolves when the track is set or removed
- Defined in src/Streamer.ts:233

start

start(stream, params, adaptiveBitrate?): void
Starts broadcasting the stream The connector is determined automatically from Connect.Params.endPoint if not forced in the constructor.

The adaptiveBitrate option can take three different types of value:
- A ABRParams parameters to configure the default ABRLinear implementation
- undefined to disable ABR management
- Use a custom ABRAbstract implementation instance
Parameters
- stream: MediaStream
  MediaStream instance to stream
- params: Params
  Connection parameters
- adaptiveBitrate: undefined | ABRParams | ABRAbstract = {}
  Adaptive bitrate implementation or ABRParams to configure the default implementation
Returns void
- Defined in src/Streamer.ts:277

stop

stop(error?): void
Stop streaming the stream
Parameters
- Optional error: StreamerError
  error description on an improper stop
Returns void
- Defined in src/Streamer.ts:342

Events

onStart

onStart(stream): void
Event fired when the stream has started
Parameters
- stream: MediaStream
Returns void
- Defined in src/Streamer.ts:57

onStop

onStop(error?): void
Event fired when the stream has stopped
Parameters
- Optional error: StreamerError
  error description on an improper stop
Returns void
- Defined in src/Streamer.ts:66

Class Streamer

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Events

Constructors

constructor

Parameters

Optional Connector: (new (connectParams, stream) => IConnector)

Parameters

connectParams: Params

stream: MediaStream

Returns IConnector

Returns Streamer

Properties

Private Optional Connector

Type declaration

Parameters

connectParams: Params

stream: MediaStream

Returns IConnector

Private Optional _connector

Private Optional _controller

Private Optional _mediaReport

Private Optional _rtpProps

Private Optional _videoBitrate

Private Optional _videoBitrateConstraint

Private _videoBitrateFixed

log

Param

Returns

Accessors

audioTrack

Returns null | MediaStreamTrack

connector

Returns undefined | IConnector

controller

Returns undefined | IController

mediaReport

Returns undefined | MediaReport

rtpProps

Returns undefined | RTPProps

running

Returns boolean

stream

Returns undefined | MediaStream

streamName

Returns string

videoBitrate

Returns undefined | number

Note

Parameters

value: undefined | number

Returns void

videoBitrateConstraint

Returns undefined | number

Note

videoTrack

Returns null | MediaStreamTrack

Methods

Private _computeVideoBitrate

Parameters

abr: ABRAbstract

Returns void

Private _replaceTrack

Parameters

kind: "audio" | "video"

media: null | MediaStreamTrack

Returns Promise<void>

connectionInfos

Returns Promise<ConnectionInfos>

off

Parameters

name: "stop" | "start" | "RTPProps" | "MediaReport" | "VideoBitrate" | "rtpprops" | "mediareport" | "videobitrate" | "Start" | "Stop"

event: Function

Returns boolean

`Optional` Connector: (new (connectParams, stream) => IConnector)

`Private` `Optional` Connector

`Private` `Optional` _connector

`Private` `Optional` _controller

`Private` `Optional` _mediaReport

`Private` `Optional` _rtpProps

`Private` `Optional` _videoBitrate

`Private` `Optional` _videoBitrateConstraint

`Private` _videoBitrateFixed

`Private` _computeVideoBitrate

`Private` _replaceTrack

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

`Optional` signal?: AbortSignal

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

`Optional` signal?: AbortSignal

`Optional` nack: number

`Optional` drop: number

`Optional` error: StreamerError

`Optional` error: StreamerError