@vindral/web-sdk 4.1.2 → 4.1.3-1-g2e4861d2

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/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "4.1.2",
2
+ "version": "4.1.3-1-g2e4861d2",
3
3
  "name": "@vindral/web-sdk",
4
4
  "main": "./legacy.umd.js",
5
5
  "module": "./legacy.es.js",
package/player.d.ts CHANGED
@@ -995,11 +995,20 @@ declare class Vindral extends Emitter<PublicVindralEvents> {
995
995
  */
996
996
  get channelCurrentTime(): number;
997
997
  /**
998
- * The current target buffer time in milliseconds
998
+ * The current target buffer time in milliseconds.
999
+ *
1000
+ * Initially, this will always be equal to `minBufferTime`.
1001
+ * Only when using a separate `maxBufferTime`, the `targetBufferTime` will be able to vary between min and max.
1002
+ *
999
1003
  */
1000
1004
  get targetBufferTime(): number;
1001
1005
  /**
1002
- * Set the current target buffer time in milliseconds
1006
+ * Set the current target buffer time in milliseconds.
1007
+ *
1008
+ * Note that setting this will not respect min/max buffer time values.
1009
+ * For instance with `{ minBufferTime: 500, maxBufferTime: 3000 }, you can still set `targetBufferTime` to 100 ms.`
1010
+ * The dynamic buffer will still work in respect to the originally set values when needed. Therefore we recommend
1011
+ * setting targetBufferTime within that range for consistancy if using both min/max.
1003
1012
  */
1004
1013
  set targetBufferTime(bufferTimeMs: number);
1005
1014
  /**