Skip to content

Conversation

@krseager
Copy link
Collaborator

@krseager krseager commented Nov 6, 2025

This PR will document undocumented HLSConfig items

Why is this Pull Request needed?

Documentation is currently incomplete.

Are there any points in the code the reviewer needs to double check?

Ensure documentation for added items is clear and concise.

Resolves issues:

#7627

Checklist

  • changes have been done against master branch, and PR does not conflict
  • new unit / functional tests have been added (whenever applicable)
  • API or design changes are documented in API.md

@robwalch robwalch linked an issue Nov 7, 2025 that may be closed by this pull request
docs/API.md Outdated
Default value is set via [`capLevelToPlayerSize`](#capleveltoplayersize) in config.
### `hls.useMediaCapabilities`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

useMediaCapabilities is a config property, not a top-level getter/setter.

It should be under Fine Tuning with the other config options, otherwise, remove hls. from the description.

The default value is true except in the light build or custom builds with setting the __USE_MEDIA_CAPABILITIES__ flag to false.

Copy link
Collaborator Author

@krseager krseager Nov 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

@robwalch robwalch merged commit 66d523e into video-dev:master Nov 7, 2025
12 checks passed
@github-project-automation github-project-automation bot moved this from Top priorities to Done in HLS.js Release Planning and Backlog Nov 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

Improve HLS.js documentation

2 participants