@vindral/web-sdk 3.3.3 → 3.4.0

package/index.d.ts

@@ -55,6 +55,7 @@ declare class Emitter<TEvents, TEmits = TEvents, ArgLessEvents extends VoidKeys<
 	private add;
 }
 interface MinMaxAverage {
+	last: number;
 	/**
 	 * Average value over a given interval.
 	 */
@@ -105,9 +106,15 @@ interface AudioRenditionProps {
 	channels: number;
 	sampleRate: number;
 }
+interface TextRenditionProps {
+	codec: "webvtt";
+	kind: "subtitles" | "captions";
+	label?: string;
+}
 type VideoRendition = VideoRenditionProps & RenditionProps;
 type AudioRendition = AudioRenditionProps & RenditionProps;
-type Rendition = VideoRendition | AudioRendition;
+type TextRendition = TextRenditionProps & RenditionProps;
+type Rendition = VideoRendition | AudioRendition | TextRendition;
 interface Size {
 	width: number;
 	height: number;
@@ -174,8 +181,6 @@ export interface Options {
 	/**
 	 * 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;
 	/**
@@ -211,7 +216,6 @@ export interface Options {
 	 *
 	 * Is enabled by default.
 	 *
-	 * Note: Opus generally provides better audio quality and is therefore recommended to keep enabled.
 	 */
 	mseOpusEnabled?: boolean;
 	/**
@@ -619,6 +623,73 @@ 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?;
+	private browser;
+	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;
+}
 type PlaybackState = "buffering" | "playing" | "paused";
 type BufferStateEvent = "filled" | "drained";
 interface PlaybackModuleStatistics {
@@ -736,6 +807,10 @@ export interface PublicVindralEvents {
 	 * When the available languages is changed
 	 */
 	["languages"]: ReadonlyArray<string>;
+	/**
+	 * When the available text tracks are changed
+	 */
+	["text tracks"]: ReadonlyArray<string>;
 	/**
 	 * When the available channels is changed
 	 */
@@ -1096,10 +1171,12 @@ export type Statistics = ModuleStatistics & ReturnType<UserAgentInformation["get
  * ```
  */
 export declare class Vindral extends Emitter<PublicVindralEvents> {
+	#private;
 	private static MAX_POOL_SIZE;
 	private static INITIAL_MAX_BIT_RATE;
 	private static PING_TIMEOUT;
 	private static DISCONNECT_TIMEOUT;
+	private static REMOVE_CUE_THRESHOLD;
 	/**
 	 * Picture in picture
 	 */
@@ -1277,6 +1354,9 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
 	 * Set the current language
 	 */
 	set language(language: string | undefined);
+	set textTrack(label: string | undefined);
+	get textTracks(): string[];
+	get textTrack(): string | undefined;
 	/**
 	 * The current channelId
 	 */
@@ -1285,6 +1365,10 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
 	 * Set the current channelId
 	 *
 	 * Possible channels to set are available from [[channels]]
+	 *
+	 * Note that the following scenarios are not possible right now:
+	 * - switching channel from a channel with audio to a channel without audio (unless audio only mode is active)
+	 * - switching channel from a channel with video to a channel without video (unless video only mode is active)
 	 */
 	set channelId(channelId: string);
 	/**
@@ -1379,6 +1463,8 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
 	private estimateRTT;
 	private connectHandler;
 	private emitLanguagesIfChanged;
+	private updateTextTracks;
+	private cleanupTextTracks;
 	private filterRenditions;
 	/**
 	 * Patch the subscription with properties from the channel that isn't known until connection
@@ -1456,73 +1542,6 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
 	private timeToFirstFrame;
 	private willUseMediaSource;
 }
-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?;
-	private browser;
-	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;
-}
 /**
  * Available options when initializing the Player. Used for enabling/disabling features
  * and hiding/showing buttons in the control pane
@@ -1573,6 +1592,10 @@ export interface PlayerOptions {
 	 * Enable or disable language selector
 	 */
 	languagesButtonEnabled?: boolean;
+	/**
+	 * Enable or disable text track selector
+	 */
+	textTracksButtonEnabled?: boolean;
 	/**
 	 * Enable or disable one-to-one (real size, not filling the entire container)
 	 */
@@ -1601,6 +1624,15 @@ export interface PlayerOptions {
 	 * Enable or disable the AirPlay button
 	 */
 	airPlayButtonEnabled?: boolean;
+	/**
+	 * Enable or disable the play overlay
+	 */
+	playOverlayEnabled?: boolean;
+	/**
+	 * Enable or disable the buffering overlay
+  
+	 */
+	bufferingOverlayEnabled?: boolean;
 }
 /**
  * Represents a Vindral player
@@ -1629,8 +1661,8 @@ export declare class Player {
 	private options;
 	private state;
 	private playerElement;
-	private bufferingOverlay;
-	private playOverlay;
+	private bufferingOverlay?;
+	private playOverlay?;
 	private castOverlay;
 	private channelSelectionList?;
 	private bar;