@vindral/web-sdk 4.1.1 → 4.1.2-10-g30d188ef

package/legacy.d.ts

@@ -307,6 +307,20 @@ export interface DrmOptions {
 	 * Query parameters to be added to requests to license servers
 	 */
 	queryParams?: Record<string, string>;
+	/**
+	 * Widevine options to override default behaviour
+	 */
+	widevine?: {
+		videoRobustness?: string[];
+		audioRobustness?: string[];
+	};
+	/**
+	 * Playready options to override default behaviour
+	 */
+	playready?: {
+		videoRobustness?: string[];
+		audioRobustness?: string[];
+	};
 }
 /**
  * Type of media.
@@ -1104,11 +1118,20 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
 	 */
 	get channelCurrentTime(): number;
 	/**
-	 * The current target buffer time in milliseconds
+	 * The current target buffer time in milliseconds.
+	 *
+	 * Initially, this will always be equal to `minBufferTime`.
+	 * Only when using a separate `maxBufferTime`, the `targetBufferTime` will be able to vary between min and max.
+	 *
 	 */
 	get targetBufferTime(): number;
 	/**
-	 * Set the current target buffer time in milliseconds
+	 * Set the current target buffer time in milliseconds.
+	 *
+	 * Note that setting this will not respect min/max buffer time values.
+	 * For instance with `{ minBufferTime: 500, maxBufferTime: 3000 }, you can still set `targetBufferTime` to 100 ms.`
+	 * The dynamic buffer will still work in respect to the originally set values when needed. Therefore we recommend
+	 * setting targetBufferTime within that range for consistancy if using both min/max.
 	 */
 	set targetBufferTime(bufferTimeMs: number);
 	/**
@@ -1676,6 +1699,7 @@ declare class AirPlaySender extends Emitter<AirPlaySenderEvents> {
 	private hlsUrl;
 	private element;
 	private connectingTimeout?;
+	private castingAvailable;
 	constructor(config: AirPlayConfig);
 	/**
 	 * True if the instance is casting right now.
@@ -1687,8 +1711,9 @@ declare class AirPlaySender extends Emitter<AirPlaySenderEvents> {
 	set channelId(channelId: string);
 	/**
 	 * Update authentication token on an already established and authenticated connection.
+	 * Note: When casting to AirPlay, this will interrupt the current session to apply the new token.
 	 */
-	updateAuthenticationToken: (_token: string) => void;
+	updateAuthenticationToken: (token: string) => void;
 	/**
 	 * Fully unloads the instance. This disconnects the current listeners.
 	 */
@@ -1703,6 +1728,7 @@ declare class AirPlaySender extends Emitter<AirPlaySenderEvents> {
 	static isAirPlaySupported(): boolean;
 	private onAirPlayAvailable;
 	private onAirPlayPlaybackChanged;
+	private getHlsUrl;
 	private checkHlsUrl;
 }
 /**
@@ -1801,10 +1827,11 @@ export interface PlayerOptions {
  * Represents a Vindral player
  *
  * ```typescript
- * // minimal configuration of a Vindral web player
+ * // example configuration of a Vindral web player
  * const instance = new Player({
  *   url: "https://lb.cdn.vindral.com",
  *   channelId: "vindral_demo1_ci_099ee1fa-80f3-455e-aa23-3d184e93e04f",
+ *   minBufferTime: 1000,
  * })
  * ```
  */