Class ABRAbstract`Abstract`

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

Hierarchy (View Summary)

EventEmitter
- ABRAbstract
  - ABRGrade
  - ABRLinear

Implements

ABRParams

Index

Constructors

constructor

new ABRAbstract(params: ABRParams, stream?: MediaStream): ABRAbstract
Build the ABR implementation, call compute to use it
Parameters
- params: ABRParams
  ABR parameters
- Optionalstream: 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

log

log: ILog

Start a log

Param: args

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: number): void
Set ABRParams.appreciationDuration
Parameters
- value: number
Returns void
Implementation of ABRParams.appreciationDuration
- Defined in src/abr/ABRAbstract.ts:145

constraint

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

Returns number | undefined
- 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: number): 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: number): 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: number): 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: number): void
Update the initial bitrate
Parameters
- value: number
Returns void
Implementation of ABRParams.startup
- Defined in src/abr/ABRAbstract.ts:72

stream

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

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

value

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

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

Methods

`Protected` `Abstract`_computeBitrate

_computeBitrate(
    bitrate: number,
    bitrateConstraint?: number,
    mediaReport?: 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
- OptionalbitrateConstraint: number
  the current bitrate constraint
- OptionalmediaReport: 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: number): void
Parameters
- videoBitrate: number
Returns void
- Defined in src/abr/ABRAbstract.ts:254

compute

compute(
    bitrate: number | undefined,
    bitrateConstraint?: number,
    mediaReport?: 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: number | undefined
  the current bitrate
- OptionalbitrateConstraint: number
  the current bitrate constraint
- OptionalmediaReport: MediaReport
  the media report structure received from the server
Returns number
the wanted bitrate
- Defined in src/abr/ABRAbstract.ts:213

off

off(name: never, event: Function): 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:484

on

on(name: never, event: Function, options?: { signal?: AbortSignal }): void
Event subscription
Parameters
- name: never
  Name of event without the on prefix (ex: log to onLog event declared)
- event: Function
  Subscriber Function
- Optionaloptions: { signal?: AbortSignal }
  - Optionalsignal?: 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:467

once

once(name: never, event: Function, options?: { signal?: AbortSignal }): 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
- Optionaloptions: { signal?: AbortSignal }
  - Optionalsignal?: 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:476

reset

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

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

valueOf

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

Class ABRAbstractAbstract

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ABRAbstract

Properties

log

Param: args

Returns

Accessors

appreciationDuration

Returns number

Parameters

Returns void

constraint

Returns number | undefined

maximum

Returns number

Parameters

Returns void

minimum

Returns number

Parameters

Returns void

recoverySteps

Returns number

Parameters

Returns void

startup

Returns number

Parameters

Returns void

stream

Returns MediaStream | undefined

value

Returns number | undefined

Methods

Protected Abstract_computeBitrate

Parameters

Returns number

Protected_updateVideoConstraints

Parameters

Returns void

compute

Parameters

Returns number

off

Parameters

Returns boolean

on

Parameters

Optionalsignal?: AbortSignal

Returns void

once

Parameters

Optionalsignal?: AbortSignal

Returns void

reset

Returns void

valueOf

Returns number | undefined

Settings

On This Page

Class ABRAbstract`Abstract`

`Protected` `Abstract`_computeBitrate

`Protected`_updateVideoConstraints

`Optional`signal?: AbortSignal

`Optional`signal?: AbortSignal