@vindral/web-sdk 4.1.8 → 4.1.9-10-g6fb644c9

package/react.d.ts

@@ -22,17 +22,6 @@ interface Channel {
 	 */
 	timeshiftUrls?: string[];
 }
-interface ClientOverrides {
-	maxVideoBitRate?: number;
-	minBufferTime?: number;
-	maxBufferTime?: number;
-	burstEnabled?: boolean;
-	sizeBasedResolutionCapEnabled?: boolean;
-	separateVideoSocketEnabled?: boolean;
-	videoCodecs?: string[];
-}
-type AudioCodec = "aac" | "opus" | "mp3";
-type VideoCodec = "h264" | "av1";
 interface MinMaxAverage {
 	last: number;
 	/**
@@ -105,44 +94,16 @@ type Tagged<BaseType, Tag extends PropertyKey> = BaseType & {
 		[K in Tag]: void;
 	};
 };
-type Namespace = Tagged<Array<string>, "Namespace">;
-interface TrackObject {
-	namespace?: Namespace;
-	name: string;
-	format: string;
-	label?: string;
-	renderGroup?: number;
-	altGroup?: number;
-	initData?: string;
-	initTrack?: string;
-	depends?: Array<string>;
-	temporalId?: number;
-	spatialId?: number;
-	codec?: string;
-	mimeType?: string;
-	framerate?: [
-		number,
-		number
-	];
-	bitrate?: number;
-	width?: number;
-	height?: number;
-	samplerate?: number;
-	channelConfig?: string;
-	displayWidth?: number;
-	displayHeight?: number;
-	language?: string;
-	["com.vindral.variant_uid"]?: string;
-	["com.vindral.drm"]?: string;
-}
-interface CatalogRoot {
-	version: number;
-	streamingFormat?: number;
-	streamingFormatVersion?: string;
-}
-interface TracksCatalog extends CatalogRoot {
-	namespace: Namespace;
-	tracks: Array<TrackObject>;
+type AudioCodec = "aac" | "opus" | "mp3";
+type VideoCodec = "h264" | "av1";
+interface ReconnectState {
+	/**
+	 * The number or retry attempts so far.
+	 * This gets reset on every successful connect, so it will start from zero every
+	 * time the client instance gets disconnected and will increment until the
+	 * client instance makes a connection attempt is successful.
+	 */
+	reconnectRetries: number;
 }
 interface RenditionProps {
 	id: number;
@@ -185,78 +146,6 @@ type VideoRendition = VideoRenditionProps & RenditionProps;
 type AudioRendition = AudioRenditionProps & RenditionProps;
 type TextRendition = TextRenditionProps & RenditionProps;
 type Rendition = VideoRendition | AudioRendition | TextRendition;
-interface Telemetry {
-	url: string;
-	probability?: number;
-	includeErrors?: boolean;
-	includeEvents?: boolean;
-	includeStats?: boolean;
-	maxRetries?: number;
-	maxErrorReports?: number;
-	interval?: number;
-}
-interface ChannelWithCatalog extends Channel {
-	catalog: TracksCatalog;
-	renditions: Rendition[];
-	overrides?: ClientOverrides;
-}
-interface ChannelWithRenditions extends Channel {
-	renditions: Rendition[];
-	overrides?: ClientOverrides;
-}
-interface ServerCertificateHash {
-	algorithm: string;
-	value: string;
-}
-interface Edge {
-	moqUrl?: string;
-	moqWsUrl: string;
-	serverCertificateHashes?: ServerCertificateHash[];
-}
-interface MoQConnectInfo {
-	logsUrl?: string;
-	statsUrl?: string;
-	telemetry?: Telemetry;
-	channels: ChannelWithCatalog[];
-	edges: Edge[];
-	timeshift: {
-		urls: string[];
-		duration: string;
-	};
-}
-interface VindralConnectInfo {
-	logsUrl?: string;
-	statsUrl?: string;
-	telemetry?: Telemetry;
-	channels: ChannelWithRenditions[];
-	edges: string[];
-}
-type ConnectInfo = VindralConnectInfo | MoQConnectInfo;
-interface Metadata {
-	/**
-	 * The raw string content as it was ingested (if using JSON, it needs to be parsed on your end)
-	 */
-	content: string;
-	/**
-	 * Timestamp in ms
-	 */
-	timestamp: number;
-}
-interface TimeRange {
-	/** */
-	start: number;
-	/** */
-	end: number;
-}
-interface ReconnectState {
-	/**
-	 * The number or retry attempts so far.
-	 * This gets reset on every successful connect, so it will start from zero every
-	 * time the client instance gets disconnected and will increment until the
-	 * client instance makes a connection attempt is successful.
-	 */
-	reconnectRetries: number;
-}
 interface Size {
 	/** */
 	width: number;
@@ -308,6 +197,7 @@ interface DrmOptions {
 	};
 }
 type Media = "audio" | "video" | "audio+video";
+type WebCodecsHardwareAccelerationPreference = "no-preference" | "prefer-hardware" | "prefer-software";
 interface Options {
 	/**
 	 * URL to use when connecting to the stream
@@ -508,6 +398,38 @@ interface Options {
 	 * Enables iOS devices to use a media element for playback. This enables fullscreen and picture in picture support on iOS.
 	 */
 	iosMediaElementEnabled?: boolean;
+	/**
+	 * Enable WebCodecs API for hardware-accelerated decoding.
+	 *
+	 * When enabled, the browser's native VideoDecoder and AudioDecoder APIs will be used instead
+	 * of WASM decoding on supported browsers (Chrome 94+, Edge 94+, Safari 16.4+). This provides:
+	 * - Hardware-accelerated decoding (uses GPU for video)
+	 * - Better performance at higher resolutions
+	 * - Lower CPU usage and battery consumption
+	 *
+	 * Disabled by default to allow gradual rollout and testing.
+	 *
+	 * Note: Automatically falls back to WASM decoding if:
+	 * - The browser doesn't support WebCodecs
+	 * - WebCodecs initialization fails
+	 * - This option is set to false or undefined
+	 */
+	webcodecsEnabled?: boolean;
+	/**
+	 * Hardware acceleration preference for WebCodecs video decoding.
+	 *
+	 * Defaults to `"no-preference"`.
+	 */
+	webcodecsHardwareAcceleration?: WebCodecsHardwareAccelerationPreference;
+	/**
+	 * Enable OffscreenCanvas rendering in worker thread (requires webcodecsEnabled: true).
+	 *
+	 * When enabled, video rendering happens in the worker thread using OffscreenCanvas.
+	 * Disabled by default to allow gradual rollout and testing.
+	 *
+	 * Note: Requires browser support for OffscreenCanvas and webcodecsEnabled must be true, and iosMediaElementEnabled must be false.
+	 */
+	offscreenCanvasEnabled?: boolean;
 	/**
 	 * Advanced options to override default behaviour.
 	 */
@@ -519,6 +441,120 @@ interface Options {
 	 */
 	drm?: DrmOptions;
 }
+interface ClientOverrides {
+	maxVideoBitRate?: number;
+	minBufferTime?: number;
+	maxBufferTime?: number;
+	burstEnabled?: boolean;
+	sizeBasedResolutionCapEnabled?: boolean;
+	separateVideoSocketEnabled?: boolean;
+	webcodecsEnabled?: boolean;
+	webcodecsHardwareAcceleration?: WebCodecsHardwareAccelerationPreference;
+	offscreenCanvasEnabled?: boolean;
+	videoCodecs?: string[];
+}
+type Namespace = Tagged<Array<string>, "Namespace">;
+interface TrackObject {
+	namespace?: Namespace;
+	name: string;
+	format: string;
+	label?: string;
+	renderGroup?: number;
+	altGroup?: number;
+	initData?: string;
+	initTrack?: string;
+	depends?: Array<string>;
+	temporalId?: number;
+	spatialId?: number;
+	codec?: string;
+	mimeType?: string;
+	framerate?: [
+		number,
+		number
+	];
+	bitrate?: number;
+	width?: number;
+	height?: number;
+	samplerate?: number;
+	channelConfig?: string;
+	displayWidth?: number;
+	displayHeight?: number;
+	language?: string;
+	["com.vindral.variant_uid"]?: string;
+	["com.vindral.drm"]?: string;
+}
+interface CatalogRoot {
+	version: number;
+	streamingFormat?: number;
+	streamingFormatVersion?: string;
+}
+interface TracksCatalog extends CatalogRoot {
+	namespace: Namespace;
+	tracks: Array<TrackObject>;
+}
+interface Telemetry {
+	url: string;
+	probability?: number;
+	includeErrors?: boolean;
+	includeEvents?: boolean;
+	includeStats?: boolean;
+	maxRetries?: number;
+	maxErrorReports?: number;
+	interval?: number;
+}
+interface ChannelWithCatalog extends Channel {
+	catalog: TracksCatalog;
+	renditions: Rendition[];
+	overrides?: ClientOverrides;
+}
+interface ChannelWithRenditions extends Channel {
+	renditions: Rendition[];
+	overrides?: ClientOverrides;
+}
+interface ServerCertificateHash {
+	algorithm: string;
+	value: string;
+}
+interface Edge {
+	moqUrl?: string;
+	moqWsUrl: string;
+	serverCertificateHashes?: ServerCertificateHash[];
+}
+interface MoQConnectInfo {
+	logsUrl?: string;
+	statsUrl?: string;
+	telemetry?: Telemetry;
+	channels: ChannelWithCatalog[];
+	edges: Edge[];
+	timeshift: {
+		urls: string[];
+		duration: string;
+	};
+}
+interface VindralConnectInfo {
+	logsUrl?: string;
+	statsUrl?: string;
+	telemetry?: Telemetry;
+	channels: ChannelWithRenditions[];
+	edges: string[];
+}
+type ConnectInfo = VindralConnectInfo | MoQConnectInfo;
+interface Metadata {
+	/**
+	 * The raw string content as it was ingested (if using JSON, it needs to be parsed on your end)
+	 */
+	content: string;
+	/**
+	 * Timestamp in ms
+	 */
+	timestamp: number;
+}
+interface TimeRange {
+	/** */
+	start: number;
+	/** */
+	end: number;
+}
 interface RenditionLevel {
 	/** */
 	audio?: AudioRendition;
@@ -1760,6 +1796,9 @@ declare class Controller extends HTMLElement {
 		"drm-playready-video-robustness",
 		"drm-playready-audio-robustness",
 		"webtransport-enabled",
+		"webcodecs-enabled",
+		"webcodecs-hardware-acceleration",
+		"offscreen-canvas-enabled",
 		"reconnect-retries",
 		"auto-instance-enabled",
 		"language"
@@ -1859,7 +1898,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" | "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")[];
+	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" | "webcodecs-enabled" | "webcodecs-hardware-acceleration" | "offscreen-canvas-enabled" | "reconnect-retries" | "auto-instance-enabled" | "refresh-poster-enabled" | "stream-poll-enabled")[];
 	constructor();
 	connectedCallback(): void;
 	disconnectedCallback(): void;