@vindral/web-sdk 4.7.2 → 4.8.0-2-g31d0f7c0

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/README.md CHANGED
@@ -78,10 +78,10 @@ Or use vindral-player-component.js is a self-registering variant of the web comp
78
78
  <script type="module" async src="https://cdn.jsdelivr.net/npm/@vindral/web-sdk/vindral-player-component.js"></script>
79
79
  ```
80
80
 
81
- Channel id is the only required attribute when using `<vindral-player />`.
81
+ `channel-id` is the only required attribute when using `<vindral-player />`.
82
82
 
83
83
  ```html
84
- <vindral-player channelId="vindral_demo1_ci_099ee1fa-80f3-455e-aa23-3d184e93e04f"></vindral-player>
84
+ <vindral-player channel-id="vindral_demo1_ci_099ee1fa-80f3-455e-aa23-3d184e93e04f"></vindral-player>
85
85
  ```
86
86
 
87
87
  Easy to customize controls with CSS variables.
@@ -1,7 +1,7 @@
1
1
  import { n as e, t } from "./BsfwXDui.js";
2
2
  import { i as n, n as r, r as i, t as a } from "./DSw1XhvD.js";
3
3
  import { t as o } from "./D1kpe8tT.js";
4
- import { C as s, S as c, b as l, i as u, r as ee, t as d, y as f } from "./BK-84KPi.js";
4
+ import { C as s, S as c, b as l, i as u, r as ee, t as d, y as f } from "./CoLAnqGB.js";
5
5
  import { t as p } from "./Tj9xPXja.js";
6
6
  //#region \0rolldown/runtime.js
7
7
  var m = Object.defineProperty, h = (e, t) => {
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/cast-sender.d.ts CHANGED
@@ -299,6 +299,9 @@ interface Options {
299
299
  * Note: the ReconnectState gets reset every time the client instance makes a successful connection.
300
300
  * This means the default reconnect handler will only stop reconnecting after 30 _consecutive_ failed connections.
301
301
  *
302
+ * While the page is hidden, a failure counts toward `reconnectRetries` only when the server answered: the channel
303
+ * is not live or not found, or the connect request got a 4xx other than 408 or 429. Retries back off up to 30 seconds.
304
+ *
302
305
  * ```typescript
303
306
  * // An example reconnect handler that will reconnect forever
304
307
  * const reconnectHandler = (state: ReconnectState) => true
package/core.d.ts CHANGED
@@ -114,6 +114,7 @@ declare class UserAgentInformation {
114
114
  ancestorOrigins: string[] | undefined;
115
115
  hardwareConcurrency: number;
116
116
  deviceMemory: number | undefined;
117
+ maxTouchPoints: number;
117
118
  userAgentLegacy: string;
118
119
  ua: {
119
120
  browser: {
@@ -122,6 +123,8 @@ declare class UserAgentInformation {
122
123
  majorVersions: string[];
123
124
  };
124
125
  device: string;
126
+ mobile: boolean | undefined;
127
+ formFactors: string[] | undefined;
125
128
  os: {
126
129
  family: string;
127
130
  version: string;
@@ -134,6 +137,7 @@ declare class UserAgentInformation {
134
137
  ancestorOrigins: string[] | undefined;
135
138
  hardwareConcurrency: number;
136
139
  deviceMemory: number | undefined;
140
+ maxTouchPoints: number;
137
141
  userAgent: string;
138
142
  };
139
143
  }
@@ -404,6 +408,9 @@ export interface Options {
404
408
  * Note: the ReconnectState gets reset every time the client instance makes a successful connection.
405
409
  * This means the default reconnect handler will only stop reconnecting after 30 _consecutive_ failed connections.
406
410
  *
411
+ * While the page is hidden, a failure counts toward `reconnectRetries` only when the server answered: the channel
412
+ * is not live or not found, or the connect request got a 4xx other than 408 or 429. Retries back off up to 30 seconds.
413
+ *
407
414
  * ```typescript
408
415
  * // An example reconnect handler that will reconnect forever
409
416
  * const reconnectHandler = (state: ReconnectState) => true
@@ -813,7 +820,7 @@ declare class ApiClient {
813
820
  * Fetches information regarding a single channel.
814
821
  *
815
822
  * @param channelId the channel to fetch
816
- * @returns a [[Channel]] containing information about the requested channel.
823
+ * @returns a {@link Channel} containing information about the requested channel.
817
824
  */
818
825
  getChannel(channelId: string): Promise<Channel>;
819
826
  /**
@@ -822,7 +829,7 @@ declare class ApiClient {
822
829
  * Note: The returned list includes inactive channels - check isLive to filter out only active channels
823
830
  *
824
831
  * @param channelGroupId the channel group to fetch channels from
825
- * @returns an array of [[Channel]] that belong to the channel group
832
+ * @returns an array of {@link Channel} that belong to the channel group
826
833
  */
827
834
  getChannels(channelGroupId: string): Promise<Channel[]>;
828
835
  private getHeaders;
@@ -831,6 +838,14 @@ declare class ApiClient {
831
838
  private toChannel;
832
839
  }
833
840
  type TransportSelectionReason = "unsupported" | "disabled" | "disabled_unstable_browser" | "unavailable" | "fallback";
841
+ interface DocumentStateModulesStatistics extends NavigatorConnectionStatistics {
842
+ isVisible: boolean;
843
+ isOnline: boolean;
844
+ isVisibleCount: number;
845
+ isHiddenCount: number;
846
+ isOnlineCount: number;
847
+ isOfflineCount: number;
848
+ }
834
849
  interface AdaptivityStatistics {
835
850
  /**
836
851
  * True if adaptive bitrate (ABR) is enabled.
@@ -926,14 +941,6 @@ interface DecoderStatistics {
926
941
  audioRenderer?: "AudioContext" | "MSE";
927
942
  audioDecoder?: "WebCodecs" | "WASM" | "MSE";
928
943
  }
929
- interface DocumentStateModulesStatistics extends NavigatorConnectionStatistics {
930
- isVisible: boolean;
931
- isOnline: boolean;
932
- isVisibleCount: number;
933
- isHiddenCount: number;
934
- isOnlineCount: number;
935
- isOfflineCount: number;
936
- }
937
944
  interface IncomingDataModuleStatistics {
938
945
  /**
939
946
  * Current video bitrate in bits/second.
@@ -1169,15 +1176,14 @@ export type Statistics = ModuleStatistics & ReturnType<UserAgentInformation["get
1169
1176
  /**
1170
1177
  * Represents a Vindral client instance
1171
1178
  *
1172
- * The most most essential methods when using the Vindral class are:
1179
+ * The most essential methods when using the Vindral class are:
1173
1180
  *
1174
- * - connect() - this has to be called to actually start connecting
1181
+ * - play() - connects and starts playing; call it from a user gesture to activate audio on browsers that require one
1175
1182
  * - attach() - to attach the Vindral video view to the DOM so that users can see it
1176
- * - userInput() - to activate audio on browsers that require a user gesture to play audio
1177
- * - 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.
1178
1184
  *
1179
- * The Vindral instance will emit a variety of events during its lifetime. Use .on("event-name", callback) to listen to these events.
1180
- * 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.
1181
1187
  *
1182
1188
  * ```typescript
1183
1189
  * // minimal configuration of a Vindral client instance
@@ -1192,8 +1198,8 @@ export type Statistics = ModuleStatistics & ReturnType<UserAgentInformation["get
1192
1198
  * // Will be called when a user interaction is needed to activate audio
1193
1199
  * instance.on("needs user input", console.log)
1194
1200
  *
1195
- * // Start connecting to the cdn
1196
- * instance.connect()
1201
+ * // Start connecting to the cdn and playing
1202
+ * instance.play()
1197
1203
  *
1198
1204
  * // Attach the video view to the DOM
1199
1205
  * instance.attach(document.getElementById("root"))
@@ -1251,6 +1257,8 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
1251
1257
  private offscreenCanvasElement?;
1252
1258
  private webCodecsRenditionSupport;
1253
1259
  private hasCalledConnect;
1260
+ /** The last upgrade check held, so the hold is logged once. */
1261
+ private upgradeHeld;
1254
1262
  private hasRequestedAudioSession;
1255
1263
  private isUserPaused;
1256
1264
  /** Only the sinks that carry the audio report this, so a paused element here means silence. */
@@ -1447,7 +1455,7 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
1447
1455
  /**
1448
1456
  * Set the current channelId
1449
1457
  *
1450
- * Possible channels to set are available from [[channels]]
1458
+ * Possible channels to set are available from {@link channels}
1451
1459
  *
1452
1460
  * Note that the following scenarios are not possible right now:
1453
1461
  * - switching channel from a channel with audio to a channel without audio (unless audio only mode is active)
@@ -1565,10 +1573,18 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
1565
1573
  */
1566
1574
  getCastOptions: () => Options;
1567
1575
  private onConnectInfo;
1576
+ /**
1577
+ * A recovery reconnect: the current level didn't fit the link. Rejoin at the lowest level and let ABR climb back,
1578
+ * since another backlog or stall costs more than a few seconds at low quality.
1579
+ */
1580
+ private lowerTargetForRejoin;
1581
+ private onPingTimeout;
1568
1582
  private emitLanguagesIfChanged;
1569
1583
  private updateTextTracks;
1570
1584
  private cleanupTextTracks;
1571
1585
  private filterRenditions;
1586
+ /** The buffer lags behind the link: no upgrade while it queues, or while it is still unknown on a new connection. */
1587
+ private linkHoldsUpgrade;
1572
1588
  /** Whether the bandwidth leaves room for a join burst of the video and audio the player starts at. */
1573
1589
  private burstFits;
1574
1590
  /**
@@ -1742,6 +1758,13 @@ interface ConnectionStatistics {
1742
1758
  * Total number of connections that have been established since instantiation.
1743
1759
  */
1744
1760
  connectCount: number;
1761
+ /**
1762
+ * Connections closed since instantiation because media queued too long between the edge and this client: the
1763
+ * link-queue breaker on vindral_ws and moq_ws, or missed pings on vindral_ws while its link queue is unknown. With ABR
1764
+ * on, the reconnect targets the lowest level, unless the player is already there, switching channel or on an
1765
+ * audio-only ladder.
1766
+ */
1767
+ backlogReconnectCount: number;
1745
1768
  /**
1746
1769
  * Total number of connection attempts since instantiation.
1747
1770
  */
@@ -1769,6 +1792,12 @@ interface ConnectionStatistics {
1769
1792
  * Unset while reconnecting; once disconnected, the last connection's.
1770
1793
  */
1771
1794
  transportSelectionReason: TransportSelectionReason | undefined;
1795
+ /**
1796
+ * Media queued between the edge and this client over the last 30 seconds, in milliseconds, measured from the edge's
1797
+ * periodic timing info (vindral_ws) or stats (moq_ws). `last` is the current level. Unset while unknown and on
1798
+ * WebTransport. Arrival is read on the main thread, so a busy main thread (WASM decode, a heavy page) also counts.
1799
+ */
1800
+ linkQueue?: MinMaxAverage;
1772
1801
  }
1773
1802
  /**
1774
1803
  * Contextual information about the language switch
@@ -1784,7 +1813,7 @@ export interface LanguageSwitchContext {
1784
1813
  */
1785
1814
  export interface ChannelSwitchContext {
1786
1815
  /**
1787
- * The new channel id that was switched to
1816
+ * The new channel on "channel switch", the current channel on "channel switch failed"
1788
1817
  */
1789
1818
  channelId: string;
1790
1819
  }
@@ -1892,12 +1921,12 @@ export interface PublicVindralEvents {
1892
1921
  "is live": boolean;
1893
1922
  /**
1894
1923
  * Emitted when a channel switch has been completed and the first frame of the new channel is rendered.
1895
- * A string containing the channel id of the new channel is provided as an argument.
1924
+ * The argument holds the channel id of the new channel.
1896
1925
  */
1897
1926
  "channel switch": Readonly<ChannelSwitchContext>;
1898
1927
  /**
1899
- * Emmitted when a channel switch fails.
1900
- * A string containing the channel id of the current channel is provided as an argument.
1928
+ * Emitted when a channel switch fails.
1929
+ * The argument holds the channel id of the current channel.
1901
1930
  */
1902
1931
  "channel switch failed": Readonly<ChannelSwitchContext>;
1903
1932
  /**
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 "./BqvCHW1b.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 "./C9eQS1Qa.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
@@ -117,6 +117,7 @@ declare class UserAgentInformation {
117
117
  ancestorOrigins: string[] | undefined;
118
118
  hardwareConcurrency: number;
119
119
  deviceMemory: number | undefined;
120
+ maxTouchPoints: number;
120
121
  userAgentLegacy: string;
121
122
  ua: {
122
123
  browser: {
@@ -125,6 +126,8 @@ declare class UserAgentInformation {
125
126
  majorVersions: string[];
126
127
  };
127
128
  device: string;
129
+ mobile: boolean | undefined;
130
+ formFactors: string[] | undefined;
128
131
  os: {
129
132
  family: string;
130
133
  version: string;
@@ -137,6 +140,7 @@ declare class UserAgentInformation {
137
140
  ancestorOrigins: string[] | undefined;
138
141
  hardwareConcurrency: number;
139
142
  deviceMemory: number | undefined;
143
+ maxTouchPoints: number;
140
144
  userAgent: string;
141
145
  };
142
146
  }
@@ -407,6 +411,9 @@ export interface Options {
407
411
  * Note: the ReconnectState gets reset every time the client instance makes a successful connection.
408
412
  * This means the default reconnect handler will only stop reconnecting after 30 _consecutive_ failed connections.
409
413
  *
414
+ * While the page is hidden, a failure counts toward `reconnectRetries` only when the server answered: the channel
415
+ * is not live or not found, or the connect request got a 4xx other than 408 or 429. Retries back off up to 30 seconds.
416
+ *
410
417
  * ```typescript
411
418
  * // An example reconnect handler that will reconnect forever
412
419
  * const reconnectHandler = (state: ReconnectState) => true
@@ -828,7 +835,7 @@ export declare class ApiClient {
828
835
  * Fetches information regarding a single channel.
829
836
  *
830
837
  * @param channelId the channel to fetch
831
- * @returns a [[Channel]] containing information about the requested channel.
838
+ * @returns a {@link Channel} containing information about the requested channel.
832
839
  */
833
840
  getChannel(channelId: string): Promise<Channel>;
834
841
  /**
@@ -837,7 +844,7 @@ export declare class ApiClient {
837
844
  * Note: The returned list includes inactive channels - check isLive to filter out only active channels
838
845
  *
839
846
  * @param channelGroupId the channel group to fetch channels from
840
- * @returns an array of [[Channel]] that belong to the channel group
847
+ * @returns an array of {@link Channel} that belong to the channel group
841
848
  */
842
849
  getChannels(channelGroupId: string): Promise<Channel[]>;
843
850
  private getHeaders;
@@ -846,6 +853,14 @@ export declare class ApiClient {
846
853
  private toChannel;
847
854
  }
848
855
  type TransportSelectionReason = "unsupported" | "disabled" | "disabled_unstable_browser" | "unavailable" | "fallback";
856
+ interface DocumentStateModulesStatistics extends NavigatorConnectionStatistics {
857
+ isVisible: boolean;
858
+ isOnline: boolean;
859
+ isVisibleCount: number;
860
+ isHiddenCount: number;
861
+ isOnlineCount: number;
862
+ isOfflineCount: number;
863
+ }
849
864
  interface AdaptivityStatistics {
850
865
  /**
851
866
  * True if adaptive bitrate (ABR) is enabled.
@@ -941,14 +956,6 @@ interface DecoderStatistics {
941
956
  audioRenderer?: "AudioContext" | "MSE";
942
957
  audioDecoder?: "WebCodecs" | "WASM" | "MSE";
943
958
  }
944
- interface DocumentStateModulesStatistics extends NavigatorConnectionStatistics {
945
- isVisible: boolean;
946
- isOnline: boolean;
947
- isVisibleCount: number;
948
- isHiddenCount: number;
949
- isOnlineCount: number;
950
- isOfflineCount: number;
951
- }
952
959
  interface IncomingDataModuleStatistics {
953
960
  /**
954
961
  * Current video bitrate in bits/second.
@@ -1184,15 +1191,14 @@ export type Statistics = ModuleStatistics & ReturnType<UserAgentInformation["get
1184
1191
  /**
1185
1192
  * Represents a Vindral client instance
1186
1193
  *
1187
- * The most most essential methods when using the Vindral class are:
1194
+ * The most essential methods when using the Vindral class are:
1188
1195
  *
1189
- * - connect() - this has to be called to actually start connecting
1196
+ * - play() - connects and starts playing; call it from a user gesture to activate audio on browsers that require one
1190
1197
  * - attach() - to attach the Vindral video view to the DOM so that users can see it
1191
- * - userInput() - to activate audio on browsers that require a user gesture to play audio
1192
- * - 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.
1193
1199
  *
1194
- * The Vindral instance will emit a variety of events during its lifetime. Use .on("event-name", callback) to listen to these events.
1195
- * 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.
1196
1202
  *
1197
1203
  * ```typescript
1198
1204
  * // minimal configuration of a Vindral client instance
@@ -1207,8 +1213,8 @@ export type Statistics = ModuleStatistics & ReturnType<UserAgentInformation["get
1207
1213
  * // Will be called when a user interaction is needed to activate audio
1208
1214
  * instance.on("needs user input", console.log)
1209
1215
  *
1210
- * // Start connecting to the cdn
1211
- * instance.connect()
1216
+ * // Start connecting to the cdn and playing
1217
+ * instance.play()
1212
1218
  *
1213
1219
  * // Attach the video view to the DOM
1214
1220
  * instance.attach(document.getElementById("root"))
@@ -1266,6 +1272,8 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
1266
1272
  private offscreenCanvasElement?;
1267
1273
  private webCodecsRenditionSupport;
1268
1274
  private hasCalledConnect;
1275
+ /** The last upgrade check held, so the hold is logged once. */
1276
+ private upgradeHeld;
1269
1277
  private hasRequestedAudioSession;
1270
1278
  private isUserPaused;
1271
1279
  /** Only the sinks that carry the audio report this, so a paused element here means silence. */
@@ -1462,7 +1470,7 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
1462
1470
  /**
1463
1471
  * Set the current channelId
1464
1472
  *
1465
- * Possible channels to set are available from [[channels]]
1473
+ * Possible channels to set are available from {@link channels}
1466
1474
  *
1467
1475
  * Note that the following scenarios are not possible right now:
1468
1476
  * - switching channel from a channel with audio to a channel without audio (unless audio only mode is active)
@@ -1580,10 +1588,18 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
1580
1588
  */
1581
1589
  getCastOptions: () => Options;
1582
1590
  private onConnectInfo;
1591
+ /**
1592
+ * A recovery reconnect: the current level didn't fit the link. Rejoin at the lowest level and let ABR climb back,
1593
+ * since another backlog or stall costs more than a few seconds at low quality.
1594
+ */
1595
+ private lowerTargetForRejoin;
1596
+ private onPingTimeout;
1583
1597
  private emitLanguagesIfChanged;
1584
1598
  private updateTextTracks;
1585
1599
  private cleanupTextTracks;
1586
1600
  private filterRenditions;
1601
+ /** The buffer lags behind the link: no upgrade while it queues, or while it is still unknown on a new connection. */
1602
+ private linkHoldsUpgrade;
1587
1603
  /** Whether the bandwidth leaves room for a join burst of the video and audio the player starts at. */
1588
1604
  private burstFits;
1589
1605
  /**
@@ -1757,6 +1773,13 @@ interface ConnectionStatistics {
1757
1773
  * Total number of connections that have been established since instantiation.
1758
1774
  */
1759
1775
  connectCount: number;
1776
+ /**
1777
+ * Connections closed since instantiation because media queued too long between the edge and this client: the
1778
+ * link-queue breaker on vindral_ws and moq_ws, or missed pings on vindral_ws while its link queue is unknown. With ABR
1779
+ * on, the reconnect targets the lowest level, unless the player is already there, switching channel or on an
1780
+ * audio-only ladder.
1781
+ */
1782
+ backlogReconnectCount: number;
1760
1783
  /**
1761
1784
  * Total number of connection attempts since instantiation.
1762
1785
  */
@@ -1784,6 +1807,12 @@ interface ConnectionStatistics {
1784
1807
  * Unset while reconnecting; once disconnected, the last connection's.
1785
1808
  */
1786
1809
  transportSelectionReason: TransportSelectionReason | undefined;
1810
+ /**
1811
+ * Media queued between the edge and this client over the last 30 seconds, in milliseconds, measured from the edge's
1812
+ * periodic timing info (vindral_ws) or stats (moq_ws). `last` is the current level. Unset while unknown and on
1813
+ * WebTransport. Arrival is read on the main thread, so a busy main thread (WASM decode, a heavy page) also counts.
1814
+ */
1815
+ linkQueue?: MinMaxAverage;
1787
1816
  }
1788
1817
  /**
1789
1818
  * Contextual information about the language switch
@@ -1799,7 +1828,7 @@ export interface LanguageSwitchContext {
1799
1828
  */
1800
1829
  export interface ChannelSwitchContext {
1801
1830
  /**
1802
- * The new channel id that was switched to
1831
+ * The new channel on "channel switch", the current channel on "channel switch failed"
1803
1832
  */
1804
1833
  channelId: string;
1805
1834
  }
@@ -1907,12 +1936,12 @@ export interface PublicVindralEvents {
1907
1936
  "is live": boolean;
1908
1937
  /**
1909
1938
  * Emitted when a channel switch has been completed and the first frame of the new channel is rendered.
1910
- * A string containing the channel id of the new channel is provided as an argument.
1939
+ * The argument holds the channel id of the new channel.
1911
1940
  */
1912
1941
  "channel switch": Readonly<ChannelSwitchContext>;
1913
1942
  /**
1914
- * Emmitted when a channel switch fails.
1915
- * A string containing the channel id of the current channel is provided as an argument.
1943
+ * Emitted when a channel switch fails.
1944
+ * The argument holds the channel id of the current channel.
1916
1945
  */
1917
1946
  "channel switch failed": Readonly<ChannelSwitchContext>;
1918
1947
  /**