@vindral/web-sdk 4.1.4 → 4.1.5-10-g4a74bcc5

package/README.md

@@ -46,6 +46,12 @@ Install @vindral/web-sdk using `npm`:
 npm install --save @vindral/web-sdk
 ```
 
+or `pnpm`:
+
+```bash
+pnpm install --save @vindral/web-sdk
+```
+
 or `yarn`:
 
 ```bash

package/api-client.d.ts

@@ -18,6 +18,10 @@ export interface Channel {
 	 * URLs to fetch thumbnail from
 	 */
 	thumbnailUrls: string[];
+	/**
+	 * Urls for timeshift if available
+	 */
+	timeshiftUrls?: string[];
 }
 interface ClientOverrides {
 	maxVideoBitRate?: number;
@@ -150,6 +154,10 @@ interface MoQConnectInfo {
 	telemetry?: Telemetry;
 	channels: ChannelWithCatalog[];
 	edges: Edge[];
+	timeshift: {
+		urls: string[];
+		duration: string;
+	};
 }
 interface VindralConnectInfo {
 	logsUrl?: string;

package/api-client.js

@@ -1,4 +1,4 @@
-import { A as o } from "./Bs3ZbgIy.js";
+import { A as o } from "./CPEMXA01.js";
 export {
   o as ApiClient
 };

package/cast-sender.d.ts

@@ -245,6 +245,14 @@ interface Options {
 	 * This can be used to provide user options to limit the video bandwidth usage.
 	 */
 	maxVideoBitRate?: number;
+	/**
+	 * Initial maximum bit rate cap applied when first connecting to a channel.
+	 * This helps prevent buffering on initial connection by starting at a conservative bitrate.
+	 * The client will adapt to higher bitrates as bandwidth allows if ABR is enabled.
+	 *
+	 * Default is 2.5 Mbps (2500000 bits per second).
+	 */
+	maxInitialBitRate?: number;
 	/**
 	 * Controls video element background behaviour while loading.
 	 * - If `false`, a black background will be shown.
@@ -257,6 +265,14 @@ interface Options {
 	 * Whether to start the player muted or to try to start playing audio automatically.
 	 */
 	muted?: boolean;
+	/**
+	 * Initial volume level for the player. A floating point value between 0-1.
+	 * Default is 1 (100% volume).
+	 *
+	 * Note: Volume cannot be set on iOS devices due to system restrictions.
+	 * The volume property is not settable in JavaScript on iOS, and reading it always returns 1.
+	 */
+	volume?: number;
 	/**
 	 * Provide a custom reconnect handler to control when the instance should stop trying to
 	 * reconnect. The reconnect handler should either return true to allow the reconnect or

package/core.d.ts

@@ -15,6 +15,10 @@ interface Channel {
 	 * URLs to fetch thumbnail from
 	 */
 	thumbnailUrls: string[];
+	/**
+	 * Urls for timeshift if available
+	 */
+	timeshiftUrls?: string[];
 }
 interface ClientOverrides {
 	maxVideoBitRate?: number;
@@ -219,6 +223,10 @@ interface MoQConnectInfo {
 	telemetry?: Telemetry;
 	channels: ChannelWithCatalog[];
 	edges: Edge[];
+	timeshift: {
+		urls: string[];
+		duration: string;
+	};
 }
 interface VindralConnectInfo {
 	logsUrl?: string;
@@ -452,6 +460,14 @@ export interface Options {
 	 * This can be used to provide user options to limit the video bandwidth usage.
 	 */
 	maxVideoBitRate?: number;
+	/**
+	 * Initial maximum bit rate cap applied when first connecting to a channel.
+	 * This helps prevent buffering on initial connection by starting at a conservative bitrate.
+	 * The client will adapt to higher bitrates as bandwidth allows if ABR is enabled.
+	 *
+	 * Default is 2.5 Mbps (2500000 bits per second).
+	 */
+	maxInitialBitRate?: number;
 	/**
 	 * Controls video element background behaviour while loading.
 	 * - If `false`, a black background will be shown.
@@ -464,6 +480,14 @@ export interface Options {
 	 * Whether to start the player muted or to try to start playing audio automatically.
 	 */
 	muted?: boolean;
+	/**
+	 * Initial volume level for the player. A floating point value between 0-1.
+	 * Default is 1 (100% volume).
+	 *
+	 * Note: Volume cannot be set on iOS devices due to system restrictions.
+	 * The volume property is not settable in JavaScript on iOS, and reading it always returns 1.
+	 */
+	volume?: number;
 	/**
 	 * Provide a custom reconnect handler to control when the instance should stop trying to
 	 * reconnect. The reconnect handler should either return true to allow the reconnect or
@@ -785,6 +809,20 @@ interface IncomingDataModuleStatistics {
 	 */
 	bytesReceived: number;
 }
+interface JitterStatistics {
+	/** Minimum jitter in the recent window */
+	min: number;
+	/** Maximum jitter in the recent window for spike detection */
+	max: number;
+	/** Latest average jitter in ms (recent window) */
+	last: number;
+	/** Average jitter in ms (RFC 3550 style, smoothed with /16) */
+	average: number;
+}
+interface JitterModuleStatistics {
+	audioJitter: JitterStatistics | undefined;
+	videoJitter: JitterStatistics | undefined;
+}
 interface MseModuleStatistics {
 	quotaErrorCount: number;
 	mediaSourceOpenTime: number;
@@ -808,11 +846,11 @@ interface QualityOfServiceModuleStatistics {
 	 */
 	fatalQosCount: number;
 	/**
-	 * Ratio of time being spent on different bitrates.
-	 * Example: `"timeSpentRatio": { "1160000": 0.2, "2260000": 0.8 }` shows 20% spent on 1.16 Mbps, 80% spent on 2.26 Mbps.
+	 * Ratio of time being spent on different quality indexes. Index 0 is always the highest quality.
+	 * Example: `"timeSpentRatio": { "0": 0.8, "1": 0.2 }` shows 80% spent on the best level, 20% on the next one.
 	 */
 	timeSpentRatio: {
-		[bitRate: string]: number;
+		[qualityIndex: string]: number;
 	};
 }
 interface SyncModuleStatistics {
@@ -859,7 +897,7 @@ declare class UserAgentInformation {
 		userAgent: string;
 	};
 }
-type ModuleStatistics = AdaptivityStatistics & BufferTimeStatistics & ConnectionStatistics & ConstraintCapStatistics & DecoderStatistics & DocumentStateModulesStatistics & IncomingDataModuleStatistics & MseModuleStatistics & PlaybackModuleStatistics & QualityOfServiceModuleStatistics & RenditionsModuleStatistics & SyncModuleStatistics & TelemetryModuleStatistics & VideoPlayerStatistics;
+type ModuleStatistics = AdaptivityStatistics & BufferTimeStatistics & ConnectionStatistics & ConstraintCapStatistics & DecoderStatistics & DocumentStateModulesStatistics & IncomingDataModuleStatistics & JitterModuleStatistics & MseModuleStatistics & PlaybackModuleStatistics & QualityOfServiceModuleStatistics & RenditionsModuleStatistics & SyncModuleStatistics & TelemetryModuleStatistics & VideoPlayerStatistics;
 /**
  * Contains internal statistics.
  *
@@ -909,6 +947,10 @@ export type Statistics = ModuleStatistics & ReturnType<UserAgentInformation["get
 	 */
 	timeToFirstFrame?: number;
 	iosMediaElementEnabled?: boolean;
+	/**
+	 * Average bitrate for the entire session in bits/second.
+	 */
+	averageBitRate?: number;
 };
 /**
  * Represents a Vindral client instance
@@ -949,7 +991,6 @@ export type Statistics = ModuleStatistics & ReturnType<UserAgentInformation["get
 export declare class Vindral extends Emitter<PublicVindralEvents> {
 	#private;
 	private static MAX_POOL_SIZE;
-	private static INITIAL_MAX_BIT_RATE;
 	private static DISCONNECT_TIMEOUT;
 	private static REMOVE_CUE_THRESHOLD;
 	/**
@@ -1425,6 +1466,10 @@ export interface VolumeState {
 	 */
 	volume: number;
 }
+interface TimeShiftInfo {
+	urls: string[];
+	duration: string;
+}
 /**
  * The events that can be emitted from the Vindral instance
  */
@@ -1524,6 +1569,10 @@ export interface PublicVindralEvents {
 	 * from external sources such as OS media shortcuts or other native UI outside of the browser.
 	 */
 	["volume state"]: Readonly<VolumeState>;
+	/**
+	 * Emitted when the timeshift URLs are updated.
+	 */
+	["timeshift info"]: Readonly<TimeShiftInfo>;
 	["buffer state event"]: Readonly<BufferStateEvent>;
 	["initialized media"]: void;
 }

package/core.js

@@ -1,4 +1,4 @@
-import { c as C, e as I, f as _, a as O, C as D, D as T, I as a, N as A, V as s, g as r } from "./DTm3XZjU.js";
+import { c as C, e as I, f as _, a as O, C as D, D as T, I as a, N as A, V as s, g as r } from "./DpmCSjGZ.js";
 export {
   C as AUTHENTICATION_EXPIRED_CODE,
   I as AUTHENTICATION_FAILED_CODE,

package/legacy.d.ts

@@ -18,6 +18,10 @@ export interface Channel {
 	 * URLs to fetch thumbnail from
 	 */
 	thumbnailUrls: string[];
+	/**
+	 * Urls for timeshift if available
+	 */
+	timeshiftUrls?: string[];
 }
 interface ClientOverrides {
 	maxVideoBitRate?: number;
@@ -222,6 +226,10 @@ interface MoQConnectInfo {
 	telemetry?: Telemetry;
 	channels: ChannelWithCatalog[];
 	edges: Edge[];
+	timeshift: {
+		urls: string[];
+		duration: string;
+	};
 }
 interface VindralConnectInfo {
 	logsUrl?: string;
@@ -455,6 +463,14 @@ export interface Options {
 	 * This can be used to provide user options to limit the video bandwidth usage.
 	 */
 	maxVideoBitRate?: number;
+	/**
+	 * Initial maximum bit rate cap applied when first connecting to a channel.
+	 * This helps prevent buffering on initial connection by starting at a conservative bitrate.
+	 * The client will adapt to higher bitrates as bandwidth allows if ABR is enabled.
+	 *
+	 * Default is 2.5 Mbps (2500000 bits per second).
+	 */
+	maxInitialBitRate?: number;
 	/**
 	 * Controls video element background behaviour while loading.
 	 * - If `false`, a black background will be shown.
@@ -467,6 +483,14 @@ export interface Options {
 	 * Whether to start the player muted or to try to start playing audio automatically.
 	 */
 	muted?: boolean;
+	/**
+	 * Initial volume level for the player. A floating point value between 0-1.
+	 * Default is 1 (100% volume).
+	 *
+	 * Note: Volume cannot be set on iOS devices due to system restrictions.
+	 * The volume property is not settable in JavaScript on iOS, and reading it always returns 1.
+	 */
+	volume?: number;
 	/**
 	 * Provide a custom reconnect handler to control when the instance should stop trying to
 	 * reconnect. The reconnect handler should either return true to allow the reconnect or
@@ -800,6 +824,20 @@ interface IncomingDataModuleStatistics {
 	 */
 	bytesReceived: number;
 }
+interface JitterStatistics {
+	/** Minimum jitter in the recent window */
+	min: number;
+	/** Maximum jitter in the recent window for spike detection */
+	max: number;
+	/** Latest average jitter in ms (recent window) */
+	last: number;
+	/** Average jitter in ms (RFC 3550 style, smoothed with /16) */
+	average: number;
+}
+interface JitterModuleStatistics {
+	audioJitter: JitterStatistics | undefined;
+	videoJitter: JitterStatistics | undefined;
+}
 interface MseModuleStatistics {
 	quotaErrorCount: number;
 	mediaSourceOpenTime: number;
@@ -823,11 +861,11 @@ interface QualityOfServiceModuleStatistics {
 	 */
 	fatalQosCount: number;
 	/**
-	 * Ratio of time being spent on different bitrates.
-	 * Example: `"timeSpentRatio": { "1160000": 0.2, "2260000": 0.8 }` shows 20% spent on 1.16 Mbps, 80% spent on 2.26 Mbps.
+	 * Ratio of time being spent on different quality indexes. Index 0 is always the highest quality.
+	 * Example: `"timeSpentRatio": { "0": 0.8, "1": 0.2 }` shows 80% spent on the best level, 20% on the next one.
 	 */
 	timeSpentRatio: {
-		[bitRate: string]: number;
+		[qualityIndex: string]: number;
 	};
 }
 interface SyncModuleStatistics {
@@ -874,7 +912,7 @@ declare class UserAgentInformation {
 		userAgent: string;
 	};
 }
-type ModuleStatistics = AdaptivityStatistics & BufferTimeStatistics & ConnectionStatistics & ConstraintCapStatistics & DecoderStatistics & DocumentStateModulesStatistics & IncomingDataModuleStatistics & MseModuleStatistics & PlaybackModuleStatistics & QualityOfServiceModuleStatistics & RenditionsModuleStatistics & SyncModuleStatistics & TelemetryModuleStatistics & VideoPlayerStatistics;
+type ModuleStatistics = AdaptivityStatistics & BufferTimeStatistics & ConnectionStatistics & ConstraintCapStatistics & DecoderStatistics & DocumentStateModulesStatistics & IncomingDataModuleStatistics & JitterModuleStatistics & MseModuleStatistics & PlaybackModuleStatistics & QualityOfServiceModuleStatistics & RenditionsModuleStatistics & SyncModuleStatistics & TelemetryModuleStatistics & VideoPlayerStatistics;
 /**
  * Contains internal statistics.
  *
@@ -924,6 +962,10 @@ export type Statistics = ModuleStatistics & ReturnType<UserAgentInformation["get
 	 */
 	timeToFirstFrame?: number;
 	iosMediaElementEnabled?: boolean;
+	/**
+	 * Average bitrate for the entire session in bits/second.
+	 */
+	averageBitRate?: number;
 };
 /**
  * Represents a Vindral client instance
@@ -964,7 +1006,6 @@ export type Statistics = ModuleStatistics & ReturnType<UserAgentInformation["get
 export declare class Vindral extends Emitter<PublicVindralEvents> {
 	#private;
 	private static MAX_POOL_SIZE;
-	private static INITIAL_MAX_BIT_RATE;
 	private static DISCONNECT_TIMEOUT;
 	private static REMOVE_CUE_THRESHOLD;
 	/**
@@ -1440,6 +1481,10 @@ export interface VolumeState {
 	 */
 	volume: number;
 }
+interface TimeShiftInfo {
+	urls: string[];
+	duration: string;
+}
 /**
  * The events that can be emitted from the Vindral instance
  */
@@ -1539,6 +1584,10 @@ export interface PublicVindralEvents {
 	 * from external sources such as OS media shortcuts or other native UI outside of the browser.
 	 */
 	["volume state"]: Readonly<VolumeState>;
+	/**
+	 * Emitted when the timeshift URLs are updated.
+	 */
+	["timeshift info"]: Readonly<TimeShiftInfo>;
 	["buffer state event"]: Readonly<BufferStateEvent>;
 	["initialized media"]: void;
 }