This is a preview release of version 1.0. It is feature complete and intended for testing purposes.

Changes Since Last Release

v1.0.0-beta.4...v1.0.0-beta.5

• TypeScript definitions exported with package in hls.js.d.ts file - #3454
• Support the backbuffer constraint in VOD content (backBufferLength replaces liveBackBufferLength) - #3463
• Change maxLiveSyncPlaybackRate default to 1 making live edge video.playbackRate adjustment opt-in - 58f0a61
• Fix duplicate segmented WebVTT lines - #3431
• Fix 608 parsing continuity regression (v1.0.0-beta.4 regression introduced with #3423) - #3451
• Handle comments in manifests after #EXT-X-STREAM-INF before the stream URI - #3481
• Only perform one append per segment per MPEG-TS elementary stream (in non-progressive mode) / Normalize buffer append event properties - #3489
• Update README Features section - #3479

A very big thank you to @tjenkinson, @itsjamie, @OrenMe, and @redoPop for their contributions to this release. The CI improvements, manifest parsing, TypeScript API export, VTTCue fixes, and back-buffer API improvements are much appreciated!

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:

  • backBufferLength config applies to Live and VOD content. liveBackBufferLength is still supported but marked as deprecated.
  • lowLatencyMode - set to false to disable Low-latency part loading and target latency playback rate adjustment
  • progressive- (experimental) set to true 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 and hls.subtitleTracks as well as AUDIO_TRACKS_UPDATED and SUBTITLE_TRACKS_UPDATED events only list tracks in the active level's audio/sub GROUP-ID after LEVEL_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 changed
  • trequest, tfirst, tload have been replaced by loading: HlsProgressivePerformanceTiming
  • tparsed has been replaced by parsing: HlsProgressivePerformanceTiming
• On the Fragment object:
  • hasElementaryStream function has been removed
  • setElementaryStream 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 and hls.subtitleTracks as well as AUDIO_TRACKS_UPDATED and SUBTITLE_TRACKS_UPDATED events only list tracks in the active level's audio/sub GROUP-ID after LEVEL_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.
• 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 with hls.currentLevel that do not want a stall reported should either pause or set video.playbackRate to 0 until the level switch is complete.
• The new backBufferLength default of 90 seconds applies to Live and VOD streams. As a result, the back buffer on VOD content will be cleared by hls.js than leaving it up to the browser. Set backBufferLength to Infinity and the deprecated liveBackBufferLength to 90 to enforce the old behavior.

Known Issues

• This release includes a regression that prevents LL-HLS parts from being buffered correctly
• This release includes a regression that prevents hls.light.*js from running
• Missing support for multiple EXT-X-MAP tags (Issue #1990, PR #3312)
• Intermittent issues with audio track sync on live fragmented mp4

Summary

Demo Page

https://hls-js-d35d1f0b-f649-484b-8db0-94a19569eb1d.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.