@oddin-gg/havik-player 2.17.0 → 2.19.0

package/dist/index.d.cts

@@ -98,6 +98,9 @@ export declare interface CatalogTournament {
  */
 export declare function clearDeviceId(): void;
 
+/** Forget every remembered estimate (privacy / "reset player data" control). */
+export declare function clearRememberedBandwidth(): void;
+
 /**
  * Endpoint selection, enforced at COMPILE time.
  *
@@ -193,6 +196,17 @@ export declare interface CreatePlayerOptions {
      * return is the one from before leaving. Default: true. Live/LL only.
      */
     snapToLiveOnRefocus?: boolean;
+    /**
+     * Start a stream at the quality this device's last measured speed allows,
+     * instead of always at ~360p. The hls.js engine saves its bandwidth estimate
+     * in localStorage (key `havik.player.bandwidth`, per connection type where the
+     * browser reports one) after ~10 s of playback and reuses it, discounted to
+     * 80%, for up to 3 days; a device that measured a slow line starts from that
+     * lower figure (never below 0.3 Mbps). A first visit, a stale record, or
+     * blocked storage keeps the conservative ~1 Mbps start. An explicit
+     * hlsConfig.abrEwmaDefaultEstimate or startLevel still wins. Default: true.
+     */
+    rememberBandwidth?: boolean;
     /**
      * DRM cold start: download the first init segment and parts while the
      * first key is still being acquired, instead of after it (hls.js waits for
@@ -610,6 +624,26 @@ export declare type FrameToHost = {
     message: string;
 };
 
+/**
+ * Whether a fullscreen presentation for `video` can work, by the same
+ * ladder enterVideoFullscreen walks. False means a request is KNOWN to
+ * fail, so the caller should hide its button:
+ *
+ *  - the element API exists on `container` (or the video) but the document
+ *    reports `fullscreenEnabled === false` — the Fullscreen spec sets that
+ *    exactly when permissions policy blocks the feature, which is what a
+ *    cross-origin iframe without `fullscreen` in its `allow` list looks
+ *    like (prefixed `webkitFullscreenEnabled` on older Safari);
+ *  - no element API at all, media already loaded, and the video does not
+ *    offer the video-native presentation either (a webview with nothing).
+ *
+ * True otherwise — including "not known yet": with no element API and
+ * media not loaded (iPhone before the first play) the video-native flag
+ * is not readable, so the answer stays optimistic. Re-check on
+ * `loadedmetadata`; the managed control bar does.
+ */
+export declare function fullscreenSupported(video: HTMLVideoElement, container?: HTMLElement): boolean;
+
 export declare function getDeviceId(): string;
 
 /**
@@ -983,6 +1017,14 @@ export declare interface Player {
     enterFullscreen(): Promise<boolean>;
     /** Leave fullscreen (element or video-native). Safe when not fullscreen. */
     exitFullscreen(): Promise<void>;
+    /**
+     * Whether enterFullscreen can work here: false when the page's permissions
+     * policy blocks fullscreen (an iframe without `fullscreen` in `allow`) or
+     * the platform has no mechanism, so a custom UI can hide its button. Stays
+     * true before media loads on iPhone (not knowable yet); re-check on the
+     * video's `loadedmetadata`.
+     */
+    fullscreenSupported(): boolean;
     /** Retry playback after an error (re-resolves and re-attaches). */
     retry(): Promise<void>;
     /** Re-resolve playback (refreshes the signed license URL) and re-attach. */

package/dist/index.d.ts

@@ -98,6 +98,9 @@ export declare interface CatalogTournament {
  */
 export declare function clearDeviceId(): void;
 
+/** Forget every remembered estimate (privacy / "reset player data" control). */
+export declare function clearRememberedBandwidth(): void;
+
 /**
  * Endpoint selection, enforced at COMPILE time.
  *
@@ -193,6 +196,17 @@ export declare interface CreatePlayerOptions {
      * return is the one from before leaving. Default: true. Live/LL only.
      */
     snapToLiveOnRefocus?: boolean;
+    /**
+     * Start a stream at the quality this device's last measured speed allows,
+     * instead of always at ~360p. The hls.js engine saves its bandwidth estimate
+     * in localStorage (key `havik.player.bandwidth`, per connection type where the
+     * browser reports one) after ~10 s of playback and reuses it, discounted to
+     * 80%, for up to 3 days; a device that measured a slow line starts from that
+     * lower figure (never below 0.3 Mbps). A first visit, a stale record, or
+     * blocked storage keeps the conservative ~1 Mbps start. An explicit
+     * hlsConfig.abrEwmaDefaultEstimate or startLevel still wins. Default: true.
+     */
+    rememberBandwidth?: boolean;
     /**
      * DRM cold start: download the first init segment and parts while the
      * first key is still being acquired, instead of after it (hls.js waits for
@@ -610,6 +624,26 @@ export declare type FrameToHost = {
     message: string;
 };
 
+/**
+ * Whether a fullscreen presentation for `video` can work, by the same
+ * ladder enterVideoFullscreen walks. False means a request is KNOWN to
+ * fail, so the caller should hide its button:
+ *
+ *  - the element API exists on `container` (or the video) but the document
+ *    reports `fullscreenEnabled === false` — the Fullscreen spec sets that
+ *    exactly when permissions policy blocks the feature, which is what a
+ *    cross-origin iframe without `fullscreen` in its `allow` list looks
+ *    like (prefixed `webkitFullscreenEnabled` on older Safari);
+ *  - no element API at all, media already loaded, and the video does not
+ *    offer the video-native presentation either (a webview with nothing).
+ *
+ * True otherwise — including "not known yet": with no element API and
+ * media not loaded (iPhone before the first play) the video-native flag
+ * is not readable, so the answer stays optimistic. Re-check on
+ * `loadedmetadata`; the managed control bar does.
+ */
+export declare function fullscreenSupported(video: HTMLVideoElement, container?: HTMLElement): boolean;
+
 export declare function getDeviceId(): string;
 
 /**
@@ -983,6 +1017,14 @@ export declare interface Player {
     enterFullscreen(): Promise<boolean>;
     /** Leave fullscreen (element or video-native). Safe when not fullscreen. */
     exitFullscreen(): Promise<void>;
+    /**
+     * Whether enterFullscreen can work here: false when the page's permissions
+     * policy blocks fullscreen (an iframe without `fullscreen` in `allow`) or
+     * the platform has no mechanism, so a custom UI can hide its button. Stays
+     * true before media loads on iPhone (not knowable yet); re-check on the
+     * video's `loadedmetadata`.
+     */
+    fullscreenSupported(): boolean;
     /** Retry playback after an error (re-resolves and re-attaches). */
     retry(): Promise<void>;
     /** Re-resolve playback (refreshes the signed license URL) and re-attach. */