@vindral/web-sdk 3.2.5 → 3.3.1

package/index.d.ts

@@ -1,5 +1,31 @@
 type AudioCodec = "aac" | "opus" | "mp3";
 type VideoCodec = "h264" | "av1";
+/**
+ * Log level
+ * @enum
+ */
+export declare const Level: {
+	readonly CRITICAL: "critical";
+	readonly ERROR: "error";
+	readonly WARN: "warn";
+	readonly INFO: "info";
+	readonly DEBUG: "debug";
+	readonly TRACE: "trace";
+};
+export type Level = (typeof Level)[keyof typeof Level];
+/**
+ * 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;
@@ -42,6 +68,22 @@ interface MinMaxAverage {
 	 */
 	min: number;
 }
+export interface TimeRange {
+	start: number;
+	end: number;
+}
+/**
+ * The current reconnect state to use to decide whether to kep reconnecting or not
+ */
+export 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;
 	bitRate: number;
@@ -77,6 +119,227 @@ interface VideoConstraint {
 	codec?: VideoCodec;
 	codecString?: string;
 }
+/**
+ * Advanced options to override default behaviour.
+ */
+export interface AdvancedOptions {
+	/**
+	 * Constrains wasm decoding to this resolution.
+	 * By default it is set to 1280 in width and height.
+	 * This guarantees better performance on older devices and reduces battery drain in general.
+	 */
+	wasmDecodingConstraint: Partial<VideoConstraint>;
+}
+type Media = "audio" | "video" | "audio+video";
+/**
+ * Options for the Vindral instance
+ *
+ */
+export interface Options {
+	/**
+	 * URL to use when connecting to the stream
+	 */
+	url: string;
+	/**
+	 * Channel ID to connect to initially - can be changed later mid-stream when connected to a channel group.
+	 */
+	channelId: string;
+	/**
+	 * Channel group to connect to
+	 * Note: Only needed for fast channel switching
+	 */
+	channelGroupId?: string;
+	/**
+	 * A container to attach the video view in - can be provided later with .attach() on the vindral core instance
+	 */
+	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;
+	/**
+	 * Language to use initially - can be changed during during runtime on the vindral instance
+	 * Note: Only needed when multiple languages are provided - if no language is specified, one will be automatically selected.
+	 */
+	language?: string;
+	/**
+	 * Sets the log level - defaults to info
+	 */
+	logLevel?: Level;
+	/**
+	 * Sets the minimum and initial buffer time
+	 */
+	minBufferTime?: number;
+	/**
+	 * Sets the maximum buffer time allowed. The vindral instance will automatically slowly increase
+	 * the buffer time if the use experiences to much buffering with the initial buffer time.
+	 *
+	 * Note: This is not yet implemented
+	 */
+	maxBufferTime?: number;
+	/**
+	 * Enables or disables user bandwidth savings by capping the video resolution to the size of the video element.
+	 *
+	 * Is enabled by default.
+	 *
+	 * Note: This is automatically set to false when abrEnabled is set to false.
+	 */
+	sizeBasedResolutionCapEnabled?: boolean;
+	/**
+	 * Enables or disables picture in picture support.
+	 */
+	pictureInPictureEnabled?: boolean;
+	/**
+	 * Enable bursting for initial connection and channel switches. This makes time to first frame faster at the
+	 * cost of stability (more demanding due to the sudden burst of live content)
+	 *
+	 * Is disabled by default.
+	 *
+	 */
+	burstEnabled?: boolean;
+	/**
+	 * Enable usage of the MediaSource API on supported browsers.
+	 *
+	 * Is enabled by default.
+	 *
+	 * Note: We recommend to keep this at the default value unless you have very specific needs.
+	 */
+	mseEnabled?: boolean;
+	/**
+	 * Enable Opus with the MediaSource API on supported browsers.
+	 *
+	 * Is enabled by default.
+	 *
+	 * Note: Opus generally provides better audio quality and is therefore recommended to keep enabled.
+	 */
+	mseOpusEnabled?: boolean;
+	/**
+	 * Enable or disable support for playing audio in the background for iOS devices.
+	 *
+	 * Is false (disabled) by default.
+	 *
+	 * Note:  This may be enabled by default in a future (major) release
+	 */
+	iosBackgroundPlayEnabled?: boolean;
+	/**
+	 * Enable or disable Adaptive Bit Rate. This allows for automatically adapting the incoming bit rate based on
+	 * the viewers bandwidth and thus avoiding buffering events. This also disables the
+	 * sizeBasedResolutionCapEnabled option.
+	 *
+	 * Is enabled by default.
+	 *
+	 * Note:  It is strongly recommended to keep this enabled as user experience can greatly suffer without ABR.
+	 */
+	abrEnabled?: boolean;
+	/**
+	 * Enable or disable telemetry. This allows for telemetry and errors being collected.
+	 *
+	 * Is enabled by default.
+	 *
+	 * We appreciate you turning it off during development/staging to not bloat real telemetry data.
+	 *
+	 * Note: It is strongly recommended to keep this enabled in production as it is required for insights and KPIs.
+	 */
+	telemetryEnabled?: boolean;
+	/**
+	 * Set a cap on the maximum video size.
+	 * This can be used to provide user options to limit the video bandwidth usage.
+	 *
+	 * Note: This takes presedence over any size based resolution caps.
+	 */
+	maxSize?: Size;
+	/**
+	 * Maximum audio bit rate allowed.
+	 * This can be used to provide user options to limit the audio bandwidth usage.
+	 */
+	maxAudioBitRate?: number;
+	/**
+	 * Maximum video bit rate allowed.
+	 * This can be used to provide user options to limit the video bandwidth usage.
+	 */
+	maxVideoBitRate?: number;
+	/**
+	 * Controls video element background behaviour while loading.
+	 * - If `false`, a black background will be shown.
+	 * - If undefined or `true`, a live thumbnail will be shown.
+	 * - If set to a string containing a URL (https://urltoimage), use that.
+	 * Default `true` - meaning a live thumbnail is shown
+	 */
+	poster?: boolean | string;
+	/**
+	 * Whether to start the player muted or to try to start playing audio automatically.
+	 */
+	muted?: boolean;
+	/**
+	 * 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
+	 * false to stop reconnecting. It can also return a promise with true or false if it needs
+	 * to make any async calls before determining wether to reconnect.
+	 *
+	 * The default reconnect handler allows 30 reconnects before stopping.
+	 *
+	 * Note: the ReconnectState gets reset every time the client instance makes a successful connection.
+	 * This means the default reconnect handler will only stop reconnecting after 30 _consecutive_ failed connections.
+	 *
+	 * ```typescript
+	 * // An example reconnect handler that will reconnect forever
+	 * const reconnectHandler = (state: ReconnectState) => true
+	 *
+	 * // An example reconnect handler that will fetch an url and determine whether to reconnect
+	 * const reconnectHandler = async (state: ReconnectState) => {
+	 *   const result = await fetch("https://should-i-reconnect-now.com")
+	 *   return result.ok
+	 * },
+	 * ```
+	 */
+	reconnectHandler?: (state: ReconnectState) => Promise<boolean> | boolean;
+	tags?: string[];
+	ownerSessionId?: string;
+	edgeUrl?: string;
+	logShippingEnabled?: boolean;
+	statsShippingEnabled?: boolean;
+	/**
+	 * Enable wake lock for iOS devices.
+	 * The wake lock requires that the audio has been activated at least once for the instance, othwerwise it will not work.
+	 * Other devices already provide wake lock by default.
+	 *
+	 * This option is redundant and has no effect if iosMediaElementEnabled is enabled since that automatically enables wake lock.
+	 *
+	 * Disabled by default.
+	 */
+	iosWakeLockEnabled?: boolean;
+	/**
+	 * Disabling this will revert to legacy behaviour where Vindral will try to always keep the video element playing.
+	 */
+	pauseSupportEnabled?: boolean;
+	/**
+	 * Enables iOS devices to use a media element for playback. This enables fullscreen and picture in picture support on iOS.
+	 */
+	iosMediaElementEnabled?: boolean;
+	/**
+	 * Advanced options to override default behaviour.
+	 */
+	advanced?: AdvancedOptions;
+	media?: Media;
+	videoCodecs?: VideoCodec[];
+}
+/**
+ * Represents a rendition (quality level).
+ */
+export interface RenditionLevel {
+	audio?: AudioRendition;
+	video?: VideoRendition;
+}
+type RenditionLevelChangedReason = "abr" | "manual";
+/**
+ * Contextual information about the rendition level change.
+ */
+export interface RenditionLevelChanged {
+	from?: RenditionLevel;
+	to?: RenditionLevel;
+	reason: RenditionLevelChangedReason;
+}
 /**
  * Channel
  */
@@ -103,6 +366,9 @@ interface ClientOverrides {
 	minBufferTime?: number;
 	maxBufferTime?: number;
 	burstEnabled?: boolean;
+	sizeBasedResolutionCapEnabled?: boolean;
+	separateVideoSocketEnabled?: boolean;
+	videoCodecs?: string[];
 }
 interface ChannelWithRenditionsAndOverrides extends Channel {
 	renditions: Rendition[];
@@ -192,20 +458,7 @@ export declare class ApiClient {
 	private toChannel;
 }
 /**
- * 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;
-}
-/**
- * Available events to listen to
+ * Available events to listen to
  */
 export interface CastSenderEvents {
 	/**
@@ -323,51 +576,6 @@ export declare class CastSender extends Emitter<CastSenderEvents> {
 	private castLibrariesAdded;
 	private verifyCastLibraries;
 }
-export interface TimeRange {
-	start: number;
-	end: number;
-}
-export declare enum Level {
-	TRACE = "trace",
-	DEBUG = "debug",
-	INFO = "info",
-	WARN = "warn",
-	ERROR = "error",
-	CRITICAL = "critical"
-}
-interface NeedsUserInputContext {
-	/**
-	 * True if user input is needed for audio
-	 */
-	forAudio: boolean;
-	/**
-	 * True if user input is needed for video
-	 */
-	forVideo: boolean;
-}
-type PlaybackState = "buffering" | "playing" | "paused";
-type BufferStateEvent = "filled" | "drained";
-interface PlaybackModuleStatistics {
-	/**
-	 * Current target buffer time if using dynamic buffer. Otherwise, this is the statically set buffer time from instantiation.
-	 */
-	bufferTime: number;
-	needsInputForAudioCount: number;
-	needsInputForVideoCount: number;
-}
-interface AdaptivityStatistics {
-	/**
-	 * True if adaptive bitrate (ABR) is enabled.
-	 */
-	isAbrEnabled: boolean;
-}
-interface BufferTimeStatistics {
-	/**
-	 * Number of time buffer time has been adjusted. This will only happen when using dynamic buffer time
-	 * (different min/max values of bufferTime).
-	 */
-	bufferTimeAdjustmentCount: number;
-}
 interface VindralErrorProps {
 	isFatal: boolean;
 	type?: ErrorType;
@@ -411,6 +619,26 @@ export declare class VindralError extends Error {
 	 */
 	toStringifiable: () => Record<string, unknown>;
 }
+type PlaybackState = "buffering" | "playing" | "paused";
+type BufferStateEvent = "filled" | "drained";
+interface PlaybackModuleStatistics {
+	/**
+	 * Current target buffer time if using dynamic buffer. Otherwise, this is the statically set buffer time from instantiation.
+	 */
+	bufferTime: number;
+	needsInputForAudioCount: number;
+	needsInputForVideoCount: number;
+}
+interface NeedsUserInputContext {
+	/**
+	 * True if user input is needed for audio
+	 */
+	forAudio: boolean;
+	/**
+	 * True if user input is needed for video
+	 */
+	forVideo: boolean;
+}
 type State = "connected" | "disconnected" | "connecting";
 type ContextSwitchState = "completed" | "started";
 interface ConnectionStatistics {
@@ -433,20 +661,165 @@ interface ConnectionStatistics {
 	connectionAttemptCount: number;
 }
 /**
- * Represents a rendition (quality level).
+ * Contextual information about the language switch
  */
-export interface RenditionLevel {
-	audio?: AudioRendition;
-	video?: VideoRendition;
+export interface LanguageSwitchContext {
+	/**
+	 * The new language that was switched to
+	 */
+	language: string;
 }
-type RenditionLevelChangedReason = "abr" | "manual";
 /**
- * Contextual information about the rendition level change.
+ * Contextual information about the channel switch
  */
-export interface RenditionLevelChanged {
-	from?: RenditionLevel;
-	to?: RenditionLevel;
-	reason: RenditionLevelChangedReason;
+export interface ChannelSwitchContext {
+	/**
+	 * The new channel id that was switched to
+	 */
+	channelId: string;
+}
+interface VolumeState {
+	/**
+	 * Wether the audio is muted
+	 */
+	isMuted: boolean;
+	/**
+	 * The volume level
+	 */
+	volume: number;
+}
+/**
+ * The events that can be emitted from the Vindral instance
+ */
+export interface PublicVindralEvents {
+	/**
+	 * When an error that requires action has occured
+	 *
+	 * Can be a fatal error that will unload the Vindral instance - this is indicated by `isFatal()` on the error object returning true.
+	 *
+	 * 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>;
+	/**
+	 * When the instance needs user input to activate audio or sometimes video playback.
+	 * Is called with an object
+	 * ```javascript
+	 * {
+	 *   forAudio: boolean // true if user input is needed for audio playback
+	 *   forVideo: boolean // true if user input is needed for video playback
+	 * }
+	 * ```
+	 */
+	["needs user input"]: NeedsUserInputContext;
+	/**
+	 * When a timed metadata event has been triggered
+	 */
+	["metadata"]: Readonly<Metadata>;
+	/**
+	 * When the playback state changes
+	 */
+	["playback state"]: Readonly<PlaybackState>;
+	/**
+	 * When the connection state changes
+	 */
+	["connection state"]: Readonly<State>;
+	/**
+	 * When the available rendition levels is changed
+	 */
+	["rendition levels"]: ReadonlyArray<RenditionLevel>;
+	/**
+	 * When the rendition level is changed
+	 */
+	["rendition level"]: Readonly<RenditionLevel>;
+	/**
+	 * When the available languages is changed
+	 */
+	["languages"]: ReadonlyArray<string>;
+	/**
+	 * When the available channels is changed
+	 */
+	["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>;
+	/**
+	 * 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>;
+	/**
+	 * Is emitted during connection whether the channel is live or not.
+	 *
+	 * If the channel is not live, the Vindral instance will try to reconnect until the `reconnectHandler`
+	 * determines that no more retries should be made.
+	 *
+	 * 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;
+	/**
+	 * 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>;
+	/**
+	 * Emitted when a language switch has been completed and the new language starts playing.
+	 */
+	["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>;
+	["buffer state event"]: Readonly<BufferStateEvent>;
+	["initialized media"]: void;
+}
+declare const defaultOptions: {
+	sizeBasedResolutionCapEnabled: boolean;
+	pictureInPictureEnabled: boolean;
+	abrEnabled: boolean;
+	burstEnabled: boolean;
+	mseEnabled: boolean;
+	mseOpusEnabled: boolean;
+	muted: boolean;
+	minBufferTime: number;
+	maxBufferTime: number;
+	logLevel: Level;
+	maxSize: Size;
+	maxVideoBitRate: number;
+	maxAudioBitRate: number;
+	tags: string[];
+	media: Media;
+	poster: string | boolean;
+	reconnectHandler: (state: ReconnectState) => Promise<boolean> | boolean;
+	iosWakeLockEnabled: boolean;
+	telemetryEnabled: boolean;
+	iosMediaElementEnabled: boolean;
+	pauseSupportEnabled: boolean;
+	advanced: {
+		wasmDecodingConstraint: Partial<VideoConstraint>;
+	};
+	videoCodecs: VideoCodec[];
+};
+interface AdaptivityStatistics {
+	/**
+	 * True if adaptive bitrate (ABR) is enabled.
+	 */
+	isAbrEnabled: boolean;
+}
+interface BufferTimeStatistics {
+	/**
+	 * Number of time buffer time has been adjusted. This will only happen when using dynamic buffer time
+	 * (different min/max values of bufferTime).
+	 */
+	bufferTimeAdjustmentCount: number;
 }
 interface RenditionsModuleStatistics {
 	/**
@@ -552,12 +925,6 @@ interface IncomingDataModuleStatistics {
 	 */
 	bytesReceived: number;
 }
-interface VideoPlayerStatistics {
-	renderedFrameCount: number;
-	rendererDroppedFrameCount: number;
-	contextLostCount: number;
-	contextRestoredCount: number;
-}
 interface MseModuleStatistics {
 	quotaErrorCount: number;
 	mediaSourceOpenTime: number;
@@ -594,20 +961,35 @@ interface SyncModuleStatistics {
 	timeshiftDriftAdjustmentCount: number;
 	seekTime: number;
 }
-declare class UserAgentInformation {
-	private highEntropyValues?;
-	constructor();
-	getUserAgentInformation(): {
-		userAgentLegacy: string;
-		ua: {
-			browser: {
-				brands: string[];
-				fullVersionBrands: string[];
-				majorVersions: string[];
-			};
-			device: string;
-			os: {
-				family: string;
+interface TelemetryModuleStatistics {
+	/**
+	 * The total amount of errors being spawned. Note that some media errors can trigger
+	 * thousands of errors for a single client in a few seconds before recovering. Therefore,
+	 * consider the number of viewers with errors, not just the total amount. Also, consider the median
+	 * instead of the mean for average calculation.
+	 */
+	errorCount: number;
+}
+interface VideoPlayerStatistics {
+	renderedFrameCount: number;
+	rendererDroppedFrameCount: number;
+	contextLostCount: number;
+	contextRestoredCount: number;
+}
+declare class UserAgentInformation {
+	private highEntropyValues?;
+	constructor();
+	getUserAgentInformation(): {
+		userAgentLegacy: string;
+		ua: {
+			browser: {
+				brands: string[];
+				fullVersionBrands: string[];
+				majorVersions: string[];
+			};
+			device: string;
+			os: {
+				family: string;
 				version: string;
 				major_version: number;
 			};
@@ -969,483 +1351,176 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
 	get bufferingRatios(): Map<string, number>;
 	get timeSpentBuffering(): number;
 	get timeActive(): number;
-	get mediaElement(): HTMLMediaElement | HTMLCanvasElement;
-	/**
-	 * Get active Vindral Options
-	 */
-	getOptions: () => Options & typeof defaultOptions;
-	/**
-	 * Get url for fetching thumbnail. Note that fetching thumbnails only works for an active channel.
-	 */
-	getThumbnailUrl: () => string;
-	/**
-	 * Update authentication token on an already established and authenticated connection
-	 */
-	updateAuthenticationToken: (token: string) => void;
-	/**
-	 * @deprecated since 3.0.0 Use play instead.
-	 * Connects to the configured channel and starts streaming
-	 */
-	connect: () => void;
-	private _connect;
-	/**
-	 * Get options that can be used for CastSender
-	 */
-	getCastOptions: () => Options;
-	private connectionInfo;
-	private estimateRTT;
-	private connectHandler;
-	private emitLanguagesIfChanged;
-	private filterRenditions;
-	/**
-	 * Patch the subscription with properties from the channel that isn't known until connection
-	 * @param channel Channel with the renditions to patch the subscription based on
-	 */
-	private patchSubscription;
-	private isSupportedVideoCodecProfile;
-	private supportedAudioCodecs;
-	private initializeDecodingModule;
-	/**
-	 * Fully unloads the instance. This disconnects the clients and stops any background tasks.
-	 * This client instance can not be used after this has been called.
-	 */
-	unload: () => Promise<void>;
-	/**
-	 * @deprecated since 3.0.0 Use play instead.
-	 *
-	 * Activates audio or video on web browsers that require a user gesture to enable media playback.
-	 * The Vindral instance will emit a "needs user input" event to indicate when this is needed.
-	 * But it is also safe to pre-emptively call this if it is more convenient - such as in cases where
-	 * the Vindral instance itself is created in a user input event.
-	 *
-	 * Requirements: This method needs to be called within an user-input event handler to function properly, such as
-	 * an onclick handler.
-	 *
-	 * Note: Even if you pre-emptively call this it is still recommended to listen to "needs user input"
-	 * and handle that event gracefully.
-	 */
-	userInput: () => void;
-	/**
-	 * Pauses the stream. Call .play() to resume playback again.
-	 */
-	pause: () => void;
-	/**
-	 *
-	 * Start playing the stream.
-	 *
-	 * This method also activates audio or video on web browsers that require a user gesture to enable media playback.
-	 * The Vindral instance will emit a "needs user input" event to indicate when this is needed.
-	 * But it is also safe to pre-emptively call this if it is more convenient - such as in cases where
-	 * the Vindral instance itself is created in a user input event.
-	 *
-	 * Note: In most browsers this method needs to be called within an user-input event handler, such as
-	 * an onclick handler in order to activate audio. Most implementations call this directly after constructing the Vindral
-	 * instance once in order to start playing, and then listen to a user-event in order to allow audio to be activated.
-	 *
-	 * Note 2: Even if you pre-emptively call this it is still recommended to listen to "needs user input"
-	 * and handle that event gracefully.
-	 */
-	play: () => Promise<void>;
-	/**
-	 * How long in milliseconds since the instance was created
-	 */
-	get uptime(): number;
-	/**
-	 * This method collects a statistics report from internal modules. While many of the report's properties are documented, the report may also contain undocumented
-	 * properties used internally or temporarily for monitoring and improving the performance of the service.
-	 *
-	 * Use undocumented properties at your own risk.
-	 */
-	getStatistics: () => Statistics;
-	private resetModules;
-	private suspend;
-	private unsuspend;
-	private getRuntimeInfo;
-	private onMediaElementState;
-	private onBufferEvent;
-	/**
-	 * Aligns size and bitrate to match a rendition level correctly
-	 */
-	private alignSizeAndBitRate;
-	private get currentSubscription();
-	private get targetSubscription();
-	private timeToFirstFrame;
-	private willUseMediaSource;
-}
-interface TelemetryModuleStatistics {
-	/**
-	 * The total amount of errors being spawned. Note that some media errors can trigger
-	 * thousands of errors for a single client in a few seconds before recovering. Therefore,
-	 * consider the number of viewers with errors, not just the total amount. Also, consider the median
-	 * instead of the mean for average calculation.
-	 */
-	errorCount: number;
-}
-/**
- * The current reconnect state to use to decide whether to kep reconnecting or not
- */
-export 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;
-}
-/**
- * Advanced options to override default behaviour.
- */
-export interface AdvancedOptions {
-	/**
-	 * Constrains wasm decoding to this resolution.
-	 * By default it is set to 1280 in width and height.
-	 * This guarantees better performance on older devices and reduces battery drain in general.
-	 */
-	wasmDecodingConstraint: Partial<VideoConstraint>;
-}
-type Media = "audio" | "video" | "audio+video";
-/**
- * Options for the Vindral instance
- *
- */
-export interface Options {
-	/**
-	 * URL to use when connecting to the stream
-	 */
-	url: string;
-	/**
-	 * Channel ID to connect to initially - can be changed later mid-stream when connected to a channel group.
-	 */
-	channelId: string;
-	/**
-	 * Channel group to connect to
-	 * Note: Only needed for fast channel switching
-	 */
-	channelGroupId?: string;
-	/**
-	 * A container to attach the video view in - can be provided later with .attach() on the vindral core instance
-	 */
-	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;
-	/**
-	 * Language to use initially - can be changed during during runtime on the vindral instance
-	 * Note: Only needed when multiple languages are provided - if no language is specified, one will be automatically selected.
-	 */
-	language?: string;
-	/**
-	 * Sets the log level - defaults to info
-	 */
-	logLevel?: Level;
-	/**
-	 * Sets the minimum and initial buffer time
-	 */
-	minBufferTime?: number;
-	/**
-	 * Sets the maximum buffer time allowed. The vindral instance will automatically slowly increase
-	 * the buffer time if the use experiences to much buffering with the initial buffer time.
-	 *
-	 * Note: This is not yet implemented
-	 */
-	maxBufferTime?: number;
-	/**
-	 * Enables or disables user bandwidth savings by capping the video resolution to the size of the video element.
-	 *
-	 * Is enabled by default.
-	 *
-	 * Note: This is automatically set to false when abrEnabled is set to false.
-	 */
-	sizeBasedResolutionCapEnabled?: boolean;
-	/**
-	 * Enables or disables picture in picture support.
-	 */
-	pictureInPictureEnabled?: boolean;
-	/**
-	 * Enable bursting for initial connection and channel switches. This makes time to first frame faster at the
-	 * cost of stability (more demanding due to the sudden burst of live content)
-	 *
-	 * Is disabled by default.
-	 *
-	 */
-	burstEnabled?: boolean;
-	/**
-	 * Enable usage of the MediaSource API on supported browsers.
-	 *
-	 * Is enabled by default.
-	 *
-	 * Note: We recommend to keep this at the default value unless you have very specific needs.
-	 */
-	mseEnabled?: boolean;
-	/**
-	 * Enable Opus with the MediaSource API on supported browsers.
-	 *
-	 * Is enabled by default.
-	 *
-	 * Note: Opus generally provides better audio quality and is therefore recommended to keep enabled.
-	 */
-	mseOpusEnabled?: boolean;
-	/**
-	 * Enable or disable support for playing audio in the background for iOS devices.
-	 *
-	 * Is false (disabled) by default.
-	 *
-	 * Note:  This may be enabled by default in a future (major) release
-	 */
-	iosBackgroundPlayEnabled?: boolean;
-	/**
-	 * Enable or disable Adaptive Bit Rate. This allows for automatically adapting the incoming bit rate based on
-	 * the viewers bandwidth and thus avoiding buffering events. This also disables the
-	 * sizeBasedResolutionCapEnabled option.
-	 *
-	 * Is enabled by default.
-	 *
-	 * Note:  It is strongly recommended to keep this enabled as user experience can greatly suffer without ABR.
-	 */
-	abrEnabled?: boolean;
-	/**
-	 * Enable or disable telemetry. This allows for telemetry and errors being collected.
-	 *
-	 * Is enabled by default.
-	 *
-	 * We appreciate you turning it off during development/staging to not bloat real telemetry data.
-	 *
-	 * Note: It is strongly recommended to keep this enabled in production as it is required for insights and KPIs.
-	 */
-	telemetryEnabled?: boolean;
-	/**
-	 * Set a cap on the maximum video size.
-	 * This can be used to provide user options to limit the video bandwidth usage.
-	 *
-	 * Note: This takes presedence over any size based resolution caps.
-	 */
-	maxSize?: Size;
-	/**
-	 * Maximum audio bit rate allowed.
-	 * This can be used to provide user options to limit the audio bandwidth usage.
-	 */
-	maxAudioBitRate?: number;
-	/**
-	 * Maximum video bit rate allowed.
-	 * This can be used to provide user options to limit the video bandwidth usage.
-	 */
-	maxVideoBitRate?: number;
+	get mediaElement(): HTMLMediaElement | HTMLCanvasElement;
 	/**
-	 * Controls video element background behaviour while loading.
-	 * - If `false`, a black background will be shown.
-	 * - If undefined or `true`, a live thumbnail will be shown.
-	 * - If set to a string containing a URL (https://urltoimage), use that.
-	 * Default `true` - meaning a live thumbnail is shown
+	 * Get active Vindral Options
 	 */
-	poster?: boolean | string;
+	getOptions: () => Options & typeof defaultOptions;
 	/**
-	 * Whether to start the player muted or to try to start playing audio automatically.
+	 * Get url for fetching thumbnail. Note that fetching thumbnails only works for an active channel.
 	 */
-	muted?: boolean;
+	getThumbnailUrl: () => string;
 	/**
-	 * 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
-	 * false to stop reconnecting. It can also return a promise with true or false if it needs
-	 * to make any async calls before determining wether to reconnect.
-	 *
-	 * The default reconnect handler allows 30 reconnects before stopping.
-	 *
-	 * Note: the ReconnectState gets reset every time the client instance makes a successful connection.
-	 * This means the default reconnect handler will only stop reconnecting after 30 _consecutive_ failed connections.
-	 *
-	 * ```typescript
-	 * // An example reconnect handler that will reconnect forever
-	 * const reconnectHandler = (state: ReconnectState) => true
-	 *
-	 * // An example reconnect handler that will fetch an url and determine whether to reconnect
-	 * const reconnectHandler = async (state: ReconnectState) => {
-	 *   const result = await fetch("https://should-i-reconnect-now.com")
-	 *   return result.ok
-	 * },
-	 * ```
+	 * Update authentication token on an already established and authenticated connection
 	 */
-	reconnectHandler?: (state: ReconnectState) => Promise<boolean> | boolean;
-	tags?: string[];
-	ownerSessionId?: string;
-	edgeUrl?: string;
-	logShippingEnabled?: boolean;
-	statsShippingEnabled?: boolean;
+	updateAuthenticationToken: (token: string) => void;
 	/**
-	 * Enable wake lock for iOS devices.
-	 * The wake lock requires that the audio has been activated at least once for the instance, othwerwise it will not work.
-	 * Other devices already provide wake lock by default.
-	 *
-	 * This option is redundant and has no effect if iosMediaElementEnabled is enabled since that automatically enables wake lock.
-	 *
-	 * Disabled by default.
+	 * @deprecated since 3.0.0 Use play instead.
+	 * Connects to the configured channel and starts streaming
 	 */
-	iosWakeLockEnabled?: boolean;
+	connect: () => void;
+	private _connect;
 	/**
-	 * Disabling this will revert to legacy behaviour where Vindral will try to always keep the video element playing.
+	 * Get options that can be used for CastSender
 	 */
-	pauseSupportEnabled?: boolean;
+	getCastOptions: () => Options;
+	private connectionInfo;
+	private estimateRTT;
+	private connectHandler;
+	private emitLanguagesIfChanged;
+	private filterRenditions;
 	/**
-	 * Enables iOS devices to use a media element for playback. This enables fullscreen and picture in picture support on iOS.
+	 * Patch the subscription with properties from the channel that isn't known until connection
+	 * @param channel Channel with the renditions to patch the subscription based on
 	 */
-	iosMediaElementEnabled?: boolean;
+	private patchSubscription;
+	private isSupportedVideoCodecProfile;
+	private supportedAudioCodecs;
+	private initializeDecodingModule;
 	/**
-	 * Advanced options to override default behaviour.
+	 * Fully unloads the instance. This disconnects the clients and stops any background tasks.
+	 * This client instance can not be used after this has been called.
 	 */
-	advanced?: AdvancedOptions;
-	media?: Media;
-	videoCodecs?: VideoCodec[];
-}
-/**
- * Contextual information about the language switch
- */
-export interface LanguageSwitchContext {
+	unload: () => Promise<void>;
 	/**
-	 * The new language that was switched to
+	 * @deprecated since 3.0.0 Use play instead.
+	 *
+	 * Activates audio or video on web browsers that require a user gesture to enable media playback.
+	 * The Vindral instance will emit a "needs user input" event to indicate when this is needed.
+	 * But it is also safe to pre-emptively call this if it is more convenient - such as in cases where
+	 * the Vindral instance itself is created in a user input event.
+	 *
+	 * Requirements: This method needs to be called within an user-input event handler to function properly, such as
+	 * an onclick handler.
+	 *
+	 * Note: Even if you pre-emptively call this it is still recommended to listen to "needs user input"
+	 * and handle that event gracefully.
 	 */
-	language: string;
-}
-/**
- * Contextual information about the channel switch
- */
-export interface ChannelSwitchContext {
+	userInput: () => void;
 	/**
-	 * The new channel id that was switched to
+	 * Pauses the stream. Call .play() to resume playback again.
 	 */
-	channelId: string;
-}
-interface VolumeState {
+	pause: () => void;
 	/**
-	 * Wether the audio is muted
+	 *
+	 * Start playing the stream.
+	 *
+	 * This method also activates audio or video on web browsers that require a user gesture to enable media playback.
+	 * The Vindral instance will emit a "needs user input" event to indicate when this is needed.
+	 * But it is also safe to pre-emptively call this if it is more convenient - such as in cases where
+	 * the Vindral instance itself is created in a user input event.
+	 *
+	 * Note: In most browsers this method needs to be called within an user-input event handler, such as
+	 * an onclick handler in order to activate audio. Most implementations call this directly after constructing the Vindral
+	 * instance once in order to start playing, and then listen to a user-event in order to allow audio to be activated.
+	 *
+	 * Note 2: Even if you pre-emptively call this it is still recommended to listen to "needs user input"
+	 * and handle that event gracefully.
 	 */
-	isMuted: boolean;
+	play: () => Promise<void>;
 	/**
-	 * The volume level
+	 * How long in milliseconds since the instance was created
 	 */
-	volume: number;
-}
-/**
- * The events that can be emitted from the Vindral instance
- */
-export interface PublicVindralEvents {
+	get uptime(): number;
 	/**
-	 * When an error that requires action has occured
-	 *
-	 * Can be a fatal error that will unload the Vindral instance - this is indicated by `isFatal()` on the error object returning true.
+	 * This method collects a statistics report from internal modules. While many of the report's properties are documented, the report may also contain undocumented
+	 * properties used internally or temporarily for monitoring and improving the performance of the service.
 	 *
-	 * 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.
+	 * Use undocumented properties at your own risk.
 	 */
-	["error"]: Readonly<VindralError>;
+	getStatistics: () => Statistics;
+	private resetModules;
+	private suspend;
+	private unsuspend;
+	private getRuntimeInfo;
+	private onMediaElementState;
+	private onBufferEvent;
 	/**
-	 * When the instance needs user input to activate audio or sometimes video playback.
-	 * Is called with an object
-	 * ```javascript
-	 * {
-	 *   forAudio: boolean // true if user input is needed for audio playback
-	 *   forVideo: boolean // true if user input is needed for video playback
-	 * }
-	 * ```
+	 * Aligns size and bitrate to match a rendition level correctly
 	 */
-	["needs user input"]: NeedsUserInputContext;
+	private alignSizeAndBitRate;
+	private get currentSubscription();
+	private get targetSubscription();
+	private timeToFirstFrame;
+	private willUseMediaSource;
+}
+interface AirPlaySenderEvents {
 	/**
-	 * When a timed metadata event has been triggered
+	 * When airplay targets are available.
 	 */
-	["metadata"]: Readonly<Metadata>;
+	["available"]: void;
 	/**
-	 * When the playback state changes
+	 * When a connection has been established with an airplay target.
 	 */
-	["playback state"]: Readonly<PlaybackState>;
+	["connected"]: void;
 	/**
-	 * When the connection state changes
+	 * When the airplay target has lost or stopped a connection.
 	 */
-	["connection state"]: Readonly<State>;
+	["disconnected"]: void;
+}
+interface AirPlayConfig {
 	/**
-	 * When the available rendition levels is changed
+	 * URL to use when connecting to the stream.
 	 */
-	["rendition levels"]: ReadonlyArray<RenditionLevel>;
+	url: string;
 	/**
-	 * When the rendition level is changed
+	 * Channel ID to connect to.
 	 */
-	["rendition level"]: Readonly<RenditionLevel>;
+	channelId: string;
 	/**
-	 * When the available languages is changed
+	 * A container to attach the video element in. This should be the same container that the vindral video element is attached to.
 	 */
-	["languages"]: ReadonlyArray<string>;
+	container: HTMLElement;
 	/**
-	 * When the available channels is changed
+	 * 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.
 	 */
-	["channels"]: ReadonlyArray<Channel>;
+	authenticationToken?: string;
+}
+declare class AirPlaySender extends Emitter<AirPlaySenderEvents> {
+	private config;
+	private hlsUrl;
+	private element;
+	private connectingTimeout?;
+	private browser;
+	constructor(config: AirPlayConfig);
 	/**
-	 * When a context switch state change has occured.
-	 * E.g. when a channel change has been requested, or quality is changed.
+	 * True if the instance is casting right now.
 	 */
-	["context switch"]: Readonly<ContextSwitchState>;
+	get casting(): boolean;
 	/**
-	 * 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.
+	 * Set the current channelId.
 	 */
-	["server wallclock time"]: Readonly<number>;
+	set channelId(channelId: string);
 	/**
-	 * Is emitted during connection whether the channel is live or not.
-	 *
-	 * If the channel is not live, the Vindral instance will try to reconnect until the `reconnectHandler`
-	 * determines that no more retries should be made.
-	 *
-	 * 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.
+	 * Update authentication token on an already established and authenticated connection.
 	 */
-	["is live"]: boolean;
+	updateAuthenticationToken: (_token: string) => void;
 	/**
-	 * 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.
+	 * Fully unloads the instance. This disconnects the current listeners.
 	 */
-	["channel switch"]: Readonly<ChannelSwitchContext>;
+	unload: () => void;
 	/**
-	 * Emitted when a language switch has been completed and the new language starts playing.
+	 * Show the AirPlay picker.
 	 */
-	["language switch"]: Readonly<LanguageSwitchContext>;
+	showPlaybackTargetPicker(): void;
 	/**
-	 * 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.
+	 * Returns if AirPlay is supported.
 	 */
-	["volume state"]: Readonly<VolumeState>;
-	["buffer state event"]: Readonly<BufferStateEvent>;
-	["initialized media"]: void;
+	static isAirPlaySupported(): boolean;
+	private onAirPlayAvailable;
+	private onAirPlayPlaybackChanged;
 }
-declare const defaultOptions: {
-	sizeBasedResolutionCapEnabled: boolean;
-	pictureInPictureEnabled: boolean;
-	abrEnabled: boolean;
-	burstEnabled: boolean;
-	mseEnabled: boolean;
-	mseOpusEnabled: boolean;
-	muted: boolean;
-	minBufferTime: number;
-	maxBufferTime: number;
-	logLevel: Level;
-	maxSize: Size;
-	maxVideoBitRate: number;
-	maxAudioBitRate: number;
-	tags: string[];
-	media: Media;
-	poster: string | boolean;
-	reconnectHandler: (state: ReconnectState) => Promise<boolean> | boolean;
-	iosWakeLockEnabled: boolean;
-	telemetryEnabled: boolean;
-	iosMediaElementEnabled: boolean;
-	pauseSupportEnabled: boolean;
-	advanced: {
-		wasmDecodingConstraint: Partial<VideoConstraint>;
-	};
-	videoCodecs: VideoCodec[];
-};
 /**
  * Available options when initializing the Player. Used for enabling/disabling features
  * and hiding/showing buttons in the control pane
@@ -1520,6 +1595,10 @@ export interface PlayerOptions {
 	 * Enable or disable the pause and play button
 	 */
 	pauseButtonEnabled?: boolean;
+	/**
+	 * Enable or disable the AirPlay button
+	 */
+	airPlayButtonEnabled?: boolean;
 }
 /**
  * Represents a Vindral player
@@ -1541,6 +1620,10 @@ export declare class Player {
 	 * The CastSender instance
 	 */
 	readonly castSender: CastSender;
+	/**
+	 * The AirPlaySender instance
+	 */
+	readonly airPlaySender?: AirPlaySender;
 	private options;
 	private state;
 	private playerElement;
@@ -1562,6 +1645,7 @@ export declare class Player {
 	 */
 	attach: (container: HTMLElement) => void;
 	private setupCastSender;
+	private setupAirPlaySender;
 	private onMouseMove;
 	private onClick;
 	private togglePip;
@@ -1588,6 +1672,10 @@ export declare class Player {
 	 * Exit fullscreen mode
 	 */
 	exitFullscreen: () => Promise<void>;
+	/**
+	 * Show the AirPlay picker
+	 */
+	showAirPlayPicker: () => void;
 	private lockOrientation;
 	private unlockOrientation;
 	private checkState;