@vindral/web-sdk 4.1.6 → 4.1.7-1-g0bc6e715

package/react.d.ts

@@ -790,12 +790,60 @@ interface QualityOfServiceModuleStatistics {
 	timeSpentRatio: {
 		[qualityIndex: string]: number;
 	};
+	/**
+	 * Ratio of time spent buffering to total active time (0-1).
+	 * Provides a normalized buffering quality metric regardless of session length.
+	 * A value of 0.05 means 5% of the active session was spent buffering.
+	 */
+	bufferingRatio: number;
+	/**
+	 * Number of buffering events per minute of active playback.
+	 * Normalizes buffering event count for comparison across sessions of different durations.
+	 */
+	bufferingEventsPerMinute: number;
+	/**
+	 * Weighted average rendition index based on time spent at each level.
+	 * Lower values indicate higher quality (index 0 is the highest quality).
+	 * Example: 0.3 means mostly on the best quality with some time on lower qualities.
+	 */
+	averageRenditionIndex: number;
+	/**
+	 * Buffering ratio for the last minute of playback (0-1).
+	 * Useful for detecting recent degradation vs overall session quality.
+	 */
+	bufferingRatioPerMinute: number;
+	/**
+	 * Number of rendition level changes (upgrades + downgrades) per minute.
+	 * Measures ABR stability - lower values indicate a more stable experience.
+	 */
+	renditionChangesPerMinute: number;
+	/**
+	 * Average time in milliseconds spent buffering per buffering event.
+	 * Helps distinguish many short buffering events from fewer long ones.
+	 */
+	timePerBufferingEvent: number;
 }
 interface SyncModuleStatistics {
 	drift: number | undefined;
-	driftAdjustmentCount: number;
-	timeshiftDriftAdjustmentCount: number;
+	seekAdjustmentCount: number;
+	timeshiftAdjustmentCount: number;
 	seekTime: number;
+	/**
+	 * Total time spent seeking in milliseconds for the entire session.
+	 * High values indicate frequent or slow seeks, which may impact user experience.
+	 */
+	totalSeekTime: number;
+	seekToleranceMultiplier: number;
+	currentSeekToleranceMs: number;
+	currentAheadToleranceMs: number;
+	isPlaybackRateAdjustmentEnabled: boolean;
+	playbackRate: number;
+	playbackRateAdjustmentCount: number;
+	/**
+	 * Average absolute drift in milliseconds over a rolling window.
+	 * Measures how far off sync the playback typically is, regardless of direction.
+	 */
+	averageDrift: number;
 }
 interface VideoPlayerStatistics {
 	renderedFrameCount: number;
@@ -881,6 +929,22 @@ type Statistics = ModuleStatistics & ReturnType<UserAgentInformation["getUserAge
 	 * Average bitrate for the entire session in bits/second.
 	 */
 	averageBitRate?: number;
+	/**
+	 * Number of reconnections per hour of uptime.
+	 * Measures connection stability over time. Lower is better.
+	 * Excludes the initial connection, so a stable session will have a value of 0.
+	 */
+	reconnectsPerHour: number;
+	/**
+	 * Number of seek adjustments (seeks to catch up) per minute of active playback.
+	 * High values indicate sync issues or network instability.
+	 */
+	seekAdjustmentsPerMinute: number;
+	/**
+	 * Number of timeshift adjustments per minute of active playback.
+	 * Relevant for timeshift-enabled streams.
+	 */
+	timeshiftAdjustmentsPerMinute: number;
 };
 declare class Vindral extends Emitter<PublicVindralEvents> {
 	#private;
@@ -1320,6 +1384,11 @@ interface ConnectionStatistics {
 	 * Total number of connection attempts since instantiation.
 	 */
 	connectionAttemptCount: number;
+	/**
+	 * Ratio of successful connections to total connection attempts (0-1).
+	 * A value of 1.0 means every connection attempt succeeded.
+	 */
+	connectionSuccessRatio: number;
 	connectionProtocol: "vindral_ws" | "moq" | undefined;
 }
 interface LanguageSwitchContext {
@@ -1660,7 +1729,7 @@ type ControllerAttributes = (typeof Controller.observedAttributes)[number];
 declare class Controller extends HTMLElement {
 	#private;
 	static observedAttributes: readonly [
-		...("language" | "channels" | "buffering" | "paused" | "volume" | "muted" | "duration" | "user-interacting" | "is-casting" | "cast-available" | "cast-receiver-name" | "ui-locked" | "hide-ui-on-pause" | "is-fullscreen" | "is-fullscreen-fallback" | "rendition-levels" | "rendition-level" | "max-video-bit-rate" | "max-initial-bit-rate" | "channel-id" | "channel-group-id" | "pip-available" | "is-pip" | "airplay-available" | "is-airplaying" | "media" | "languages" | "text-tracks" | "text-track" | "needs-user-input-video" | "needs-user-input-audio" | "authentication-token" | "volume-level" | "cast" | "airplay" | "pip" | "fullscreen" | "vu-meter" | "poster-src" | "timeshift")[],
+		...("language" | "channels" | "buffering" | "paused" | "volume" | "muted" | "duration" | "user-interacting" | "is-casting" | "cast-available" | "cast-receiver-name" | "ui-locked" | "hide-ui-on-pause" | "is-fullscreen" | "is-fullscreen-fallback" | "rendition-levels" | "rendition-level" | "max-video-bit-rate" | "max-initial-bit-rate" | "channel-id" | "channel-group-id" | "pip-available" | "is-pip" | "airplay-available" | "is-airplaying" | "media" | "languages" | "text-tracks" | "text-track" | "needs-user-input-video" | "needs-user-input-audio" | "authentication-token" | "volume-level" | "cast" | "airplay" | "pip" | "fullscreen" | "vu-meter" | "timeshift" | "timeshift-position" | "poster-src")[],
 		"url",
 		"edge-url",
 		"target-buffer-time",
@@ -1790,7 +1859,7 @@ declare class PlayButton extends VindralButton {
 type PlayerAttributes = (typeof Player.observedAttributes)[number];
 declare class Player extends HTMLElement {
 	#private;
-	static observedAttributes: readonly ("title" | "advanced" | "poster" | "language" | "channels" | "buffering" | "paused" | "volume" | "muted" | "duration" | "user-interacting" | "is-casting" | "cast-available" | "cast-receiver-name" | "ui-locked" | "hide-ui-on-pause" | "is-fullscreen" | "is-fullscreen-fallback" | "rendition-levels" | "rendition-level" | "max-video-bit-rate" | "max-initial-bit-rate" | "channel-id" | "channel-group-id" | "pip-available" | "is-pip" | "airplay-available" | "is-airplaying" | "media" | "languages" | "text-tracks" | "text-track" | "needs-user-input-video" | "needs-user-input-audio" | "authentication-token" | "volume-level" | "cast" | "airplay" | "pip" | "fullscreen" | "vu-meter" | "poster-src" | "timeshift" | "url" | "offline" | "edge-url" | "target-buffer-time" | "cast-receiver-id" | "cast-background" | "log-level" | "max-size" | "min-buffer-time" | "max-buffer-time" | "max-audio-bit-rate" | "burst-enabled" | "mse-enabled" | "mse-opus-enabled" | "ios-background-play-enabled" | "ios-wake-lock-enabled" | "ios-media-element-enabled" | "abr-enabled" | "size-based-resolution-cap-enabled" | "telemetry-enabled" | "video-codecs" | "drm-headers" | "drm-queryparams" | "drm-widevine-video-robustness" | "drm-widevine-audio-robustness" | "drm-playready-video-robustness" | "drm-playready-audio-robustness" | "webtransport-enabled" | "reconnect-retries" | "auto-instance-enabled" | "refresh-poster-enabled" | "stream-poll-enabled")[];
+	static observedAttributes: readonly ("title" | "advanced" | "poster" | "language" | "channels" | "buffering" | "paused" | "volume" | "muted" | "duration" | "user-interacting" | "is-casting" | "cast-available" | "cast-receiver-name" | "ui-locked" | "hide-ui-on-pause" | "is-fullscreen" | "is-fullscreen-fallback" | "rendition-levels" | "rendition-level" | "max-video-bit-rate" | "max-initial-bit-rate" | "channel-id" | "channel-group-id" | "pip-available" | "is-pip" | "airplay-available" | "is-airplaying" | "media" | "languages" | "text-tracks" | "text-track" | "needs-user-input-video" | "needs-user-input-audio" | "authentication-token" | "volume-level" | "cast" | "airplay" | "pip" | "fullscreen" | "vu-meter" | "timeshift" | "timeshift-position" | "poster-src" | "url" | "offline" | "edge-url" | "target-buffer-time" | "cast-receiver-id" | "cast-background" | "log-level" | "max-size" | "min-buffer-time" | "max-buffer-time" | "max-audio-bit-rate" | "burst-enabled" | "mse-enabled" | "mse-opus-enabled" | "ios-background-play-enabled" | "ios-wake-lock-enabled" | "ios-media-element-enabled" | "abr-enabled" | "size-based-resolution-cap-enabled" | "telemetry-enabled" | "video-codecs" | "drm-headers" | "drm-queryparams" | "drm-widevine-video-robustness" | "drm-widevine-audio-robustness" | "drm-playready-video-robustness" | "drm-playready-audio-robustness" | "webtransport-enabled" | "reconnect-retries" | "auto-instance-enabled" | "refresh-poster-enabled" | "stream-poll-enabled")[];
 	constructor();
 	connectedCallback(): void;
 	disconnectedCallback(): void;