@vindral/web-sdk 3.4.4 → 4.0.0

package/core.js

@@ -0,0 +1,14 @@
+import { A as C, b as I, C as _, c as O, e as D, D as T, I as a, a as A, N as s, V as r, f as F } from "./DwDXQwR0.js";
+export {
+  C as AUTHENTICATION_EXPIRED_CODE,
+  I as AUTHENTICATION_FAILED_CODE,
+  _ as CHANNEL_NOT_FOUND_CODE,
+  O as CONNECTION_FAILED_AFTER_RETRIES_CODE,
+  D as CONNECTION_FAILED_CODE,
+  T as DISCONNECTED_BY_EDGE,
+  a as INACTIVITY_CODE,
+  A as Level,
+  s as NO_INCOMING_DATA,
+  r as Vindral,
+  F as VindralError
+};

package/{index.d.ts → legacy.d.ts}

@@ -1,18 +1,3 @@
-type AudioCodec = "aac" | "opus" | "mp3";
-type VideoCodec = "h264" | "av1";
-/**
- * Represents a timed metadata event
- */
-export 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;
-}
 type MatchingKeys<TRecord, TMatch, K extends keyof TRecord = keyof TRecord> = K extends (TRecord[K] extends TMatch ? K : never) ? K : never;
 type VoidKeys<Record> = MatchingKeys<Record, void>;
 type EventListenerReturnType = (() => void) | void;
@@ -73,6 +58,21 @@ interface MinMaxAverage {
 	 */
 	min: number;
 }
+type AudioCodec = "aac" | "opus" | "mp3";
+type VideoCodec = "h264" | "av1";
+/**
+ * Represents a timed metadata event
+ */
+export 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;
+}
 export interface TimeRange {
 	start: number;
 	end: number;
@@ -469,125 +469,6 @@ export declare class ApiClient {
 	private toChannels;
 	private toChannel;
 }
-/**
- * Available events to listen to
- */
-export interface CastSenderEvents {
-	/**
-	 * When a connection has been established with a CastReceiver
-	 */
-	["connected"]: void;
-	/**
-	 * When a previous session has been resumed
-	 */
-	["resumed"]: void;
-	/**
-	 * When a CastReceiver has lost or stopped a connection
-	 */
-	["disconnected"]: void;
-	/**
-	 * When a connection attempt was initiated unsuccessfully
-	 */
-	["failed"]: void;
-	/**
-	 * When the remote connection emits a metadata event
-	 */
-	["metadata"]: Metadata;
-	/**
-	 * When the remote connection receives a server wallclock time event
-	 */
-	["server wallclock time"]: number;
-}
-/**
- * Used for initializing the CastSender
- */
-export interface CastConfig {
-	/**
-	 * The [Vindral Options](./Options) to use for the Cast Receiver
-	 */
-	options: Options;
-	/**
-	 * URL to a background image.
-	 * Example: "https://via.placeholder.com/256x144"
-	 */
-	background?: string;
-	/**
-	 * Override this if you have your own custom receiver
-	 */
-	receiverApplicationId?: string;
-}
-/**
- * CastSender handles initiation of and communication with the Google Cast Receiver
- */
-export declare class CastSender extends Emitter<CastSenderEvents> {
-	private state;
-	private config;
-	private unloaded;
-	constructor(config: CastConfig);
-	/**
-	 * True if the instance is casting right now
-	 */
-	get casting(): boolean;
-	/**
-	 * The current volume
-	 */
-	get volume(): number;
-	/**
-	 * Set the current volume. Setting this to zero is equivalent to muting the video
-	 */
-	set volume(volume: number);
-	/**
-	 * The current language
-	 */
-	get language(): string | undefined;
-	/**
-	 * Set the current language
-	 */
-	set language(language: string | undefined);
-	/**
-	 * The current channelId
-	 */
-	get channelId(): string;
-	/**
-	 * Set the current channelId
-	 */
-	set channelId(channelId: string);
-	/**
-	 * Update authentication token on an already established and authenticated connection
-	 */
-	updateAuthenticationToken: (token: string) => void;
-	/**
-	 * Fully unloads the instance. This disconnects the current listener but lets the
-	 * cast session continue on the receiving device
-	 */
-	unload: () => void;
-	/**
-	 * Initiates the CastSender.
-	 * Will reject if Cast is not available on the device or the network.
-	 */
-	init: () => Promise<void>;
-	/**
-	 * Requests a session. It will open the native cast receiver chooser dialog
-	 */
-	start: () => Promise<void>;
-	/**
-	 * Stops a session. It will stop playback on device as well.
-	 */
-	stop: () => void;
-	/**
-	 * Returns a string representing the name of the Cast receiver device or undefined if no receiver exists
-	 */
-	getReceiverName: () => string | undefined;
-	private onGCastApiAvailable;
-	private send;
-	private onMessage;
-	private onSessionStarted;
-	private onSessionStateChanged;
-	private getInstance;
-	private getSession;
-	private castLibrariesAdded;
-	private verifyCastLibraries;
-}
 interface VindralErrorProps {
 	isFatal: boolean;
 	type?: ErrorType;
@@ -631,73 +512,6 @@ export declare class VindralError extends Error {
 	 */
 	toStringifiable: () => Record<string, unknown>;
 }
-interface AirPlaySenderEvents {
-	/**
-	 * When airplay targets are available.
-	 */
-	["available"]: void;
-	/**
-	 * When a connection has been established with an airplay target.
-	 */
-	["connected"]: void;
-	/**
-	 * When the airplay target has lost or stopped a connection.
-	 */
-	["disconnected"]: void;
-}
-interface AirPlayConfig {
-	/**
-	 * URL to use when connecting to the stream.
-	 */
-	url: string;
-	/**
-	 * Channel ID to connect to.
-	 */
-	channelId: string;
-	/**
-	 * A container to attach the video element in. This should be the same container that the vindral video element is attached to.
-	 */
-	container: HTMLElement;
-	/**
-	 * An authentication token to provide to the server when connecting - only needed for channels with authentication enabled
-	 * Note: If not supplied when needed, an "Authentication Failed" error will be raised.
-	 */
-	authenticationToken?: string;
-}
-declare class AirPlaySender extends Emitter<AirPlaySenderEvents> {
-	private config;
-	private hlsUrl;
-	private element;
-	private connectingTimeout?;
-	constructor(config: AirPlayConfig);
-	/**
-	 * True if the instance is casting right now.
-	 */
-	get casting(): boolean;
-	/**
-	 * Set the current channelId.
-	 */
-	set channelId(channelId: string);
-	/**
-	 * Update authentication token on an already established and authenticated connection.
-	 */
-	updateAuthenticationToken: (_token: string) => void;
-	/**
-	 * Fully unloads the instance. This disconnects the current listeners.
-	 */
-	unload: () => void;
-	/**
-	 * Show the AirPlay picker.
-	 */
-	showPlaybackTargetPicker(): void;
-	/**
-	 * Returns if AirPlay is supported.
-	 */
-	static isAirPlaySupported(): boolean;
-	private onAirPlayAvailable;
-	private onAirPlayPlaybackChanged;
-	private checkHlsUrl;
-}
 type PlaybackState = "buffering" | "playing" | "paused";
 type BufferStateEvent = "filled" | "drained";
 interface PlaybackModuleStatistics {
@@ -874,7 +688,7 @@ declare const defaultOptions: {
 	muted: boolean;
 	minBufferTime: number;
 	maxBufferTime: number;
-	logLevel: "off" | "error" | "warn" | "info" | "debug" | "trace";
+	logLevel: Level;
 	maxSize: Size;
 	maxVideoBitRate: number;
 	maxAudioBitRate: number;
@@ -979,8 +793,6 @@ interface DecoderStatistics {
 	audioDecodeTime: MinMaxAverage;
 	videoTransportTime: MinMaxAverage;
 }
-type ConnectionType = "bluetooth" | "cellular" | "ethernet" | "mixed" | "none" | "other" | "unknown" | "wifi" | "wimax";
-type EffectiveConnectionType = "2g" | "3g" | "4g" | "slow-2g";
 interface DocumentStateModulesStatistics {
 	isVisible: boolean;
 	isOnline: boolean;
@@ -1563,6 +1375,192 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
 	private timeToFirstFrame;
 	private willUseMediaSource;
 }
+/**
+ * Available events to listen to
+ */
+export interface CastSenderEvents {
+	/**
+	 * When a connection has been established with a CastReceiver
+	 */
+	["connected"]: void;
+	/**
+	 * When a previous session has been resumed
+	 */
+	["resumed"]: void;
+	/**
+	 * When a CastReceiver has lost or stopped a connection
+	 */
+	["disconnected"]: void;
+	/**
+	 * When a connection attempt was initiated unsuccessfully
+	 */
+	["failed"]: void;
+	/**
+	 * When the remote connection emits a metadata event
+	 */
+	["metadata"]: Metadata;
+	/**
+	 * When the remote connection receives a server wallclock time event
+	 */
+	["server wallclock time"]: number;
+}
+/**
+ * Used for initializing the CastSender
+ */
+export interface CastConfig {
+	/**
+	 * The [Vindral Options](./Options) to use for the Cast Receiver
+	 */
+	options: Options;
+	/**
+	 * URL to a background image.
+	 * Example: "https://via.placeholder.com/256x144"
+	 */
+	background?: string;
+	/**
+	 * Override this if you have your own custom receiver
+	 */
+	receiverApplicationId?: string;
+}
+/**
+ * CastSender handles initiation of and communication with the Google Cast Receiver
+ */
+export declare class CastSender extends Emitter<CastSenderEvents> {
+	private state;
+	private config;
+	private unloaded;
+	constructor(config: CastConfig);
+	/**
+	 * True if the instance is casting right now
+	 */
+	get casting(): boolean;
+	/**
+	 * The current volume
+	 */
+	get volume(): number;
+	/**
+	 * Set the current volume. Setting this to zero is equivalent to muting the video
+	 */
+	set volume(volume: number);
+	/**
+	 * The current language
+	 */
+	get language(): string | undefined;
+	/**
+	 * Set the current language
+	 */
+	set language(language: string | undefined);
+	/**
+	 * The current channelId
+	 */
+	get channelId(): string;
+	/**
+	 * Set the current channelId
+	 */
+	set channelId(channelId: string);
+	/**
+	 * Update authentication token on an already established and authenticated connection
+	 */
+	updateAuthenticationToken: (token: string) => void;
+	/**
+	 * Fully unloads the instance. This disconnects the current listener but lets the
+	 * cast session continue on the receiving device
+	 */
+	unload: () => void;
+	/**
+	 * Initiates the CastSender.
+	 * Will reject if Cast is not available on the device or the network.
+	 */
+	init: () => Promise<void>;
+	/**
+	 * Requests a session. It will open the native cast receiver chooser dialog
+	 */
+	start: () => Promise<void>;
+	/**
+	 * Stops a session. It will stop playback on device as well.
+	 */
+	stop: () => void;
+	/**
+	 * Returns a string representing the name of the Cast receiver device or undefined if no receiver exists
+	 */
+	getReceiverName: () => string | undefined;
+	private onGCastApiAvailable;
+	private send;
+	private onMessage;
+	private onSessionStarted;
+	private onSessionStateChanged;
+	private getInstance;
+	private getSession;
+	private castLibrariesAdded;
+	private verifyCastLibraries;
+}
+interface AirPlaySenderEvents {
+	/**
+	 * When airplay targets are available.
+	 */
+	["available"]: void;
+	/**
+	 * When a connection has been established with an airplay target.
+	 */
+	["connected"]: void;
+	/**
+	 * When the airplay target has lost or stopped a connection.
+	 */
+	["disconnected"]: void;
+}
+interface AirPlayConfig {
+	/**
+	 * URL to use when connecting to the stream.
+	 */
+	url: string;
+	/**
+	 * Channel ID to connect to.
+	 */
+	channelId: string;
+	/**
+	 * A container to attach the video element in. This should be the same container that the vindral video element is attached to.
+	 */
+	container: HTMLElement;
+	/**
+	 * An authentication token to provide to the server when connecting - only needed for channels with authentication enabled
+	 * Note: If not supplied when needed, an "Authentication Failed" error will be raised.
+	 */
+	authenticationToken?: string;
+}
+declare class AirPlaySender extends Emitter<AirPlaySenderEvents> {
+	private config;
+	private hlsUrl;
+	private element;
+	private connectingTimeout?;
+	constructor(config: AirPlayConfig);
+	/**
+	 * True if the instance is casting right now.
+	 */
+	get casting(): boolean;
+	/**
+	 * Set the current channelId.
+	 */
+	set channelId(channelId: string);
+	/**
+	 * Update authentication token on an already established and authenticated connection.
+	 */
+	updateAuthenticationToken: (_token: string) => void;
+	/**
+	 * Fully unloads the instance. This disconnects the current listeners.
+	 */
+	unload: () => void;
+	/**
+	 * Show the AirPlay picker.
+	 */
+	showPlaybackTargetPicker(): void;
+	/**
+	 * Returns if AirPlay is supported.
+	 */
+	static isAirPlaySupported(): boolean;
+	private onAirPlayAvailable;
+	private onAirPlayPlaybackChanged;
+	private checkHlsUrl;
+}
 /**
  * Available options when initializing the Player. Used for enabling/disabling features
  * and hiding/showing buttons in the control pane