Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify capLevelToPlayerSize docs in API.md #6384

Merged
merged 1 commit into from
May 6, 2024
Merged

Clarify capLevelToPlayerSize docs in API.md #6384

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -485,6 +485,8 @@ This configuration will be applied by default to all instances.

- if set to true, the adaptive algorithm with limit levels usable in auto-quality by the HTML video element dimensions (width and height).
If dimensions between multiple levels are equal, the cap is chosen as the level with the greatest bandwidth.
In some devices, the video element dimensions will be multiplied by the device pixel ratio.
Use `ignoreDevicePixelRatio` for a strict level limitation based on the size of the video element.
- if set to false, levels will not be limited. All available levels could be used in auto-quality mode taking only bandwidth into consideration.

### `capLevelOnFPSDrop`
Expand Down