Documentation - Add interface for AbrController #4842
Conversation
lpommers
force-pushed
the
feature/interface-for-abr-controller
branch
3 times, most recently
from
b69361c
to
c01d891
Compare
docs/API.md
Outdated
|
|
||
| - 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 |
There was a problem hiding this comment.
Rather than defining what clearTimer() does in the current ABR controller, we should describe when it is called from hls.ts, and why. Well, this is why, but as mentioned there are probably better ways to check and stop checking if a fragment is taking too long to load.
I am tempted to leave this undocumented. It was only added as fix in #3556, and I would like to remove in the next minor. Let me know if that conflicts with your own custom ABR controller implementation.
There was a problem hiding this comment.
That doesn't conflict with our with custom ABR Controller at all. I can push up a commit dropping clearTimer from the documentation
There was a problem hiding this comment.
Removed clearTimer in d7bc232
lpommers
force-pushed
the
feature/interface-for-abr-controller
branch
from
5e8dd2a
to
d7bc232
Compare
lpommers
force-pushed
the
feature/interface-for-abr-controller
branch
from
d7bc232
to
fff8c75
Compare
lpommers
force-pushed
the
feature/interface-for-abr-controller
branch
from
fff8c75
to
2faf9b7
Compare
This reverts commit 617d78b.
* create an interface for abr controllers * use AbrComponentApi interface in abr-controller.ts * update docs for custom abr controllers * remove clearTimer from abr interface and documentation
* create an interface for abr controllers * use AbrComponentApi interface in abr-controller.ts * update docs for custom abr controllers * remove clearTimer from abr interface and documentation
This PR will...
Create a type interface for the AbrController
Why is this Pull Request needed?
Users can implement their own Custom AbrController. Having a typed interface for Abr Controllers will help developers understand what properties and methods their Custom AbrControllers must implement to operate with hls.js
Are there any points in the code the reviewer needs to double check?
re: #4824 (comment)
I didn't see any prior art for linking directly to src/types in the API documentation, so I just updated the API.md file directly, but am willing to link directly to src/types if that's preferred.
It wasn't specified in the above comment, but because the docs also mention:
I added the
bwEstimatorto the interface. This could probably use some 👀, since I'm not sure if that was correct or not.Resolves issues:
Closes #4824
Checklist