Skip to content

Commit

Permalink
remove clearTimer from abr interface and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
lpommers committed Aug 22, 2022
1 parent 5cd9ff9 commit d7bc232
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 3 deletions.
3 changes: 1 addition & 2 deletions docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -906,10 +906,9 @@ var config = {

Customized Adaptive Bitrate Streaming Controller.

Parameter should be a class providing a getter/setter, a `clearTimer` method, and a `destroy()` method:
Parameter should be a class providing a getter/setter 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)
- `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
1 change: 0 additions & 1 deletion src/types/component-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ export interface ComponentAPI {

export interface AbrComponentAPI extends ComponentAPI {
nextAutoLevel: Number;
clearTimer(): void;
readonly bwEstimator?: EwmaBandWidthEstimator;
}

Expand Down

0 comments on commit d7bc232

Please sign in to comment.