Class ABRAbstract`Abstract`

ABRAbstract is the base class for adaptive bitrate algorithm used by Streamer when it has a controller connector.

Hierarchy

EventEmitter
- ABRAbstract
  - ABRGrade
  - ABRLinear

Implements

ABRParams

Index

Constructors

constructor

new ABRAbstract(params, stream?): ABRAbstract
Build the ABR implementation, call compute to use it
Parameters
- params: ABRParams
  ABR parameters
- Optional stream: MediaStream
  If set it can change dynamically the source resolution regarding the network quality
Returns ABRAbstract
Overrides EventEmitter.constructor
- Defined in src/abr/ABRAbstract.ts:184

Properties

`Private` _appreciationDuration

_appreciationDuration: number

`Private` `Optional` _bitrate

_bitrate?: number

`Private` `Optional` _bitrateConstraint

_bitrateConstraint?: number

`Private` _maximum

_maximum: number

`Private` _minimum

_minimum: number

`Private` _recoverySteps

_recoverySteps: number

`Private` _startup

_startup: number

`Private` `Optional` _stream

_stream?: MediaStream

log

log: ILog

Start a log

Param

Returns

a Log object with the levels of log to call

Accessors

appreciationDuration

get appreciationDuration(): number
Get ABRParams.appreciationDuration

Returns number
Implementation of ABRParams.appreciationDuration
- Defined in src/abr/ABRAbstract.ts:138
set appreciationDuration(value): void
Set ABRParams.appreciationDuration
Parameters
- value: number
Returns void
Implementation of ABRParams.appreciationDuration
- Defined in src/abr/ABRAbstract.ts:145

constraint

get constraint(): undefined | number
Get the current bitrate constraint

Returns undefined | number
- Defined in src/abr/ABRAbstract.ts:117

maximum

get maximum(): number
Get the maximum bitrate

Returns number
Implementation of ABRParams.maximum
- Defined in src/abr/ABRAbstract.ts:98
set maximum(value): void
Update the maximum bitrate
Parameters
- value: number
Returns void
Implementation of ABRParams.maximum
- Defined in src/abr/ABRAbstract.ts:105

minimum

get minimum(): number
Get the minimum bitrate

Returns number
Implementation of ABRParams.minimum
- Defined in src/abr/ABRAbstract.ts:79
set minimum(value): void
Update the minimum bitrate
Parameters
- value: number
Returns void
Implementation of ABRParams.minimum
- Defined in src/abr/ABRAbstract.ts:86

recoverySteps

get recoverySteps(): number
Get ABRParams.recoverySteps

Returns number
Implementation of ABRParams.recoverySteps
- Defined in src/abr/ABRAbstract.ts:124
set recoverySteps(value): void
Set ABRParams.recoverySteps
Parameters
- value: number
Returns void
Implementation of ABRParams.recoverySteps
- Defined in src/abr/ABRAbstract.ts:131

startup

get startup(): number
Get the configured initial bitrate

Returns number
Implementation of ABRParams.startup
- Defined in src/abr/ABRAbstract.ts:65
set startup(value): void
Update the initial bitrate
Parameters
- value: number
Returns void
Implementation of ABRParams.startup
- Defined in src/abr/ABRAbstract.ts:72

stream

get stream(): undefined | MediaStream
Get the MediaStream if set

Returns undefined | MediaStream
- Defined in src/abr/ABRAbstract.ts:167

value

get value(): undefined | number
Get the current bitrate

Returns undefined | number
- Defined in src/abr/ABRAbstract.ts:152

Methods

`Protected` `Abstract` _computeBitrate

_computeBitrate(bitrate, bitrateConstraint?, mediaReport?): number
Implement this method to define your own congestion algorithm, the method must return the wanted bitrate or undefined to not change the current bitrate.
Parameters
- bitrate: number
  the current bitrate
- Optional bitrateConstraint: number
  the current bitrate constraint
- Optional mediaReport: MediaReport
  the media report structure received from the server
Returns number
the wanted bitrate or undefined to not change the current bitrate
- Defined in src/abr/ABRAbstract.ts:252

`Protected` _updateVideoConstraints

_updateVideoConstraints(videoBitrate): void
Parameters
- videoBitrate: number
Returns void
- Defined in src/abr/ABRAbstract.ts:254

`Private` _upgradeVideoConstraint

_upgradeVideoConstraint(track, factor): void
Parameters
- track: MediaStreamTrack
- factor: number
Returns void
- Defined in src/abr/ABRAbstract.ts:280

compute

compute(bitrate, bitrateConstraint?, mediaReport?): number
Call this method regularly to control if we have to increase or decrease the stream bitrate depending on the network conditions.
Parameters
- bitrate: undefined | number
  the current bitrate
- Optional bitrateConstraint: number
  the current bitrate constraint
- Optional mediaReport: MediaReport
  the media report structure received from the server
Returns number
the wanted bitrate
- Defined in src/abr/ABRAbstract.ts:213

off

off(name, event): boolean
Event unsubscription
Parameters
- name: never
  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: never
  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: never
  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

reset

reset(): void
Reset the ABR algorithm to its initial state

Returns void
- Defined in src/abr/ABRAbstract.ts:239

valueOf

valueOf(): undefined | number
Returns undefined | number
the current bitrate
- Defined in src/abr/ABRAbstract.ts:160

Class ABRAbstractAbstract

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

params: ABRParams

Optional stream: MediaStream

Returns ABRAbstract

Properties

Private _appreciationDuration

Private Optional _bitrate

Private Optional _bitrateConstraint

Private _maximum

Private _minimum

Private _recoverySteps

Private _startup

Private Optional _stream

log

Param

Returns

Accessors

appreciationDuration

Returns number

Parameters

value: number

Returns void

constraint

Returns undefined | number

maximum

Returns number

Parameters

value: number

Returns void

minimum

Returns number

Parameters

value: number

Returns void

recoverySteps

Returns number

Parameters

value: number

Returns void

startup

Returns number

Parameters

value: number

Returns void

stream

Returns undefined | MediaStream

value

Returns undefined | number

Methods

Protected Abstract _computeBitrate

Parameters

bitrate: number

Optional bitrateConstraint: number

Optional mediaReport: MediaReport

Returns number

Protected _updateVideoConstraints

Parameters

videoBitrate: number

Returns void

Private _upgradeVideoConstraint

Parameters

track: MediaStreamTrack

factor: number

Returns void

compute

Parameters

bitrate: undefined | number

Optional bitrateConstraint: number

Optional mediaReport: MediaReport

Returns number

Class ABRAbstract`Abstract`

`Optional` stream: MediaStream

`Private` _appreciationDuration

`Private` `Optional` _bitrate

`Private` `Optional` _bitrateConstraint

`Private` _maximum

`Private` _minimum

`Private` _recoverySteps

`Private` _startup

`Private` `Optional` _stream

`Protected` `Abstract` _computeBitrate

`Optional` bitrateConstraint: number

`Optional` mediaReport: MediaReport

`Protected` _updateVideoConstraints

`Private` _upgradeVideoConstraint

`Optional` bitrateConstraint: number

`Optional` mediaReport: MediaReport

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

`Optional` signal?: AbortSignal

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

`Optional` signal?: AbortSignal