@vindral/web-sdk 4.3.3 → 4.4.0

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/core.d.ts CHANGED
@@ -1078,42 +1078,6 @@ export type Statistics = ModuleStatistics & ReturnType<UserAgentInformation["get
1078
1078
  */
1079
1079
  timeshiftAdjustmentsPerMinute: number;
1080
1080
  };
1081
- /**
1082
- * Represents a Vindral client instance
1083
- *
1084
- * The most most essential methods when using the Vindral class are:
1085
- *
1086
- * - connect() - this has to be called to actually start connecting
1087
- * - attach() - to attach the Vindral video view to the DOM so that users can see it
1088
- * - userInput() - to activate audio on browsers that require a user gesture to play audio
1089
- * - unload() - unloads the instance, its very important that this is called when cleaning up the Vindral instance, otherwise background timers may leak.
1090
- *
1091
- * The Vindral instance will emit a variety of events during its lifetime. Use .on("event-name", callback) to listen to these events.
1092
- * See [[PublicVindralEvents]] for the events types that can be emitted.
1093
- *
1094
- * ```typescript
1095
- * // minimal configuration of a Vindral client instance
1096
- * const instance = new Vindral({
1097
- * url: "https://lb.cdn.vindral.com",
1098
- * channelId: "vindral_demo1_ci_099ee1fa-80f3-455e-aa23-3d184e93e04f",
1099
- * })
1100
- *
1101
- * // Will be called when timed metadata is received
1102
- * instance.on("metadata", console.log)
1103
- *
1104
- * // Will be called when a user interaction is needed to activate audio
1105
- * instance.on("needs user input", console.log)
1106
- *
1107
- * // Start connecting to the cdn
1108
- * instance.connect()
1109
- *
1110
- * // Attach the video view to the DOM
1111
- * instance.attach(document.getElementById("root"))
1112
- *
1113
- * // When done with the instance
1114
- * instance.unload()
1115
- * ```
1116
- */
1117
1081
  export declare class Vindral extends Emitter<PublicVindralEvents> {
1118
1082
  #private;
1119
1083
  private static MAX_POOL_SIZE;
package/core.js CHANGED
@@ -1,3 +1,3 @@
1
- import { t as e } from "./_2aj2ylj.js";
1
+ import { t as e } from "./BMftV7tq.js";
2
2
  import { a as t, c as n, i as r, l as i, n as a, o, r as s, s as c, u as l } from "./C01DcfYu.js";
3
3
  export { a as AUTHENTICATION_EXPIRED_CODE, s as AUTHENTICATION_FAILED_CODE, r as CHANNEL_NOT_FOUND_CODE, t as CONNECTION_FAILED_AFTER_RETRIES_CODE, o as CONNECTION_FAILED_CODE, c as DISCONNECTED_BY_EDGE, n as INACTIVITY_CODE, i as NO_INCOMING_DATA, e as Vindral, l as VindralError };
package/legacy.d.ts CHANGED
@@ -1093,42 +1093,6 @@ export type Statistics = ModuleStatistics & ReturnType<UserAgentInformation["get
1093
1093
  */
1094
1094
  timeshiftAdjustmentsPerMinute: number;
1095
1095
  };
1096
- /**
1097
- * Represents a Vindral client instance
1098
- *
1099
- * The most most essential methods when using the Vindral class are:
1100
- *
1101
- * - connect() - this has to be called to actually start connecting
1102
- * - attach() - to attach the Vindral video view to the DOM so that users can see it
1103
- * - userInput() - to activate audio on browsers that require a user gesture to play audio
1104
- * - unload() - unloads the instance, its very important that this is called when cleaning up the Vindral instance, otherwise background timers may leak.
1105
- *
1106
- * The Vindral instance will emit a variety of events during its lifetime. Use .on("event-name", callback) to listen to these events.
1107
- * See [[PublicVindralEvents]] for the events types that can be emitted.
1108
- *
1109
- * ```typescript
1110
- * // minimal configuration of a Vindral client instance
1111
- * const instance = new Vindral({
1112
- * url: "https://lb.cdn.vindral.com",
1113
- * channelId: "vindral_demo1_ci_099ee1fa-80f3-455e-aa23-3d184e93e04f",
1114
- * })
1115
- *
1116
- * // Will be called when timed metadata is received
1117
- * instance.on("metadata", console.log)
1118
- *
1119
- * // Will be called when a user interaction is needed to activate audio
1120
- * instance.on("needs user input", console.log)
1121
- *
1122
- * // Start connecting to the cdn
1123
- * instance.connect()
1124
- *
1125
- * // Attach the video view to the DOM
1126
- * instance.attach(document.getElementById("root"))
1127
- *
1128
- * // When done with the instance
1129
- * instance.unload()
1130
- * ```
1131
- */
1132
1096
  export declare class Vindral extends Emitter<PublicVindralEvents> {
1133
1097
  #private;
1134
1098
  private static MAX_POOL_SIZE;