globocom / globocom/m3u8

"Multi-variant playlist", not "variant stream"

Open
#360 1 comment 6 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
2.3k
Forks
496
PR merge metrics
No merged PRs in 30d

Description

Hi,

Just a point of detail (and not critical) but I believe that the section https://github.com/globocom/m3u8?tab=readme-ov-file#variant-playlists-variable-bitrates is not technically correct. The "main" playlist is called multi-variant, not variant stream (see https://datatracker.ietf.org/doc/html/draft-pantos-hls-rfc8216bis-14#section-4.4.6.2).

It seems to me therefore that the property should ideally be called `.is_multi_variant`

This would however be a breaking change, and may annoy a lot of people. Maybe just adding something to the documentation to avoid confusion with the spec?

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the README section linked in the issue, “Variant Playlists (Variable Bitrates),” against the referenced HLS specification section. Clarify the terminology and explain the existing property without introducing an undocumented breaking change; the work is done when the README no longer conflates “multi-variant playlist” with “variant stream.”

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.