@vindral/web-sdk 4.2.0 → 4.2.1-10-ga7cb21ca

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "4.2.0",
+  "version": "4.2.1-10-ga7cb21ca",
   "name": "@vindral/web-sdk",
   "main": "./legacy.umd.js",
   "module": "./legacy.es.js",

package/player.d.ts

@@ -129,7 +129,7 @@ declare class UserAgentInformation {
 	};
 }
 type AudioCodec = "aac" | "opus" | "mp3";
-type VideoCodec = "h264" | "av1";
+type VideoCodec = "h264" | "h265" | "av1";
 interface ReconnectState {
 	/**
 	 * The number or retry attempts so far.
@@ -462,8 +462,8 @@ interface TrackObject {
 	displayWidth?: number;
 	displayHeight?: number;
 	language?: string;
-	["com.vindral.variant_uid"]?: string;
-	["com.vindral.drm"]?: string;
+	"com.vindral.variant_uid"?: string;
+	"com.vindral.drm"?: string;
 }
 interface CatalogRoot {
 	version: number;
@@ -691,6 +691,7 @@ declare class ApiClient {
 	private toChannels;
 	private toChannel;
 }
+type TransportSelectionReason = "unsupported" | "disabled" | "unavailable" | "fallback";
 interface AdaptivityStatistics {
 	/**
 	 * True if adaptive bitrate (ABR) is enabled.
@@ -830,6 +831,7 @@ interface JitterModuleStatistics {
 interface MseModuleStatistics {
 	quotaErrorCount: number;
 	mediaSourceOpenTime: number;
+	playbackStallCount: number;
 	totalVideoFrames?: number;
 	droppedVideoFrames?: number;
 	successfulVideoAppendCalls?: number;
@@ -1161,6 +1163,14 @@ declare class Vindral extends Emitter<PublicVindralEvents> {
 	 * setting targetBufferTime within that range for consistancy if using both min/max.
 	 */
 	set targetBufferTime(bufferTimeMs: number);
+	/**
+	 * Update the dynamic buffer time configuration at runtime.
+	 * Allows adjusting min and max buffer time without recreating the Vindral instance.
+	 */
+	updateBufferTimeConfig(config: {
+		minBufferTime?: number;
+		maxBufferTime?: number;
+	}): void;
 	/**
 	 * The estimated playback latency based on target buffer time, the connection rtt and local playback drift
 	 */
@@ -1398,6 +1408,8 @@ declare class Vindral extends Emitter<PublicVindralEvents> {
 	private suspend;
 	private unsuspend;
 	private getRuntimeInfo;
+	private getPlaybackBufferState;
+	private onMediaElementBufferState;
 	private onMediaElementState;
 	private onBufferEvent;
 	/**
@@ -1454,6 +1466,14 @@ interface ConnectionStatistics {
 	 */
 	connectionSuccessRatio: number;
 	connectionProtocol: "vindral_ws" | "moq" | "moq_ws" | undefined;
+	/**
+	 * When connectionProtocol is "moq_ws", indicates why WebSocket was used instead of WebTransport.
+	 * - "unsupported": browser doesn't support WebTransport
+	 * - "disabled": webtransportEnabled option is false
+	 * - "unavailable": edge did not offer a WebTransport endpoint
+	 * - "fallback": WebTransport was attempted but failed or timed out
+	 */
+	transportSelectionReason: TransportSelectionReason | undefined;
 }
 interface LanguageSwitchContext {
 	/**
@@ -1496,7 +1516,7 @@ interface PublicVindralEvents {
 	 * In case of a fatal error it is appropriate to indicate what the error was to the user, either by displaying the error.message or
 	 * by using the error.code() as a key to look up a localization string. To resume streaming it is required to create a new Vindral instance.
 	 */
-	["error"]: Readonly<VindralError>;
+	error: Readonly<VindralError>;
 	/**
 	 * When the instance needs user input to activate audio or sometimes video playback.
 	 * Is called with an object
@@ -1507,51 +1527,51 @@ interface PublicVindralEvents {
 	 * }
 	 * ```
 	 */
-	["needs user input"]: NeedsUserInputContext;
+	"needs user input": NeedsUserInputContext;
 	/**
 	 * When a timed metadata event has been triggered
 	 */
-	["metadata"]: Readonly<Metadata>;
+	metadata: Readonly<Metadata>;
 	/**
 	 * When the playback state changes
 	 */
-	["playback state"]: Readonly<PlaybackState>;
+	"playback state": Readonly<PlaybackState>;
 	/**
 	 * When the connection state changes
 	 */
-	["connection state"]: Readonly<ConnectionState>;
+	"connection state": Readonly<ConnectionState>;
 	/**
 	 * When the available rendition levels is changed
 	 */
-	["rendition levels"]: ReadonlyArray<RenditionLevel>;
+	"rendition levels": ReadonlyArray<RenditionLevel>;
 	/**
 	 * When the rendition level is changed
 	 */
-	["rendition level"]: Readonly<RenditionLevel>;
+	"rendition level": Readonly<RenditionLevel>;
 	/**
 	 * When the available languages is changed
 	 */
-	["languages"]: ReadonlyArray<string>;
+	languages: ReadonlyArray<string>;
 	/**
 	 * When the available text tracks are changed
 	 */
-	["text tracks"]: ReadonlyArray<string>;
+	"text tracks": ReadonlyArray<string>;
 	/**
 	 * When the available channels is changed
 	 */
-	["channels"]: ReadonlyArray<Channel>;
+	channels: ReadonlyArray<Channel>;
 	/**
 	 * When a context switch state change has occured.
 	 * E.g. when a channel change has been requested, or quality is changed.
 	 */
-	["context switch"]: Readonly<ContextSwitchState>;
+	"context switch": Readonly<ContextSwitchState>;
 	/**
 	 * Emitted when a wallclock time message has been received from the server.
 	 *
 	 * Note: This is the edge server wallclock time and thus may differ slightly
 	 * between two viewers if they are connected to different edge servers.
 	 */
-	["server wallclock time"]: Readonly<number>;
+	"server wallclock time": Readonly<number>;
 	/**
 	 * Is emitted during connection whether the channel is live or not.
 	 *
@@ -1561,41 +1581,41 @@ interface PublicVindralEvents {
 	 * Note: If the web-sdk is instantiated at the same time as you are starting the stream it is possible
 	 * that this emits false until the started state has propagated through the system.
 	 */
-	["is live"]: boolean;
+	"is live": boolean;
 	/**
 	 * Emitted when a channel switch has been completed and the first frame of the new channel is rendered.
 	 * A string containing the channel id of the new channel is provided as an argument.
 	 */
-	["channel switch"]: Readonly<ChannelSwitchContext>;
+	"channel switch": Readonly<ChannelSwitchContext>;
 	/**
 	 * Emmitted when a channel switch fails.
 	 * A string containing the channel id of the current channel is provided as an argument.
 	 */
-	["channel switch failed"]: Readonly<ChannelSwitchContext>;
+	"channel switch failed": Readonly<ChannelSwitchContext>;
 	/**
 	 * Emitted when a language switch has been completed and the new language starts playing.
 	 */
-	["language switch"]: Readonly<LanguageSwitchContext>;
+	"language switch": Readonly<LanguageSwitchContext>;
 	/**
 	 * Emitted when the volume state changes.
 	 *
 	 * This is triggered triggered both when the user changes the volume through the Vindral instance, but also
 	 * from external sources such as OS media shortcuts or other native UI outside of the browser.
 	 */
-	["volume state"]: Readonly<VolumeState>;
+	"volume state": Readonly<VolumeState>;
 	/**
 	 * Emitted when the timeshift URLs are updated.
 	 */
-	["timeshift info"]: Readonly<TimeShiftInfo>;
+	"timeshift info": Readonly<TimeShiftInfo>;
 	/**
 	 * Emitted for each CMAF fragment received via the MoQ/VoQ path.
 	 * Contains raw fMP4 bytes suitable for recording.
 	 *
 	 * @internal Not part of the public API — may change without notice.
 	 */
-	["cmaf fragment"]: Readonly<CmafFragmentEvent>;
-	["buffer state event"]: Readonly<BufferStateEvent>;
-	["initialized media"]: void;
+	"cmaf fragment": Readonly<CmafFragmentEvent>;
+	"buffer state event": Readonly<BufferStateEvent>;
+	"initialized media": void;
 }
 declare abstract class VindralButton extends HTMLElement {
 	#private;
@@ -1609,17 +1629,6 @@ declare abstract class VindralButton extends HTMLElement {
 	attributeChangedCallback(name: string, _old: string, value: string): void;
 	protected abstract handleClick(e: Event): void;
 }
-export declare class AirPlayButton extends VindralButton {
-	#private;
-	static observedAttributes: string[];
-	constructor();
-	connectedCallback(): void;
-	disconnectedCallback(): void;
-	attributeChangedCallback(name: string, old: string, value: string): void;
-	set isAirPlaying(value: boolean);
-	get isAirPlaying(): boolean;
-	protected handleClick(_: Event): void;
-}
 declare class VindralMenuButton extends VindralButton {
 	#private;
 	constructor();
@@ -1651,6 +1660,17 @@ declare class AdvancedRenditionMenuList extends HTMLElement {
 	handleEvent: (event: Event) => void;
 	focus(): void;
 }
+export declare class AirPlayButton extends VindralButton {
+	#private;
+	static observedAttributes: string[];
+	constructor();
+	connectedCallback(): void;
+	disconnectedCallback(): void;
+	attributeChangedCallback(name: string, old: string, value: string): void;
+	set isAirPlaying(value: boolean);
+	get isAirPlaying(): boolean;
+	protected handleClick(_: Event): void;
+}
 declare class BufferingIcon extends HTMLElement {
 	#private;
 	static observedAttributes: "buffering"[];
@@ -1742,15 +1762,15 @@ interface AirPlaySenderEvents {
 	/**
 	 * When airplay targets are available.
 	 */
-	["available"]: void;
+	available: void;
 	/**
 	 * When a connection has been established with an airplay target.
 	 */
-	["connected"]: void;
+	connected: void;
 	/**
 	 * When the airplay target has lost or stopped a connection.
 	 */
-	["disconnected"]: void;
+	disconnected: void;
 }
 interface AirPlayConfig {
 	/**
@@ -1809,7 +1829,7 @@ declare class AirPlaySender extends Emitter<AirPlaySenderEvents> {
 	private checkHlsUrl;
 }
 interface FullscreenEvents {
-	["on fullscreen change"]: boolean;
+	"on fullscreen change": boolean;
 }
 declare class Fullscreen extends Emitter<FullscreenEvents> {
 	private container;
@@ -1830,7 +1850,7 @@ type ControllerAttributes = (typeof Controller.observedAttributes)[number];
 export 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" | "abr-enabled" | "size-based-resolution-cap-enabled" | "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")[],
+		...("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" | "abr-enabled" | "size-based-resolution-cap-enabled" | "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" | "debug-panel-open" | "target-buffer-time" | "drift" | "playback-latency" | "connection-state")[],
 		"url",
 		"edge-url",
 		"target-buffer-time",
@@ -1952,7 +1972,7 @@ export declare class PlayButton extends VindralButton {
  */
 export declare class Player extends HTMLElement {
 	#private;
-	static observedAttributes: readonly ("title" | "offline" | "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" | "abr-enabled" | "size-based-resolution-cap-enabled" | "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" | "decoders" | "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" | "stream-to-media-element-enabled" | "ios-media-element-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" | "webcodecs-hardware-acceleration" | "offscreen-canvas-enabled" | "reconnect-retries" | "auto-instance-enabled" | "advanced-rendition-menu-enabled" | "refresh-poster-enabled" | "stream-poll-enabled")[];
+	static observedAttributes: readonly ("title" | "offline" | "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" | "abr-enabled" | "size-based-resolution-cap-enabled" | "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" | "debug-panel-open" | "target-buffer-time" | "drift" | "playback-latency" | "connection-state" | "url" | "decoders" | "min-buffer-time" | "max-buffer-time" | "edge-url" | "cast-receiver-id" | "cast-background" | "log-level" | "max-size" | "max-audio-bit-rate" | "burst-enabled" | "mse-enabled" | "mse-opus-enabled" | "ios-background-play-enabled" | "ios-wake-lock-enabled" | "stream-to-media-element-enabled" | "ios-media-element-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" | "webcodecs-hardware-acceleration" | "offscreen-canvas-enabled" | "reconnect-retries" | "auto-instance-enabled" | "advanced-rendition-menu-enabled" | "refresh-poster-enabled" | "stream-poll-enabled")[];
 	constructor();
 	connectedCallback(): void;
 	disconnectedCallback(): void;
@@ -2069,6 +2089,14 @@ export declare class VolumeRange extends VindralRange {
  * Register custom elements for the Vindral player
  */
 export declare function registerComponents(): void;
+/**
+ * Register debug custom elements for the Vindral player.
+ *
+ * Call this in addition to `registerComponents()` to enable the debug button and panel.
+ * Without calling this, `<vindral-debug-button>` and `<vindral-debug-panel>` remain
+ * inert and the debug code is tree-shaken from the bundle.
+ */
+export declare function registerDebugComponents(): void;
 /**
  * @ignore
  */