@vindral/web-sdk 4.8.0 → 4.8.1-2-g3296bf22

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.
@@ -1,5 +1,5 @@
1
1
  import { n as e, t } from "./BsfwXDui.js";
2
- import { C as n, D as r, E as i, O as a, S as o, T as s, _ as c, b as l, g as u, h as d, k as f, m as ee, p as te, t as ne, v as re, w as ie, x as ae, y as oe } from "./Bf7Esc1M.js";
2
+ import { C as n, D as r, E as i, O as a, S as o, T as s, _ as c, b as l, g as u, h as d, k as f, m as ee, p as te, t as ne, v as re, w as ie, x as ae, y as oe } from "./B09bg-YN.js";
3
3
  import { t as se } from "./CuYn2z5X.js";
4
4
  import { i as p, n as m, r as h, t as g } from "./DSw1XhvD.js";
5
5
  import { c as ce, n as le, t as ue } from "./D40eQS8l.js";
package/api-client.d.ts CHANGED
@@ -219,7 +219,7 @@ export declare class ApiClient {
219
219
  * Fetches information regarding a single channel.
220
220
  *
221
221
  * @param channelId the channel to fetch
222
- * @returns a [[Channel]] containing information about the requested channel.
222
+ * @returns a {@link Channel} containing information about the requested channel.
223
223
  */
224
224
  getChannel(channelId: string): Promise<Channel>;
225
225
  /**
@@ -228,7 +228,7 @@ export declare class ApiClient {
228
228
  * Note: The returned list includes inactive channels - check isLive to filter out only active channels
229
229
  *
230
230
  * @param channelGroupId the channel group to fetch channels from
231
- * @returns an array of [[Channel]] that belong to the channel group
231
+ * @returns an array of {@link Channel} that belong to the channel group
232
232
  */
233
233
  getChannels(channelGroupId: string): Promise<Channel[]>;
234
234
  private getHeaders;
package/core.d.ts CHANGED
@@ -820,7 +820,7 @@ declare class ApiClient {
820
820
  * Fetches information regarding a single channel.
821
821
  *
822
822
  * @param channelId the channel to fetch
823
- * @returns a [[Channel]] containing information about the requested channel.
823
+ * @returns a {@link Channel} containing information about the requested channel.
824
824
  */
825
825
  getChannel(channelId: string): Promise<Channel>;
826
826
  /**
@@ -829,7 +829,7 @@ declare class ApiClient {
829
829
  * Note: The returned list includes inactive channels - check isLive to filter out only active channels
830
830
  *
831
831
  * @param channelGroupId the channel group to fetch channels from
832
- * @returns an array of [[Channel]] that belong to the channel group
832
+ * @returns an array of {@link Channel} that belong to the channel group
833
833
  */
834
834
  getChannels(channelGroupId: string): Promise<Channel[]>;
835
835
  private getHeaders;
@@ -1180,10 +1180,10 @@ export type Statistics = ModuleStatistics & ReturnType<UserAgentInformation["get
1180
1180
  *
1181
1181
  * - play() - connects and starts playing; call it from a user gesture to activate audio on browsers that require one
1182
1182
  * - attach() - to attach the Vindral video view to the DOM so that users can see it
1183
- * - unload() - unloads the instance, its very important that this is called when cleaning up the Vindral instance, otherwise background timers may leak.
1183
+ * - unload() - unloads the instance, it's very important that this is called when cleaning up the Vindral instance, otherwise background timers may leak.
1184
1184
  *
1185
- * The Vindral instance will emit a variety of events during its lifetime. Use .on("event-name", callback) to listen to these events.
1186
- * See [[PublicVindralEvents]] for the events types that can be emitted.
1185
+ * The Vindral instance will emit a variety of events during its lifetime. Use `.on("event-name", callback)` to listen to these events.
1186
+ * See {@link PublicVindralEvents} for the event types that can be emitted.
1187
1187
  *
1188
1188
  * ```typescript
1189
1189
  * // minimal configuration of a Vindral client instance
@@ -1455,7 +1455,7 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
1455
1455
  /**
1456
1456
  * Set the current channelId
1457
1457
  *
1458
- * Possible channels to set are available from [[channels]]
1458
+ * Possible channels to set are available from {@link channels}
1459
1459
  *
1460
1460
  * Note that the following scenarios are not possible right now:
1461
1461
  * - switching channel from a channel with audio to a channel without audio (unless audio only mode is active)
package/core.js CHANGED
@@ -1,2 +1,2 @@
1
- import { a as e, c as t, d as n, f as r, i, l as a, o, r as s, s as c, t as l, u } from "./Bf7Esc1M.js";
1
+ import { a as e, c as t, d as n, f as r, i, l as a, o, r as s, s as c, t as l, u } from "./B09bg-YN.js";
2
2
  export { s as AUTHENTICATION_EXPIRED_CODE, i as AUTHENTICATION_FAILED_CODE, e as CHANNEL_NOT_FOUND_CODE, o as CHANNEL_NOT_LIVE_CODE, c as CONNECTION_FAILED_AFTER_RETRIES_CODE, t as CONNECTION_FAILED_CODE, a as DISCONNECTED_BY_EDGE, u as INACTIVITY_CODE, n as NO_INCOMING_DATA, l as Vindral, r as VindralError };
package/legacy.d.ts CHANGED
@@ -835,7 +835,7 @@ export declare class ApiClient {
835
835
  * Fetches information regarding a single channel.
836
836
  *
837
837
  * @param channelId the channel to fetch
838
- * @returns a [[Channel]] containing information about the requested channel.
838
+ * @returns a {@link Channel} containing information about the requested channel.
839
839
  */
840
840
  getChannel(channelId: string): Promise<Channel>;
841
841
  /**
@@ -844,7 +844,7 @@ export declare class ApiClient {
844
844
  * Note: The returned list includes inactive channels - check isLive to filter out only active channels
845
845
  *
846
846
  * @param channelGroupId the channel group to fetch channels from
847
- * @returns an array of [[Channel]] that belong to the channel group
847
+ * @returns an array of {@link Channel} that belong to the channel group
848
848
  */
849
849
  getChannels(channelGroupId: string): Promise<Channel[]>;
850
850
  private getHeaders;
@@ -1195,10 +1195,10 @@ export type Statistics = ModuleStatistics & ReturnType<UserAgentInformation["get
1195
1195
  *
1196
1196
  * - play() - connects and starts playing; call it from a user gesture to activate audio on browsers that require one
1197
1197
  * - attach() - to attach the Vindral video view to the DOM so that users can see it
1198
- * - unload() - unloads the instance, its very important that this is called when cleaning up the Vindral instance, otherwise background timers may leak.
1198
+ * - unload() - unloads the instance, it's very important that this is called when cleaning up the Vindral instance, otherwise background timers may leak.
1199
1199
  *
1200
- * The Vindral instance will emit a variety of events during its lifetime. Use .on("event-name", callback) to listen to these events.
1201
- * See [[PublicVindralEvents]] for the events types that can be emitted.
1200
+ * The Vindral instance will emit a variety of events during its lifetime. Use `.on("event-name", callback)` to listen to these events.
1201
+ * See {@link PublicVindralEvents} for the event types that can be emitted.
1202
1202
  *
1203
1203
  * ```typescript
1204
1204
  * // minimal configuration of a Vindral client instance
@@ -1470,7 +1470,7 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
1470
1470
  /**
1471
1471
  * Set the current channelId
1472
1472
  *
1473
- * Possible channels to set are available from [[channels]]
1473
+ * Possible channels to set are available from {@link channels}
1474
1474
  *
1475
1475
  * Note that the following scenarios are not possible right now:
1476
1476
  * - switching channel from a channel with audio to a channel without audio (unless audio only mode is active)