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.2...v1.0.0-beta.3

• Add support for codec switching with MediaSource.changeType #3358
• Fixed MP3 buffering issues #3358 - Fixes #3323, #3151
• Setting currentLevel no longer results in media.pause() being called and "pause" events being dispatched #3326
• ABR level selection stays within current codec set (audio/video codec profile can change, but not the codec itself) #3357
• Fixed audio track buffering issue in Safari #3356
• Fixed backtracking of semi-independent video segments and backtracking with worker enabled #3355
• Improved logging of codec details #3354
• Remux audio-only stream contiguously #3352
• Fix handling of TS segments with elementary audio streams, but no audio samples or content #3351

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)

Bug Fixes and improvements

• TypeScript modules
• Improve remuxing of non-independent segments and backtracking (with worker disabled) - fixes #2808
• Use TypeScript type imports where applicable - #3304
• Set media duration when attaching after level update
• Prevent SourceBuffer unhandled exceptions dealing with MPEG audio

API Changes

• New config options:
  • 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)
• 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.

Known Issues

• SAMPLE-AES streams not working: Uncaught (in promise) TypeError: this.decrypter.decrypt is not a function.
• Duplicate or redundant ID3 (#1975) and CC (#3321) cues may be appended for time ranges when a level change overwrites buffered data.
• 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-d692af77-f25a-4f63-bd2b-bf8087e2ca2f.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.