v1.0.0-beta.4
Pre-release
Pre-release
This is a preview release of version 1.0. It is feature complete and intended for testing purposes.
Changes Since Last Release
- Captions bug fixes:
- Update audio and subtitle group-id on
LEVEL_SWITCHING
in addition toLEVEL_LOADING
. Fixes groups not changing for levels that have already loaded during VOD playback. - Allow fragment loading error retries to run before level recovery - #3404 Fixes #3381 (Thank you @flavioribeiro for the heads up on the impact this issue had on live streams)
- Fix SAMPLE-AES MPEG-TS streaming - #3388
- Escalate level-contoller error to fatal if level was removed - b516437
- TypeScript modules - Thank you to @jwalton for converting exp-golomb #3382, sample-aes and cleaning up Demuxers #3384 🔥 ☎️
- Use full commit hashes in workflows - Thank you @tjenkinson for #3419
- Add promise-polyfill to demo and functional test runner - #3367 📧
New Features
- Apple Low-Latency HLS support
- Improved support for redundant variants with tracks
- Improved audio and subtitle track selection with multiple media and stream variants containing different GROUP-ID values
- Progressive streaming option (experimental)
- Basic IMSC1 support (experimental)
API Changes
- New config options:
lowLatencyMode
- set tofalse
to disable Low-latency part loading and target latency playback rate adjustmentprogressive
- (experimental) set totrue
to stream and append loaded audio and video data before each segment load completion. Not recommended for production or small segments with only a single GoP or less.
- Event order and content has changed in some places. See Breaking Changes below, and please report any issues with breaking changes that impact your integrations
hls.audioTracks
andhls.subtitleTracks
as well asAUDIO_TRACKS_UPDATED
andSUBTITLE_TRACKS_UPDATED
events only list tracks in the active level's audio/sub GROUP-ID afterLEVEL_LOADING
- #3293- Added
groupId
to audio and subtitle track loading and loaded events - Added additional error details to help identify the source of certain network error events:
SUBTITLE_LOAD_ERROR
SUBTITLE_TRACK_LOAD_TIMEOUT
UNKNOWN
Breaking Changes
- Promise support is now required. Please bring your own polyfill
- The
stats
object has changedtrequest
,tfirst
,tload
have been replaced byloading: HlsProgressivePerformanceTiming
tparsed
has been replaced byparsing: HlsProgressivePerformanceTiming
- On the
Fragment
object:hasElementaryStream
function has been removedsetElementaryStream
and_elementaryStreams
have been renamed (these are only for internal use)
FRAG_LOADED
fires after events handled on progress which can include everything up to appending a fragment if workers are disabled (more details below under Known Issues)BUFFER_CODECS
data has changed from{ tracks: { video?, audio? } }
to simply{ video?, audio? }
BUFFER_APPENDING
data has changed from{ type, data, parent, content }
to{ type, data, frag, chunkMeta }
BUFFER_APPENDED
data has changed- Event binding should remain unchanged using the public API, but refer to #2395 if experiencing an issue with changes to event constants.
- As mentioned in API changes,
hls.audioTracks
andhls.subtitleTracks
as well asAUDIO_TRACKS_UPDATED
andSUBTITLE_TRACKS_UPDATED
events only list tracks in the active level's audio/sub GROUP-ID afterLEVEL_LOADING
(this will go unnoticed for streams with no or only one group per track type)- The
MANIFEST_PARSED
event still reports all tracks when multiple GROUP-ID values are present. Applications that used that event to get tracks would need to be updated in v1 to switch to the corresponding track update events to select available tracks using the available indexes. - Track ids are no longer indexes of the complete list of audio or subtitle tracks. They are now indexes within each group. So six tracks in two groups that had ids 0,1,2,3,4,5 will now have ids 0,1,2,0,1,2. This allows for tracks to be changed by index/id within the range of available tracks as they were before.
- The
- Setting
hls.currentLevel
no longer pauses the media element while clearing the buffer and loading the new level. This can result in a stall error if playback doesn't start within a quarter of a second. Applications implementing manual quality switching withhls.currentLevel
that do not want a stall reported should either pause or setvideo.playbackRate
to0
until the level switch is complete.
Known Issues
- Missing support for multiple EXT-X-MAP tags (Issue #1990, PR #3312)
- Intermittent issues with audio track sync on live fragmented mp4
- There are two append events for each fragment when
progressive
mode is disabled (by default), and theFRAG_LOADED
event comes after parsed and, in some cases, buffered event. The was part of the progressive refactor, and changes have been made internally to support this, but I would still like fragments to be loaded and then parsed and buffered as a whole by default before the GM release.
Summary
Demo Page
https://hls-js-0bd03ae0-14e6-4a69-a198-a0fa2cc343ea.netlify.app/demo/
Feedback
To provide feedback please a bug report or feature request via the issue tracker.
If you do file an issue, please include a test stream, and consider contributing to #3065.