Class ABRGrade

ABRGrade is an adaptive bitrate algorithm implementing ABRAbstract that uses current bitrate, bitrateConstraint, loss infos of mediaReport and some level constants to adapt the bitrate in a robust way

Hierarchy

ABRAbstract
- ABRGrade

Constructors

constructor

new ABRGrade(params, stream?): ABRGrade
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 ABRGrade
Overrides ABRAbstract.constructor
- Defined in src/abr/ABRGrade.ts:34

Properties

`Private` _vars

_vars: Vars

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
Inherited from ABRAbstract.appreciationDuration
- Defined in src/abr/ABRAbstract.ts:138
set appreciationDuration(value): void
Set ABRParams.appreciationDuration
Parameters
- value: number
Returns void
Inherited from ABRAbstract.appreciationDuration
- Defined in src/abr/ABRAbstract.ts:145

constraint

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

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

maximum

get maximum(): number
Get the maximum bitrate

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

minimum

get minimum(): number
Get the minimum bitrate

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

recoverySteps

get recoverySteps(): number
Get ABRParams.recoverySteps

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

startup

get startup(): number
Get the configured initial bitrate

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

stream

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

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

value

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

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

Methods

`Private` _bitrateRecoveryHandler

_bitrateRecoveryHandler(bitrateConstraint): undefined | number
Parameters
- bitrateConstraint: number
Returns undefined | number
- Defined in src/abr/ABRGrade.ts:128

`Protected` _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
Overrides ABRAbstract._computeBitrate
- Defined in src/abr/ABRGrade.ts:51

`Private` _decreaseRecoveryTimeout

_decreaseRecoveryTimeout(): void
Returns void
- Defined in src/abr/ABRGrade.ts:177

`Private` _decreaseTargetBitrate

_decreaseTargetBitrate(bitrateConstraint): number
Parameters
- bitrateConstraint: number
Returns number
- Defined in src/abr/ABRGrade.ts:162

`Private` _formatBitrate

_formatBitrate(value): string
Parameters
- value: number
Returns string
- Defined in src/abr/ABRGrade.ts:184

`Private` _increaseRecoveryTimeout

_increaseRecoveryTimeout(): void
Returns void
- Defined in src/abr/ABRGrade.ts:170

`Private` _increaseTargetBitrate

_increaseTargetBitrate(bitrateConstraint, factor?): number
Parameters
- bitrateConstraint: number
- factor: number = 1.05
Returns number
- Defined in src/abr/ABRGrade.ts:154

`Protected` _updateVideoConstraints

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

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
Inherited from ABRAbstract.compute
- 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 ABRAbstract.off
- Defined in node_modules/@ceeblue/web-utils/dist/web-utils.d.ts:480

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 ABRAbstract.on
- Defined in node_modules/@ceeblue/web-utils/dist/web-utils.d.ts:463

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
    Optional AbortSignal to stop this or multiple subscriptions in same time
Returns void
Inherited from ABRAbstract.once
- Defined in node_modules/@ceeblue/web-utils/dist/web-utils.d.ts:472

reset

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

Returns void
Overrides ABRAbstract.reset
- Defined in src/abr/ABRGrade.ts:42

valueOf

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

Class ABRGrade

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

params: ABRParams

Optional stream: MediaStream

Returns ABRGrade

Properties

Private _vars

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

Private _bitrateRecoveryHandler

Parameters

bitrateConstraint: number

Returns undefined | number

Protected _computeBitrate

Parameters

bitrate: number

Optional bitrateConstraint: number

Optional mediaReport: MediaReport

Returns number

Private _decreaseRecoveryTimeout

Returns void

Private _decreaseTargetBitrate

Parameters

bitrateConstraint: number

Returns number

Private _formatBitrate

Parameters

value: number

Returns string

Private _increaseRecoveryTimeout

Returns void

Private _increaseTargetBitrate

Parameters

bitrateConstraint: number

factor: number = 1.05

Returns number

Protected _updateVideoConstraints

Parameters

`Optional` stream: MediaStream

`Private` _vars

`Private` _bitrateRecoveryHandler

`Protected` _computeBitrate

`Optional` bitrateConstraint: number

`Optional` mediaReport: MediaReport

`Private` _decreaseRecoveryTimeout

`Private` _decreaseTargetBitrate

`Private` _formatBitrate

`Private` _increaseRecoveryTimeout

`Private` _increaseTargetBitrate

`Protected` _updateVideoConstraints

`Optional` bitrateConstraint: number

`Optional` mediaReport: MediaReport

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

`Optional` signal?: AbortSignal

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

`Optional` signal?: AbortSignal