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

Constructors

Properties

_vars: Vars
log: ILog

Start a log

Param

Returns

a Log object with the levels of log to call

Accessors

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

    Returns undefined | number

  • get maximum(): number
  • Get the maximum bitrate

    Returns number

  • set maximum(value): void
  • Update the maximum bitrate

    Parameters

    • value: number

    Returns void

  • get minimum(): number
  • Get the minimum bitrate

    Returns number

  • set minimum(value): void
  • Update the minimum bitrate

    Parameters

    • value: number

    Returns void

  • get startup(): number
  • Get the configured initial bitrate

    Returns number

  • set startup(value): void
  • Update the initial bitrate

    Parameters

    • value: number

    Returns void

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

    Returns undefined | number

Methods

  • Parameters

    • bitrateConstraint: number

    Returns undefined | 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

  • Parameters

    • bitrateConstraint: number

    Returns number

  • Parameters

    • bitrateConstraint: number
    • factor: number = 1.05

    Returns 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

  • 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

  • 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

  • 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

Generated using TypeDoc