@vindral/web-sdk 3.2.0 → 3.2.2

package/README.md

@@ -40,13 +40,13 @@ Add the following HTML snippet, set `channelId` to channel id credential, and do
 
 Install @vindral/web-sdk using `npm`:
 
-```
+```bash
 npm install --save @vindral/web-sdk
 ```
 
 or `yarn`:
 
-```
+```bash
 yarn add @vindral/web-sdk
 ```
 
@@ -79,7 +79,7 @@ player.attach(root)
 
 Finally, import `@vindral/web-sdk/style.css` (or `./node_modules/@vindral/web-sdk/style.css` if that doesn't work) into your CSS. This step may differ depending on your build tools, some tools will allow you to import CSS directly in your js:
 
-```js
+```javascript
 import "@vindral/web-sdk/style.css"
 ```
 

package/index.d.ts

@@ -1,8 +1,8 @@
-declare type AudioCodec = "aac" | "opus" | "mp3";
-declare type VideoCodec = "h264" | "av1";
-declare type MatchingKeys<TRecord, TMatch, K extends keyof TRecord = keyof TRecord> = K extends (TRecord[K] extends TMatch ? K : never) ? K : never;
-declare type VoidKeys<Record> = MatchingKeys<Record, void>;
-declare type EventListenerReturnType = (() => void) | void;
+type AudioCodec = "aac" | "opus" | "mp3";
+type VideoCodec = "h264" | "av1";
+type MatchingKeys<TRecord, TMatch, K extends keyof TRecord = keyof TRecord> = K extends (TRecord[K] extends TMatch ? K : never) ? K : never;
+type VoidKeys<Record> = MatchingKeys<Record, void>;
+type EventListenerReturnType = (() => void) | void;
 declare class Emitter<TEvents, TEmits = TEvents, ArgLessEvents extends VoidKeys<TEvents> = VoidKeys<TEvents>, ArgEvents extends Exclude<keyof TEvents, ArgLessEvents> = Exclude<keyof TEvents, ArgLessEvents>, ArgLessEmits extends VoidKeys<TEmits> = VoidKeys<TEmits>, ArgEmits extends Exclude<keyof TEmits, ArgLessEmits> = Exclude<keyof TEmits, ArgLessEmits>> {
 	private listeners;
 	emit<T extends ArgLessEmits>(eventName: T): void;
@@ -63,9 +63,9 @@ interface AudioRenditionProps {
 	channels: number;
 	sampleRate: number;
 }
-declare type VideoRendition = VideoRenditionProps & RenditionProps;
-declare type AudioRendition = AudioRenditionProps & RenditionProps;
-declare type Rendition = VideoRendition | AudioRendition;
+type VideoRendition = VideoRenditionProps & RenditionProps;
+type AudioRendition = AudioRenditionProps & RenditionProps;
+type Rendition = VideoRendition | AudioRendition;
 interface Size {
 	width: number;
 	height: number;
@@ -158,7 +158,7 @@ export interface AuthorizationContext {
 /**
  * AuthorizationTokenFactory
  */
-export declare type AuthorizationTokenFactory = (context: AuthorizationContext) => string | undefined;
+export type AuthorizationTokenFactory = (context: AuthorizationContext) => string | undefined;
 /**
  * Convenience class to call the public available endpoints of the Vindral Live CDN.
  */
@@ -345,8 +345,8 @@ interface NeedsUserInputContext {
 	 */
 	forVideo: boolean;
 }
-declare type PlaybackState = "buffering" | "playing" | "paused";
-declare type BufferStateEvent = "filled" | "drained";
+type PlaybackState = "buffering" | "playing" | "paused";
+type BufferStateEvent = "filled" | "drained";
 interface PlaybackModuleStatistics {
 	/**
 	 * Current target buffer time if using dynamic buffer. Otherwise, this is the statically set buffer time from instantiation.
@@ -382,7 +382,7 @@ export declare const CHANNEL_NOT_FOUND_CODE = "channel_not_found";
 export declare const NO_INCOMING_DATA = "no_incoming_data_error";
 export declare const INACTIVITY_CODE = "connection_inactivity";
 export declare const DISCONNECTED_BY_EDGE = "disconnected_by_edge";
-declare type ErrorType = "internal" | "external";
+type ErrorType = "internal" | "external";
 /**
  * Represents a vindral error - all errors emitted from the Vindral instance inherit from this class.
  */
@@ -411,8 +411,8 @@ export declare class VindralError extends Error {
 	 */
 	toStringifiable: () => Record<string, unknown>;
 }
-declare type State = "connected" | "disconnected" | "connecting";
-declare type ContextSwitchState = "completed" | "started";
+type State = "connected" | "disconnected" | "connecting";
+type ContextSwitchState = "completed" | "started";
 interface ConnectionStatistics {
 	/**
 	 * RTT (round trip time) between client and server(s).
@@ -439,7 +439,7 @@ export interface RenditionLevel {
 	audio?: AudioRendition;
 	video?: VideoRendition;
 }
-declare type RenditionLevelChangedReason = "abr" | "manual";
+type RenditionLevelChangedReason = "abr" | "manual";
 /**
  * Contextual information about the rendition level change.
  */
@@ -448,10 +448,6 @@ export interface RenditionLevelChanged {
 	to?: RenditionLevel;
 	reason: RenditionLevelChangedReason;
 }
-interface RenditionLevel {
-	audio?: AudioRendition;
-	video?: VideoRendition;
-}
 interface RenditionsModuleStatistics {
 	/**
 	 * Id of current video rendition subscribed to.
@@ -527,6 +523,7 @@ interface DecoderStatistics {
 	audioDecodeTime: MinMaxAverage;
 	videoTransportTime: MinMaxAverage;
 }
+type ConnectionType = "bluetooth" | "cellular" | "ethernet" | "mixed" | "none" | "other" | "unknown" | "wifi" | "wimax";
 type EffectiveConnectionType = "2g" | "3g" | "4g" | "slow-2g";
 interface DocumentStateModulesStatistics {
 	isVisible: boolean;
@@ -628,7 +625,7 @@ declare class UserAgentInformation {
 		ua?: undefined;
 	};
 }
-declare type ModuleStatistics = AdaptivityStatistics & BufferTimeStatistics & ConnectionStatistics & ConstraintCapStatistics & DecoderStatistics & DocumentStateModulesStatistics & IncomingDataModuleStatistics & MseModuleStatistics & PlaybackModuleStatistics & QualityOfServiceModuleStatistics & RenditionsModuleStatistics & SyncModuleStatistics & TelemetryModuleStatistics & VideoPlayerStatistics;
+type ModuleStatistics = AdaptivityStatistics & BufferTimeStatistics & ConnectionStatistics & ConstraintCapStatistics & DecoderStatistics & DocumentStateModulesStatistics & IncomingDataModuleStatistics & MseModuleStatistics & PlaybackModuleStatistics & QualityOfServiceModuleStatistics & RenditionsModuleStatistics & SyncModuleStatistics & TelemetryModuleStatistics & VideoPlayerStatistics;
 /**
  * Contains internal statistics.
  *
@@ -637,7 +634,7 @@ declare type ModuleStatistics = AdaptivityStatistics & BufferTimeStatistics & Co
  *
  * @interface
  */
-export declare type Statistics = ModuleStatistics & ReturnType<UserAgentInformation["getUserAgentInformation"]> & {
+export type Statistics = ModuleStatistics & ReturnType<UserAgentInformation["getUserAgentInformation"]> & {
 	/**
 	 * Version of the @vindral/web-sdk being used.
 	 */
@@ -785,7 +782,7 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
 	 *
 	 * [Read more about it on Apple docs](https://developer.apple.com/library/archive/documentation/AudioVideo/Conceptual/Using_HTML5_Audio_Video/Device-SpecificConsiderations/Device-SpecificConsiderations.html)
 	 * for iOS-Specific Considerations. The following section is the important part:
-	 * ```On iOS devices, the audio level is always under the user's physical control. The volume property is not settable in JavaScript. Reading the volume property always returns 1.```
+	 * On iOS devices, the audio level is always under the user's physical control. The volume property is not settable in JavaScript. Reading the volume property always returns 1.
 	 */
 	set volume(volume: number);
 	/**
@@ -1107,7 +1104,7 @@ export interface AdvancedOptions {
 	 */
 	wasmDecodingConstraint: Partial<VideoConstraint>;
 }
-declare type Media = "audio" | "video" | "audio+video";
+type Media = "audio" | "video" | "audio+video";
 /**
  * Options for the Vindral instance
  *
@@ -1344,7 +1341,7 @@ export interface PublicVindralEvents {
 	/**
 	 * When the instance needs user input to activate audio or sometimes video playback.
 	 * Is called with an object
-	 * ```
+	 * ```javascript
 	 * {
 	 *   forAudio: boolean // true if user input is needed for audio playback
 	 *   forVideo: boolean // true if user input is needed for video playback