@oddin-gg/havik-player 2.0.3 → 2.1.0

package/dist/index.d.cts

@@ -67,7 +67,16 @@ export declare interface CreatePlayerOptions {
     baseUrl: string;
     matchUrn: string;
     credential: CredentialSource;
-    /** Start playback once ready. Default: true. */
+    /**
+     * Start playback once ready. Default: true. With false the player resolves
+     * playback, then holds in a pre-play 'paused' state (poster + play card,
+     * no spinner) and defers media loading — segments and DRM license traffic —
+     * until the first play(). The hls.js engine still parses the manifest
+     * pre-play ('ready', track lists); the native engine defers all fetching
+     * and emits 'ready' at attach. A policy-blocked programmatic play()
+     * ('autoplayblocked') leaves the loader warming the buffer — media and DRM
+     * traffic flows from that kick, not from a viewer gesture.
+     */
     autoplay?: boolean;
     /** Mute the element (required for reliable autoplay with sound policies). Default: false. */
     muted?: boolean;
@@ -208,8 +217,10 @@ export declare interface CreatePlayerOptions {
      * `{ endpoint }` to point at a non-conventional beacons host.
      *
      * Privacy: the sid is an opaque per-session id, held in memory only and
-     * never persisted; beacons carry playback QoE numbers, never identifiers
-     * beyond the sid. See the analytics plan (D11) for the full posture.
+     * never persisted. Beacons carry playback QoE numbers plus the session's
+     * environment (form factor, device model and OS version where the browser
+     * offers client hints, screen, connection, embedding origin) — never an
+     * IP, never the raw user agent, and no identifier beyond the sid.
      */
     analytics?: boolean | {
         endpoint?: string;
@@ -645,6 +656,8 @@ export declare interface PlaybackErrorInit {
 
 export declare interface PlaybackStats {
     droppedFrames: number;
+    /** Frames decoded this session — the denominator dropped frames need. */
+    decodedFrames?: number;
     /** Live-edge latency in seconds (hls.js engine only). */
     latencySeconds?: number;
     /** The live-sync target latency hls.js is converging to, in seconds. Compare
@@ -670,6 +683,28 @@ export declare interface PlaybackStats {
     renditionBitrateKbps?: number;
     /** Duration of the most recent DRM license acquisition in ms (0 = none yet). */
     licenseTimeMs?: number;
+    /** RFC 6381 codec strings of the current rendition. */
+    videoCodec?: string;
+    audioCodec?: string;
+    /** The offered rendition ladder, ascending heights, and its top bitrate. */
+    ladderHeights?: number[];
+    ladderTopBitrateKbps?: number;
+    /** DRM the engine negotiated for the session. */
+    keySystem?: 'widevine' | 'fairplay' | 'none';
+    /** Robustness requested/granted, e.g. Widevine L3 (software) on the web. */
+    drmSecurityLevel?: string;
+    /** The viewer pinned a quality; ABR is not deciding. */
+    qualityPinned?: boolean;
+    /** Cumulative ABR switch direction split (renditionSwitches = both). */
+    upshifts?: number;
+    downshifts?: number;
+    /** Cumulative media requests completed / failed, and the durations of the
+     *  most recent ones (ms, newest last, bounded) for interval percentiles. */
+    requestCount?: number;
+    requestErrors?: number;
+    requestTimesMs?: number[];
+    /** Host of the most recent media request — host only, never the path. */
+    cdnHost?: string;
 }
 
 export declare interface Player {

package/dist/index.d.ts

@@ -67,7 +67,16 @@ export declare interface CreatePlayerOptions {
     baseUrl: string;
     matchUrn: string;
     credential: CredentialSource;
-    /** Start playback once ready. Default: true. */
+    /**
+     * Start playback once ready. Default: true. With false the player resolves
+     * playback, then holds in a pre-play 'paused' state (poster + play card,
+     * no spinner) and defers media loading — segments and DRM license traffic —
+     * until the first play(). The hls.js engine still parses the manifest
+     * pre-play ('ready', track lists); the native engine defers all fetching
+     * and emits 'ready' at attach. A policy-blocked programmatic play()
+     * ('autoplayblocked') leaves the loader warming the buffer — media and DRM
+     * traffic flows from that kick, not from a viewer gesture.
+     */
     autoplay?: boolean;
     /** Mute the element (required for reliable autoplay with sound policies). Default: false. */
     muted?: boolean;
@@ -208,8 +217,10 @@ export declare interface CreatePlayerOptions {
      * `{ endpoint }` to point at a non-conventional beacons host.
      *
      * Privacy: the sid is an opaque per-session id, held in memory only and
-     * never persisted; beacons carry playback QoE numbers, never identifiers
-     * beyond the sid. See the analytics plan (D11) for the full posture.
+     * never persisted. Beacons carry playback QoE numbers plus the session's
+     * environment (form factor, device model and OS version where the browser
+     * offers client hints, screen, connection, embedding origin) — never an
+     * IP, never the raw user agent, and no identifier beyond the sid.
      */
     analytics?: boolean | {
         endpoint?: string;
@@ -645,6 +656,8 @@ export declare interface PlaybackErrorInit {
 
 export declare interface PlaybackStats {
     droppedFrames: number;
+    /** Frames decoded this session — the denominator dropped frames need. */
+    decodedFrames?: number;
     /** Live-edge latency in seconds (hls.js engine only). */
     latencySeconds?: number;
     /** The live-sync target latency hls.js is converging to, in seconds. Compare
@@ -670,6 +683,28 @@ export declare interface PlaybackStats {
     renditionBitrateKbps?: number;
     /** Duration of the most recent DRM license acquisition in ms (0 = none yet). */
     licenseTimeMs?: number;
+    /** RFC 6381 codec strings of the current rendition. */
+    videoCodec?: string;
+    audioCodec?: string;
+    /** The offered rendition ladder, ascending heights, and its top bitrate. */
+    ladderHeights?: number[];
+    ladderTopBitrateKbps?: number;
+    /** DRM the engine negotiated for the session. */
+    keySystem?: 'widevine' | 'fairplay' | 'none';
+    /** Robustness requested/granted, e.g. Widevine L3 (software) on the web. */
+    drmSecurityLevel?: string;
+    /** The viewer pinned a quality; ABR is not deciding. */
+    qualityPinned?: boolean;
+    /** Cumulative ABR switch direction split (renditionSwitches = both). */
+    upshifts?: number;
+    downshifts?: number;
+    /** Cumulative media requests completed / failed, and the durations of the
+     *  most recent ones (ms, newest last, bounded) for interval percentiles. */
+    requestCount?: number;
+    requestErrors?: number;
+    requestTimesMs?: number[];
+    /** Host of the most recent media request — host only, never the path. */
+    cdnHost?: string;
 }
 
 export declare interface Player {