An object which selects Streams from a set of possible choices. This also
watches for system changes to automatically adapt for the current streaming
requirements. For example, when the network slows down, this class is in
charge of telling the Player which streams to switch to in order to reduce
the required bandwidth.
This class is given a set of streams to choose from when the Player starts
up. This class should store these and use them to make future decisions
about ABR. It is up to this class how those decisions are made. All the
Player will do is tell this class what streams to choose from.
- Implementations:
- Source:
Methods
(export) chooseVariant() → {shakaExtern.Variant}
Chooses one variant to switch to. Called by the Player.
- Source:
Returns:
- Type
- shakaExtern.Variant
(export) configure(config)
Sets the abr configurations.
Parameters:
| Name | Type | Description |
|---|---|---|
config |
shakaExtern.AbrConfiguration |
- Source:
(export) disable()
Disables automatic Stream suggestions. After this, the AbrManager may not
call switchCallback().
- Source:
(export) enable()
Enables automatic Variant choices from the last ones passed to setVariants.
After this, the AbrManager may call switchCallback() at any time.
- Source:
(export) getBandwidthEstimate() → {number}
Gets an estimate of the current bandwidth in bit/sec. This is used by the
Player to generate stats.
- Source:
Returns:
- Type
- number
(export) init(switchCallback)
Initializes the AbrManager.
Parameters:
| Name | Type | Description |
|---|---|---|
switchCallback |
shakaExtern.AbrManager.SwitchCallback |
- Source:
(export) segmentDownloaded(deltaTimeMs, numBytes)
Notifies the AbrManager that a segment has been downloaded (includes MP4
SIDX data, WebM Cues data, initialization segments, and media segments).
Parameters:
| Name | Type | Description |
|---|---|---|
deltaTimeMs |
number | The duration, in milliseconds, that the request took to complete. |
numBytes |
number | The total number of bytes transferred. |
- Source:
(export) setVariants(variantsnon-null)
Updates manager's variants collection.
Parameters:
| Name | Type | Description |
|---|---|---|
variants |
Array.<!shakaExtern.Variant> |
- Source:
(export) stop()
Stops any background timers and frees any objects held by this instance.
This will only be called after a call to init.
- Source:
Type Definitions
Factory
A factory for creating the abr manager. This will be called with 'new'.
Type:
- function(new:shakaExtern.AbrManager)
- Source:
SwitchCallback
A callback into the Player that should be called when the AbrManager decides
it's time to change to a different variant.
The first argument is a variant to switch to.
The second argument is an optional boolean. If true, all data will be
from the buffer, which will result in a buffering event.
Type:
- function(shakaExtern.Variant, boolean=)
- Source: