@oddin-gg/havik-player 2.15.6 → 2.16.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. package/dist/havik-player.global.js +2 -2
  2. package/dist/havik-player.global.js.map +1 -1
  3. package/dist/index.cjs +2 -2
  4. package/dist/index.cjs.map +1 -1
  5. package/dist/index.d.cts +9 -3
  6. package/dist/index.d.ts +9 -3
  7. package/dist/index.js +191 -155
  8. package/dist/index.js.map +1 -1
  9. package/docs/API.md +2 -2
  10. package/embed/index.html +1 -1
  11. package/examples/vanilla.html +1 -1
  12. package/package.json +1 -1
package/dist/index.d.cts CHANGED
@@ -183,8 +183,12 @@ export declare interface CreatePlayerOptions {
183
183
  */
184
184
  liveLatencyTarget?: number;
185
185
  /**
186
- * Snap straight to the live edge when a backgrounded tab is refocused and
187
- * playback has fallen well behind. Default: true. Live/LL only.
186
+ * Snap to the live edge when a backgrounded tab is refocused. hls.js engine:
187
+ * only when playback has fallen well behind. Native engine (iPhone, iPad,
188
+ * FairPlay): on every return after 2 s or more in the background, and on
189
+ * every page restored from the back/forward cache (pageshow with persisted),
190
+ * landing 3 s behind the edge, because the seek is also what makes iOS
191
+ * redraw a picture it left black. Default: true. Live/LL only.
188
192
  */
189
193
  snapToLiveOnRefocus?: boolean;
190
194
  /**
@@ -863,7 +867,9 @@ export declare interface PlaybackStats {
863
867
  * contract rename is not worth a migration (plan D10). Read it as "total".
864
868
  */
865
869
  decodedFrames?: number;
866
- /** Live-edge latency in seconds (hls.js engine only). */
870
+ /** Live-edge latency in seconds: how far the playhead is behind the newest
871
+ * media the player knows about. hls.js engine: hls.js's own figure (includes
872
+ * playlist age). Native engine: end of the seekable range minus the playhead. */
867
873
  latencySeconds?: number;
868
874
  /** The live-sync target latency hls.js is converging to, in seconds. Compare
869
875
  * against latencySeconds to see drift. */
package/dist/index.d.ts CHANGED
@@ -183,8 +183,12 @@ export declare interface CreatePlayerOptions {
183
183
  */
184
184
  liveLatencyTarget?: number;
185
185
  /**
186
- * Snap straight to the live edge when a backgrounded tab is refocused and
187
- * playback has fallen well behind. Default: true. Live/LL only.
186
+ * Snap to the live edge when a backgrounded tab is refocused. hls.js engine:
187
+ * only when playback has fallen well behind. Native engine (iPhone, iPad,
188
+ * FairPlay): on every return after 2 s or more in the background, and on
189
+ * every page restored from the back/forward cache (pageshow with persisted),
190
+ * landing 3 s behind the edge, because the seek is also what makes iOS
191
+ * redraw a picture it left black. Default: true. Live/LL only.
188
192
  */
189
193
  snapToLiveOnRefocus?: boolean;
190
194
  /**
@@ -863,7 +867,9 @@ export declare interface PlaybackStats {
863
867
  * contract rename is not worth a migration (plan D10). Read it as "total".
864
868
  */
865
869
  decodedFrames?: number;
866
- /** Live-edge latency in seconds (hls.js engine only). */
870
+ /** Live-edge latency in seconds: how far the playhead is behind the newest
871
+ * media the player knows about. hls.js engine: hls.js's own figure (includes
872
+ * playlist age). Native engine: end of the seekable range minus the playhead. */
867
873
  latencySeconds?: number;
868
874
  /** The live-sync target latency hls.js is converging to, in seconds. Compare
869
875
  * against latencySeconds to see drift. */