@vindral/web-sdk 4.1.2 → 4.1.3-2-g8484afe9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/react.d.ts CHANGED
@@ -997,11 +997,20 @@ declare class Vindral extends Emitter<PublicVindralEvents> {
997
997
  */
998
998
  get channelCurrentTime(): number;
999
999
  /**
1000
- * The current target buffer time in milliseconds
1000
+ * The current target buffer time in milliseconds.
1001
+ *
1002
+ * Initially, this will always be equal to `minBufferTime`.
1003
+ * Only when using a separate `maxBufferTime`, the `targetBufferTime` will be able to vary between min and max.
1004
+ *
1001
1005
  */
1002
1006
  get targetBufferTime(): number;
1003
1007
  /**
1004
- * Set the current target buffer time in milliseconds
1008
+ * Set the current target buffer time in milliseconds.
1009
+ *
1010
+ * Note that setting this will not respect min/max buffer time values.
1011
+ * For instance with `{ minBufferTime: 500, maxBufferTime: 3000 }, you can still set `targetBufferTime` to 100 ms.`
1012
+ * The dynamic buffer will still work in respect to the originally set values when needed. Therefore we recommend
1013
+ * setting targetBufferTime within that range for consistancy if using both min/max.
1005
1014
  */
1006
1015
  set targetBufferTime(bufferTimeMs: number);
1007
1016
  /**