Skip to content

v1.6.0

Choose a tag to compare

View all tags
@github-actions github-actions released this 27 Mar 19:58
· 698 commits to master since this release
v1.6.0
f67ff35

Summary

HLS.js v1.6.0 introduces support for HLS Interstitials with new API features, media support, and playback enhancements.

New features in release version 1.6

API changes in release version 1.6

  • Added config.detectStallWithCurrentTimeMs used to specify the maximum amount of time in milliseconds before a BUFFER_STALLED_ERROR is reported when the media elements currentTime has not advanced while playing (#6941)
  • Added config.nudgeOnVideoHole whether or not to nudge the playhead when crossing over video buffer gaps to flush the rendering pipeline and ensure smooth playback through video buffered ranges (#6972)
  • Added config.enableInterstitialPlayback set to false to disable Interstitial playback without turning off Interstitials parsing and events
  • Added config.interstitialsController set to null to disable Interstitials support completely
  • Added config.interstitialAssetListLoadPolicy defines the loading policy of X-ASSET-LIST JSON
  • Added config.liveSyncOnStallIncrease (#6455) @vk342
  • Added config.maxDevicePixelRatio to limit browser value when capping level to media element dimensions (#6825) @signalwerk
  • Added config.videoPreference.videoCodec video codec selection preference option (#6483)
  • Added config options specifically for Interstitial asset player instances:
    • config.primarySessionId identifies the parent player session that spawned the asset player (read from hls.sessionId)
    • config.assetPlayerId identifies logs from asset players
    • config.timelineOffset offsets MSE appends for gapless playback
  • Support config.fetchSetup optional async result (#6714) @zce
  • Added hls.bufferedToEnd read-only indicates when EOS has been appended (media is buffered from currentTime to end of stream)
  • Added hls.bufferingEnabled read-only flag toggled with pauseBuffering() and resumeBuffering()
  • Added hls.hasEnoughToStart getter returns whether enough is buffered to seek to start position (#6571)
  • Added hls.inFlightFragments
  • Added hls.interstitialsManager read-only InterstitialsManager or null. The InterstitialsManager is an interface for accessing program information and methods for seeking across items and skipping Interstitials.
  • Added hls.latestLevelDetails read-only LevelDetails object of the most up-to-date HLS variant Playlist data
  • Added hls.loadLevelObj read-only Level object of selected level (variant) or null
  • Added hls.loadingEnabled read-only flag toggled with hls.startLoad() and hls.stopLoad()
  • Added hls.pathwayPriority Content-Steering setting (#6295) @PavelFomin90
  • Added hls.pathways getter (#6997) @grabofus
  • Added hls.sessionId read-only Hls instance UUID - used to assign a value to the _HLS_primary_id query parameter of interstitial requests
  • Added hls.startPosition read-only the resolved startPosition that playback will begin at once media is appended
  • Support setting hls.targetLatency (#6473) @vk342
  • Added hls.transferMedia() detaches and returns MediaSource and SourceBuffers non-destructively
  • Added hls.url read-only value of the currently playing url (from hls.loadSource(url)) (#6411) @ibobo
  • Added Events.MEDIA_ENDED event (#6141)
  • Added Events.STALL_RESOLVED event (#6941)
  • Added Events.EVENT_CUE_ENTER Used internally to determine when the playhead has entered a time-range replaced by an Interstitial event.
  • Added levelInfo: Level to LevelLoadingData and LevelLoadedData event data
  • Added track: MediaPlaylist to TrackLoadingData and TrackLoadedData event data (audio and subtitle events)
  • Added withoutMultiVariant: boolean to LevelLoadedData event
  • Added LevelDetais.expired read-only indicates live playlist data is no longer valid for fragment loading
  • Added LevelDetais.requestScheduled to improve live playlist reload scheduling
  • Added read-only Fragment.bitrate and Fragment.byteLength getters
  • Several Fragment properties have been replaced with accessors: get baseurl(), get/set stats(), get/set programDateTime(). Class property accessors are not enumerable. This impacts copying object properties and serialization. Fragment.stats remain enumerable with (#6999)
  • Enhancements:
    • hls.startLoad() takes a second optional argument to skip seeking on start (otherwise, HLS.js seeks following to the first optional startPosition argument on append)
    • hls.attachMedia() supports transferring MediaSource and SourceBuffers from Hls instances with hls.transferMedia()
    • hls.recoverMediaError() seeks to the value of currentTime before the source reset is performed (#6297)
  • New Events:
    • ASSET_LIST_LOADING when a request is made for an X-ASSET-LIST JSON object
    • ASSET_LIST_LOADED when a response is received for an X-ASSET-LIST JSON object
    • INTERSTITIALS_UPDATED when Interstitials are added, removed, or the schedule is updated following a variant playlist update or updated asset durations from X-ASSET-LIST JSON or asset playlist and media parsing
    • INTERSTITIALS_BUFFERED_TO_BOUNDARY when the forward buffer reaches the boundary of the following schedule item (Interstitial event or primary segment)
    • INTERSTITIAL_ASSET_PLAYER_CREATED when an asset player instance is created to stream an Interstitial asset (will always be before attaching media to the asset player)
    • INTERSTITIAL_STARTED when streaming of an Interstitial event containing one or more assets has begun (may occur before X-ASSET-LIST JSON is loaded or playback has started)
    • INTERSTITIAL_ENDED when streaming of an Interstitial event containing one or more assets has ended - before resuming primary or starting the next event
    • INTERSTITIAL_ASSET_STARTED when streaming of an Interstitial asset has begun (following the beginning of the event or the end of the last asset)
    • INTERSTITIAL_ASSET_ENDED when streaming of an Interstitial asset has ended (before the next asset or the event ending)
    • INTERSTITIAL_ASSET_ERROR when an error occurs starting or streaming an Interstitial asset (this can include non-fatal errors such as stalling and errors that will end streaming of the asset, resulting in the schedule advancing to the next asset or fallback to primary)
    • INTERSTITIALS_PRIMARY_RESUMED when playback of primary content has begun or resumed from an Interstitial event
    • BUFFERED_TO_END when the last audio and video segments in the playlist have been appended (EOS signaled on all SourceBuffers)
    • AUDIO_TRACK_UPDATED similar to LEVEL_UPDATED fired for any update to audio group playlists
    • SUBTITLE_TRACK_UPDATED similar to LEVEL_UPDATED fired for any update to subtitle group playlists
  • Updated Events
    • MEDIA_ATTACHING, MEDIA_ATTACHED, MEDIA_DETACHING, and MEDIA_DETACHED include additional information (depending on whether media is being transferred)
  • New Errors
    • Type: NETWORK_ERROR
      • details: ASSET_LIST_LOAD_ERROR network error loading asset list
      • details: ASSET_LIST_LOAD_TIMEOUT network timeout error loading asset list
      • details: ASSET_LIST_PARSING_ERROR asset list was not valid JSON or missing required data
    • Type: OTHER_ERROR
      • details: INTERSTITIAL_ASSET_ITEM_ERROR an issue interrupted or prevented asset playback. This will result in skipping the remainder of the asset or falling back to primary content. The event error will contain more details. This type of error differs from the INTERSTITIAL_ASSET_ERROR events forwarded from asset player errors.
      • details: ATTACH_MEDIA_ERROR when calling attachMedia with falsey media argument (#6556) @agajassi
      • Support more key system error detail (#6807) @JackPu
        • details: KEY_SYSTEM_DESTROY_CLOSE_SESSION_ERROR
        • details: KEY_SYSTEM_DESTROY_MEDIA_KEYS_ERROR
        • details: KEY_SYSTEM_DESTROY_REMOVE_SESSION_ERROR

Enhancements

Project exports

  • Support TypeScript Node16/NodeNext module resolution (#6616) @robwalch
  • Add missing TypeScript exports (included with #6951, #6972)
  • Export XhrLoader, FetchLoader, Cues, Events, ErrorTypes, ErrorDetails, Level, SubtitleStreamController, KeySystems, KeySystemFormats, fetchSupported, requestMediaKeySystemAccess ES Modules (#6733) @robwalch
  • Export M3U8Parser ES Modules (#7132) @Acconut
  • Add shortcut for light version (#6925) @denisx
  • Force media capabilities check for HEVC to avoid failure on Windows (#6849) @robwalch

Bug Fixes

  • Fix seek during live start on low-power devices (#7063) @grabofus
  • Live playlist advancement improvements (#6692, #6857, #6872) @robwalch
  • Limit live playlist reloading to scheduled updates (#6873) @robwalch
  • Live reload throttling per level details schedule (#6879) @robwalch
  • Wait for playlist updates before requesting segments from expired playlists (#6855) @robwalch
  • Fix fmp4 track timestamp alignment for non-av tracks (#7126)
  • Fix loop loading of empty segment with worker disabled (#7090)
  • Override media-capabilities result for HEVC support in Windows Firefox (#7048)
  • Fix JSON.stringify with circular dependencies (#7037) @martmol
  • Fix seeking into and over multiple EXT-X-GAP segments (#6988)
  • Workaround Safari "ended" event not firing when EoS is marked before seek on start (#6980) @robwalch
  • Null inline class JavaScript Event callback properties on destroy (#6102) @robwalch
  • Fix filtering of "mp4a.40.34" variants in Safari (#6130) @robwalch
  • Fix silent AAC frame generation based on original codec (#6123) @FredZeng
  • Prevent exceptions in async xhrSetup callback (#6459) @xta
  • ADTS to esds remuxing enhancements (#6627) @robwalch
    • Use AAC SBR (HE-AAC) workaround on Pale Moon (#6111) @pnaf
  • Fix Safari segment overlap issue by ensuring PTS order (#6132) @Asen-O-Nikolov
  • Don't switch level if current already greater or equal (#6223) @corndev27
  • fix: setMediaKeys return undefined in some browers (#6669) @JackPu
  • fix: assumptions in multi-drm cases where only playready is available for playback. (#6946) @cjpillsbury
  • fix: tizen 2017 widevine playback (#6657) @grabofus
  • Parse multiple pssh from "encrypted" init data and fix Widevine key ID extraction (#6640) @robwalch
  • Prevent Widevine access request on "encrypted" w/o configured license url (#6644) @robwalch
  • Prevent key errors from being emitted twice (#6704) @robwalch
  • bugfix: setAudioOption skips track selection at index 0 (#6775) @matvp91
  • Fix audio track switch where only characteristics differ (#6963) @robwalch
  • Prevent loading of audio media options with the same URI as the current level (#6785) @robwalch
  • Handle alternate audio switching and switched states (#6845) @robwalch
  • Fix loading of audio media options with the same URI as the current level (#6887) @robwalch
  • Fix reset of "ended" state after main muxed audio flush (#6921) @robwalch
  • Fix back buffer not being flushed when backBufferLength is set to 0 (#6784) @tmiller02
  • fix sidx parsing (#6221) @nklhtv
  • Fix audio/subtitles stream controllers restarting on switch after stopped (#6227, #6245) @robwalch
  • Cleanup buffer-helper functions and remove nested try-catch statements (#6228) @robwalch
  • Bugfix: preferManagedMediaSource:false when MSE is not present (#6338) @Asen-O-Nikolov
  • Bugfix: use part details to construct CMCD data when available (#6395) @littlespex
  • Fix duplicate subtitle/captions with same NAME edge-case (#6440) @robwalch
  • Fix light ESM build (#6307) @Chocobozzz
  • Paused and backward seeking enhancements (#6524) @robwalch
  • Fix parsing of multiple video codecs when converting from AVC1 to AVCOTI (#6533) @jhonatangcavalcanti
  • Improve playlist alignment based on discontinuity sequence change (#6542) @robwalch
  • Fix access of media src value with non-source children (#6615) @robwalch
  • Do not split AVC samples on Access Unit Delimiter without frame data (#6617) @robwalch
  • fix: drop fragment when currentLevel is undefined (#6730) @gjanblaszczyk
  • Fix unregister listener typo in audio-stream-controller (#6778) @robwalch
  • Bugfix: Low-Latency false starts when part selection does not match fragment (#6841) @robwalch
  • Maintain startup event order with autoStartLoad (#6893) @robwalch
  • Do not adjust initPTS without accurate playlist time offset (#6922) @robwalch

Documentation

CI

API and breaking changes

If you are upgrading from version v0.14.17 or lower, see the MIGRATING guide for API changes between v0.14.x and v1.0.0.

If upgrading from version v1.3.x or lower, the introduction of ESM exports may require changes to hls.js import statements and WebWorker setup to achieve comparable performance (#7106 (comment)).

Feedback

Please provide feedback via Issues in GitHub. For more details on how to contribute to HLS.js, see our CONTRIBUTING guide.

Contributors

fredrikj, glynd, and 38 other contributors
Assets 3
Loading