@vindral/web-sdk 4.1.2 → 4.1.3

package/api-client.js

@@ -1,4 +1,4 @@
-import { A as o } from "./hRzek83o.js";
+import { A as o } from "./Bs3ZbgIy.js";
 export {
   o as ApiClient
 };

package/core.d.ts

@@ -1103,11 +1103,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);
 	/**

package/core.js

@@ -1,4 +1,4 @@
-import { b as C, c as I, e as _, f as O, C as D, D as T, I as a, N as A, V as s, g as r } from "./ZD9OGvpf.js";
+import { b as C, c as I, e as _, f as O, C as D, D as T, I as a, N as A, V as s, g as r } from "./DykhWWFG.js";
 export {
   C as AUTHENTICATION_EXPIRED_CODE,
   I as AUTHENTICATION_FAILED_CODE,

package/legacy.d.ts

@@ -1118,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);
 	/**
@@ -1818,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,
  * })
  * ```
  */