@ceeblue/web-utils 7.1.0 → 7.3.1

package/dist/web-utils.d.ts

@@ -1,3 +1,6 @@
+import * as CML from '@svta/common-media-library';
+export { CML };
+
 declare class BinaryReader {
     private _data;
     private _size;
@@ -136,7 +139,7 @@ interface ILog {
     /**
      * Intercept,redefine or redirect any log
      * If you clear args you intercept the log and nothing happen more after this call.
-     * @param type log level
+     * @param level log level
      * @param args args
      * @returns
      */
@@ -144,7 +147,7 @@ interface ILog {
     /**
      * Change log level, default log level is {@link LogLevel.INFO},
      * Boolean can be user to lets pass all the logs with `true` or disables all the logs with `false`.
-     * @note To debug production code without modifying it you can use a special query parameter
+     * @remarks To debug production code without modifying it you can use a special query parameter
      * called !cb-override-log-level to override this configuration.
      */
     level?: LogLevel | boolean;
@@ -817,10 +820,12 @@ declare const SDP: {
  */
 declare const EMPTY_FUNCTION: () => void;
 /**
- * Returns an efficient timestamp in milliseconds elapsed since {@link performance.timeOrigin},
+ * Returns an efficient timestamp in milliseconds elapsed since performance.timeOrigin,
  * representing the start of the current JavaScript execution context.
  *
- * Note: Each Web Worker runs in a separate JS context, so timestamps
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/Performance/timeOrigin
+ *
+ * @remarks Each Web Worker runs in a separate JS context, so timestamps
  * are not directly comparable between different workers. Use {@link unixTime}
  * for comparable timestamps across different Web Workers.
  */
@@ -956,11 +961,10 @@ declare function trimEnd(value: string, chars?: string): string;
  * Property lookup (e.g. `obj.Foo` or `obj.foo`) will resolve to the same underlying key, regardless of casing.
  * Only affects string-based property access (not symbols).
  *
- * @template T
- * @param {T} obj - The original object.
- * @returns {T} A proxied object with case-insensitive property access.
+ * @param obj - The original object.
+ * @returns A proxied object with case-insensitive property access.
  */
-declare function caseInsensitive<T extends Record<string, any>>(obj: any): T;
+declare function caseInsensitive(obj: any): Record<string, any>;
 
 declare const Util_EMPTY_FUNCTION: typeof EMPTY_FUNCTION;
 declare const Util_caseInsensitive: typeof caseInsensitive;
@@ -1182,6 +1186,51 @@ declare namespace EpochTime {
   export { EpochTime_decodeTimestamp as decodeTimestamp, EpochTime_encodeTimestamp as encodeTimestamp, EpochTime_getLatency as getLatency };
 }
 
+/**
+ * Copyright 2024 Ceeblue B.V.
+ * This file is part of https://github.com/CeeblueTV/web-utils which is released under GNU Affero General Public License.
+ * See file LICENSE or go to https://spdx.org/licenses/AGPL-3.0-or-later.html for full license details.
+ */
+
+/**
+ * Collects variable names for player statistics metrics across different projects (e.g., wrts, webrtc).
+ * Variables remain undefined if they are not present in the stats for the current project
+ * (for example, 'latency' is undefined for webrtc).
+ * Includes the toCmcd() method to convert stats into a CMCD payload.
+ */
+declare class PlayerStats {
+    protocol?: string;
+    currentTime?: number;
+    waitingData?: boolean;
+    bufferAmount?: number;
+    latency?: number;
+    rtt?: number;
+    jitter?: number;
+    playbackSpeed?: number;
+    playbackRate?: number;
+    recvByteRate?: number;
+    sendByteRate?: number;
+    videoTrackId?: number;
+    videoTrackBandwidth?: number;
+    audioTrackId?: number;
+    audioTrackBandwidth?: number;
+    videoPerSecond?: number;
+    audioPerSecond?: number;
+    skippedVideoCount?: number;
+    skippedAudioCount?: number;
+    lostPacketCount?: number;
+    nackCount?: number;
+    stallCount?: number;
+    /**
+     * Converts the current {@link PlayerStats} snapshot into a CMCD (Common Media Client Data) payload.
+     * @param url - The full URL of the media object.
+     * @param trackId - The track ID for which to generate the CMCD payload.
+     * @param prevStats - Optional previous {@link PlayerStats} snapshot to calculate deltas for incremental metrics since their last reset.
+     * @returns A {@link CML.Cmcd} object representing the CMCD payload.
+     */
+    toCmcd(url: URL, trackId: number, prevStats?: PlayerStats): CML.Cmcd;
+}
+
 /**
  * Copyright 2024 Ceeblue B.V.
  * This file is part of https://github.com/CeeblueTV/web-utils which is released under GNU Affero General Public License.
@@ -1279,4 +1328,4 @@ declare class UIMetrics {
 
 declare const VERSION: string;
 
-export { BinaryReader, BinaryWriter, BitReader, ByteRate, Connect, EpochTime, EventEmitter, FixMap, type ILog, Log, LogLevel, Loggable, NetAddress, Numbers, Queue, SDP, UIMetrics, Util, VERSION, WebSocketReliable, type WebSocketReliableError, log };
+export { BinaryReader, BinaryWriter, BitReader, ByteRate, Connect, EpochTime, EventEmitter, FixMap, type ILog, Log, LogLevel, Loggable, NetAddress, Numbers, PlayerStats, Queue, SDP, UIMetrics, Util, VERSION, WebSocketReliable, type WebSocketReliableError, log };