@vindral/web-sdk 3.3.4 → 3.4.1

package/index.d.ts

@@ -106,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;
@@ -164,6 +170,10 @@ export interface Options {
 	 * Note: Only needed when multiple languages are provided - if no language is specified, one will be automatically selected.
 	 */
 	language?: string;
+	/**
+	 * TextTrack to use initially - can be changed during during runtime on the vindral instance
+	 */
+	textTrack?: string;
 	/**
 	 * Sets the log level - defaults to info
 	 */
@@ -175,8 +185,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;
 	/**
@@ -212,7 +220,6 @@ export interface Options {
 	 *
 	 * Is enabled by default.
 	 *
-	 * Note: Opus generally provides better audio quality and is therefore recommended to keep enabled.
 	 */
 	mseOpusEnabled?: boolean;
 	/**
@@ -620,6 +627,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 {
@@ -737,6 +811,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
 	 */
@@ -1097,10 +1175,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
 	 */
@@ -1278,6 +1358,18 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
 	 * Set the current language
 	 */
 	set language(language: string | undefined);
+	/**
+	 * Set the active text track
+	 */
+	set textTrack(label: string | undefined);
+	/**
+	 * Get the available text tracks
+	 */
+	get textTracks(): string[];
+	/**
+	 * Get the active text track
+	 */
+	get textTrack(): string | undefined;
 	/**
 	 * The current channelId
 	 */
@@ -1384,6 +1476,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
@@ -1461,73 +1555,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
@@ -1578,6 +1605,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)
 	 */
@@ -1612,7 +1643,7 @@ export interface PlayerOptions {
 	playOverlayEnabled?: boolean;
 	/**
 	 * Enable or disable the buffering overlay
-	 
+  
 	 */
 	bufferingOverlayEnabled?: boolean;
 }