Skip to content

Commit

Permalink
update docs for custom abr controllers
Browse files Browse the repository at this point in the history
  • Loading branch information
lpommers committed Aug 22, 2022
1 parent d2657bf commit 5cd9ff9
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -906,10 +906,10 @@ var config = {

Customized Adaptive Bitrate Streaming Controller.

Parameter should be a class providing 2 getters, 2 setters and a `destroy()` method:
Parameter should be a class providing a getter/setter, a `clearTimer` method, and a `destroy()` method:

- get/set `nextAutoLevel`: return next auto-quality level/force next auto-quality level that should be returned (currently used for emergency switch down)
- get/set `autoLevelCapping`: capping/max level value that could be used by ABR Controller
- `clearTimer()` - Stops the abandon rules check polling until another fragment is loaded
- `destroy()`: should clean-up all used resources

For `hls.bandwidthEstimate()` to return an estimate from your custom controller, it will also need to satisfy `abrController.bwEstimator.getEstimate()`.
Expand Down

0 comments on commit 5cd9ff9

Please sign in to comment.