@vindral/web-sdk 3.3.0 → 3.3.2

package/README.md

@@ -10,6 +10,8 @@ Make sure to check out the [Web SDK guides](https://docs.vindral.com/playout/web
 
 [Check out our demo](https://demo.vindral.com/) to see some of Vindral's features.
 
+For detailed information about our latest updates, visit the [changelog](https://docs.vindral.com/web-sdk/changelog/).
+
 ## Getting Started
 
 There are multiple ways to integrate the Web SDK, depending on the use case.

package/index.d.ts

@@ -368,6 +368,7 @@ interface ClientOverrides {
 	burstEnabled?: boolean;
 	sizeBasedResolutionCapEnabled?: boolean;
 	separateVideoSocketEnabled?: boolean;
+	videoCodecs?: string[];
 }
 interface ChannelWithRenditionsAndOverrides extends Channel {
 	renditions: Rendition[];
@@ -979,6 +980,11 @@ declare class UserAgentInformation {
 	private highEntropyValues?;
 	constructor();
 	getUserAgentInformation(): {
+		locationOrigin: string;
+		locationPath: string;
+		ancestorOrigins: string[] | undefined;
+		hardwareConcurrency: number;
+		deviceMemory: number | undefined;
 		userAgentLegacy: string;
 		ua: {
 			browser: {
@@ -993,17 +999,13 @@ declare class UserAgentInformation {
 				major_version: number;
 			};
 		};
-		locationOrigin: string;
-		locationPath: string;
-		ancestorOrigins: string[] | undefined;
-		userAgent?: undefined;
 	} | {
-		userAgent: string;
 		locationOrigin: string;
 		locationPath: string;
 		ancestorOrigins: string[] | undefined;
-		userAgentLegacy?: undefined;
-		ua?: undefined;
+		hardwareConcurrency: number;
+		deviceMemory: number | undefined;
+		userAgent: string;
 	};
 }
 type ModuleStatistics = AdaptivityStatistics & BufferTimeStatistics & ConnectionStatistics & ConstraintCapStatistics & DecoderStatistics & DocumentStateModulesStatistics & IncomingDataModuleStatistics & MseModuleStatistics & PlaybackModuleStatistics & QualityOfServiceModuleStatistics & RenditionsModuleStatistics & SyncModuleStatistics & TelemetryModuleStatistics & VideoPlayerStatistics;
@@ -1410,6 +1412,7 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
 	 * Pauses the stream. Call .play() to resume playback again.
 	 */
 	pause: () => void;
+	private registerDebugInstance;
 	/**
 	 *
 	 * Start playing the stream.
@@ -1453,6 +1456,73 @@ 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
@@ -1527,6 +1597,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
@@ -1548,6 +1622,10 @@ export declare class Player {
 	 * The CastSender instance
 	 */
 	readonly castSender: CastSender;
+	/**
+	 * The AirPlaySender instance
+	 */
+	readonly airPlaySender?: AirPlaySender;
 	private options;
 	private state;
 	private playerElement;
@@ -1569,6 +1647,7 @@ export declare class Player {
 	 */
 	attach: (container: HTMLElement) => void;
 	private setupCastSender;
+	private setupAirPlaySender;
 	private onMouseMove;
 	private onClick;
 	private togglePip;
@@ -1595,6 +1674,10 @@ export declare class Player {
 	 * Exit fullscreen mode
 	 */
 	exitFullscreen: () => Promise<void>;
+	/**
+	 * Show the AirPlay picker
+	 */
+	showAirPlayPicker: () => void;
 	private lockOrientation;
 	private unlockOrientation;
 	private checkState;