@vindral/web-sdk 2.0.9 → 2.0.13

package/README.md

@@ -60,10 +60,10 @@ This example attaches a player to an element with the id `#root`. The player wil
 
 The example assumes that there is a html page that loads this script that has at least a div with `id="#root"`.
 
-```typescript
+```javascript
 import { Player } from "@vindral/web-sdk"
 
-const root = document.querySelector<HTMLElement>("#root")
+const root = document.querySelector("#root")
 
 const player = new Player({
   url: "https://lb.cdn.vindral.com",
@@ -85,12 +85,12 @@ The Core SDK is the lowest level method to integrate that provides only a video
 
 The example assumes that there is a html page that loads this script that has at least a div with `id="#root"`, `id="#playback-state"` and a button with `id="#activate-audio-button"`.
 
-```typescript
+```javascript
 import { Vindral } from "@vindral/web-sdk"
 
-const root = document.querySelector<HTMLElement>("#root")!
-const button = document.querySelector<HTMLElement>("#activate-audio-button")!
-const playbackState = document.querySelector<HTMLElement>("#playback-state")!
+const root = document.querySelector("#root")!
+const button = document.querySelector("#activate-audio-button")!
+const playbackState = document.querySelector("#playback-state")!
 
 button.style.display = "none"
 

package/index.d.ts

@@ -173,6 +173,64 @@ declare class LoggerInstance implements Logger {
 	error: (message: string, meta?: Meta | undefined) => void;
 	critical: (message: string, meta?: Meta | undefined) => void;
 }
+export declare type PlayInitiator = "user input" | "programatically";
+export interface PlaybackSource {
+	volume: number;
+	muted: boolean;
+	currentTime: number;
+	playbackRate?: number;
+	isActivated: boolean;
+	readonly seekTime: number;
+	readonly isSeeking: boolean;
+	play(initiator: PlayInitiator): Promise<void>;
+}
+interface MediaElementOptions {
+	autoplay: boolean;
+	muted: boolean;
+	type: "audio" | "video";
+	logger: Logger;
+}
+interface NeedsUserInputContext {
+	forAudio: boolean;
+	forVideo: boolean;
+}
+interface MediaElementEvents {
+	["needs user input"]: NeedsUserInputContext;
+	["buffer state"]: Readonly<BufferState>;
+}
+declare class MediaElement extends Emitter<MediaElementEvents> {
+	readonly element: HTMLMediaElement;
+	private logger;
+	private seekTimes;
+	private seekStartTime?;
+	private _userProvidedMuted;
+	private _userHasProvidedInput;
+	isActivated: boolean;
+	constructor({ type, autoplay, muted, logger }: MediaElementOptions);
+	attach: (container: HTMLElement) => void;
+	get seekTime(): number;
+	get isSeeking(): boolean;
+	get currentTime(): number;
+	set currentTime(value: number);
+	get playbackRate(): number;
+	set playbackRate(rate: number);
+	get volume(): number;
+	set volume(volume: number);
+	get muted(): boolean;
+	set muted(muted: boolean);
+	get userHasProvidedInput(): boolean;
+	get paused(): boolean;
+	getPlaybackRate: () => number;
+	getPlaybackState: () => PlaybackState;
+	setPlaybackRate: (rate: number) => void;
+	getBuffer: () => TimeRange[];
+	play: (initiator: PlayInitiator) => Promise<void>;
+	private _play;
+	private onEvent;
+	private onBufferStateChange;
+	private onSeekStart;
+	private onSeekEnd;
+}
 declare type PlaybackState = "buffering" | "playing";
 declare type BufferStateEvent = "filled" | "drained";
 declare type BufferState = {
@@ -182,6 +240,7 @@ declare type BufferState = {
 };
 interface PlaybackModuleListeners {
 	["buffer state"]: Readonly<BufferState>;
+	["needs user input"]: NeedsUserInputContext;
 }
 interface PlaybackModuleEvents {
 	["buffer state event"]: Readonly<BufferStateEvent>;
@@ -193,6 +252,8 @@ interface ClockSource {
 }
 interface PlaybackModuleStatistics {
 	bufferTime: number;
+	needsInputForAudioCount: number;
+	needsInputForVideoCount: number;
 }
 declare class PlaybackModule {
 	private emitter;
@@ -203,6 +264,8 @@ declare class PlaybackModule {
 	private targetBufferTime;
 	private lastBufferStateEvent;
 	private firstFrameTime?;
+	private needsInputForAudioCount;
+	private needsInputForVideoCount;
 	constructor(emitter: Emitter<PlaybackModuleListeners, PlaybackModuleEvents>, logger: Logger, clockSource: ClockSource, targetBufferTime: number);
 	static create: (emitter: Emitter<PlaybackModuleListeners, PlaybackModuleEvents>, logger: Logger, clockSource: ClockSource, targetBufferTime: number) => PlaybackModule;
 	unload: () => void;
@@ -214,6 +277,7 @@ declare class PlaybackModule {
 	getFirstFrameTime: () => number | undefined;
 	getStatistics: () => PlaybackModuleStatistics;
 	private onBufferedStateChanged;
+	private onNeedsUserInput;
 }
 declare type Direction = "upgrade" | "downgrade" | "double downgrade" | "reconnect";
 interface QualityOfServiceConfig {
@@ -269,10 +333,6 @@ declare class AdaptivityModule {
 	private tooMuchTimeBuffering;
 	private tooManyBufferingEvents;
 }
-interface NeedsUserInputContext {
-	forAudio: boolean;
-	forVideo: boolean;
-}
 interface AudioPlayerModuleListeners {
 	["decoded frame"]: Readonly<DecodedSample>;
 }
@@ -300,6 +360,8 @@ declare class AudioPlayerModule {
 	private clockSource;
 	private clockDelta?;
 	private startTimeIsInvalidated;
+	private lastSampleTimestamp;
+	isActivated: boolean;
 	get volume(): number;
 	set volume(volume: number);
 	get seekTime(): number;
@@ -332,6 +394,8 @@ export declare const AUTHENTICATION_EXPIRED_CODE = "authentication_expired";
 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 MISSING_INIT_SEGMENT = "missing_init_segment";
+export declare const NO_TRACK_CONTEXT = "no_track_context";
 export declare class VindralError extends Error {
 	private props;
 	private extra;
@@ -342,6 +406,8 @@ export declare class VindralError extends Error {
 	toStringifiable: () => Record<string, unknown>;
 }
 export declare const mediaElementError: (isFatal: boolean, mediaError: MediaError) => VindralError;
+export declare const missingInitSegmentError: (renditionId: number, channelId: string) => VindralError;
+export declare const noTrackContextError: (type: "audio" | "video", renditionId: number, channelId: string) => VindralError;
 export declare const audioContextTimeoutError: () => VindralError;
 export declare const authenticationError: () => VindralError;
 export declare const authenticationExpiredError: () => VindralError;
@@ -351,9 +417,11 @@ export declare const noIncomingDataError: () => VindralError;
 export declare const unableToConnectError: (source?: Error | undefined) => VindralError;
 export declare const unableToConnectAfterRetriesError: () => VindralError;
 declare type State = "connected" | "disconnected" | "connecting";
+declare type ContextSwitchState = "completed" | "started";
 interface ConnectionModuleListeners {
 	["send signal"]: Readonly<string>;
 	["disconnect"]: void;
+	["reconnect"]: string;
 }
 interface ConnectionModuleEvents {
 	["received signal"]: Readonly<Signal>;
@@ -361,6 +429,8 @@ interface ConnectionModuleEvents {
 	["connection state"]: Readonly<State>;
 	["rtt"]: number;
 	["error"]: Readonly<VindralError>;
+	["context switch complete"]: Readonly<void>;
+	["context switch started"]: Readonly<void>;
 }
 interface ConnectOptions {
 	connectHandler: () => Promise<string>;
@@ -374,6 +444,7 @@ interface ConnectionStatistics {
 }
 declare class ConnectionModule {
 	private static PING_INTERVAL;
+	private static MAX_MISSED_PINGS;
 	private static TLS_ROUNDTRIPS;
 	private timers;
 	private emitter;
@@ -386,6 +457,7 @@ declare class ConnectionModule {
 	private connectCount;
 	private _firstConnectionTime?;
 	private _lastConnectionTime?;
+	private missedPings;
 	private contextSwitchesInProgress;
 	private contextSwitchesCompleted;
 	private buffer;
@@ -408,6 +480,7 @@ declare class ConnectionModule {
 	private onTransportChange;
 	disconnect: (reason?: string) => void;
 	reconnect: (reason: string) => void;
+	private cleanupOnDisconnect;
 	private sendPing;
 }
 interface Size {
@@ -482,6 +555,7 @@ declare class RenditionsModule {
 	setRenditions: (channelId: ChannelId, renditions: Rendition[]) => void;
 	getLanguages: () => ReadonlyArray<string>;
 	getVideoRendition: (renditionId: number, channelId?: string) => Readonly<VideoRendition> | undefined;
+	getAudioRenditions: (channelId: ChannelId) => Readonly<AudioRendition[]> | undefined;
 	getAudioRendition: (renditionId: number, channelId?: string) => Readonly<AudioRendition> | undefined;
 	getRendition: (renditionId: number, channelId?: string) => Readonly<Rendition> | undefined;
 	getStatistics: () => RenditionsModuleStatistics;
@@ -614,6 +688,10 @@ declare class DecoderModule {
 }
 type ConnectionType = "bluetooth" | "cellular" | "ethernet" | "mixed" | "none" | "other" | "unknown" | "wifi" | "wimax";
 type EffectiveConnectionType = "2g" | "3g" | "4g" | "slow-2g";
+interface DocumentState {
+	readonly isVisible: boolean;
+	readonly isOnline: boolean;
+}
 interface DocumentStateEvents {
 	["page active"]: boolean;
 	["pagehide"]: PageTransitionEvent;
@@ -631,7 +709,7 @@ interface DocumentStateModulesStatistics {
 	navigatorSaveData?: boolean;
 	navigatorDownlink?: number;
 }
-declare class DocumentStateModule {
+declare class DocumentStateModule implements DocumentState {
 	private emitter;
 	private isVisibleCount;
 	private isHiddenCount;
@@ -644,6 +722,8 @@ declare class DocumentStateModule {
 	load: () => void;
 	unsuspend: () => void;
 	getStatistics: () => DocumentStateModulesStatistics;
+	get isOnline(): boolean;
+	get isVisible(): boolean;
 	private onOnline;
 	private onOffline;
 	private onPageHide;
@@ -656,6 +736,7 @@ interface IncomingDataModuleListeners {
 }
 interface IncomingDataModuleEvents {
 	["no data timeout"]: number;
+	["reconnect"]: string;
 	["error"]: Readonly<VindralError>;
 }
 interface IncomingDataModuleStatistics {
@@ -699,16 +780,20 @@ interface MetadataModuleEvents {
 interface MetadataModuleListeners {
 	["buffer state"]: Readonly<BufferState>;
 }
+interface DriftSource {
+	readonly drift: number | undefined;
+}
 declare class MetadataModule {
 	private static METADATA_TIMEOUT;
 	private logger;
 	private emitter;
 	private waitingMetadata;
 	private isTriggered;
-	constructor(emitter: Emitter<MetadataModuleListeners, MetadataModuleEvents>, logger: Logger);
+	private driftSource;
+	constructor(emitter: Emitter<MetadataModuleListeners, MetadataModuleEvents>, logger: Logger, driftSource: DriftSource);
 	load: () => void;
 	unload: () => void;
-	static create: (emitter: Emitter<MetadataModuleListeners, MetadataModuleEvents>, logger: Logger) => MetadataModule;
+	static create: (emitter: Emitter<MetadataModuleListeners, MetadataModuleEvents>, logger: Logger, driftSource: DriftSource) => MetadataModule;
 	addMetadata: (metadata: Metadata) => void;
 	private onBufferedStateChanged;
 }
@@ -902,7 +987,7 @@ declare class SyncModule {
 		readonly catchupRate: 1.05;
 		readonly slowdownRate: 0.95;
 	};
-	readonly maxTimeSyncDifferenceTolerance = 150;
+	readonly maxTimeSyncDifferenceTolerance = 20;
 	private timers;
 	private rtt;
 	private channelSyncInfo;
@@ -926,7 +1011,9 @@ declare class SyncModule {
 	getCurrentChannelId: () => string | undefined;
 	updateChannelSyncInfo(channelId: string, syncInfo: SyncInfo): void;
 	getLiveEdgeTime: (channelId: string) => number | undefined;
+	getLiveEdgeTimeLatencyAdjusted: (channelId: string) => number | undefined;
 	getWallclockTime: (channelId: string) => number | undefined;
+	getWallclockTimeLatencyAdjusted: (channelId: string) => number | undefined;
 	get serverCurrentTime(): number;
 	processSample: <T extends SyncSample>(sample: T) => T;
 	getStatistics: () => SyncModuleStatistics;
@@ -990,6 +1077,7 @@ export declare type Statistics = ModuleStatistics & UserAgentInformation & {
 };
 export declare class Vindral extends Emitter<PublicVindralEvents> {
 	private static INITIAL_MAX_BIT_RATE;
+	private static PING_TIMEOUT;
 	readonly pictureInPicture: {
 		enter: () => Promise<void>;
 		exit: () => Promise<void>;
@@ -1009,6 +1097,7 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
 	private createdAt;
 	private hasCalledConnect;
 	private apiClient;
+	private latestEmittedLanguages;
 	private durationSessions;
 	constructor(options: Options);
 	attach: (container: HTMLElement) => void;
@@ -1022,6 +1111,8 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
 	get connectionState(): Readonly<State>;
 	get playbackState(): Readonly<PlaybackState>;
 	get bufferFullness(): number;
+	get sizeBasedResolutionCapEnabled(): boolean;
+	set sizeBasedResolutionCapEnabled(enabled: boolean);
 	get abrEnabled(): boolean;
 	set abrEnabled(enabled: boolean);
 	get serverEdgeTime(): number | undefined;
@@ -1039,12 +1130,10 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
 	set channelId(channelId: string);
 	get maxSize(): Size;
 	set maxSize(size: Size);
-	get maxBitRate(): number;
-	set maxBitRate(bitRate: number);
-	get maxVideoBitrate(): number;
-	set maxVideoBitrate(bitRate: number);
-	get maxAudioBitrate(): number;
-	set maxAudioBitrate(bitRate: number);
+	get maxVideoBitRate(): number;
+	set maxVideoBitRate(bitRate: number);
+	get maxAudioBitRate(): number;
+	set maxAudioBitRate(bitRate: number);
 	get renditionLevels(): ReadonlyArray<RenditionLevel>;
 	get currentRenditionLevel(): Readonly<RenditionLevel> | undefined;
 	get targetRenditionLevel(): Readonly<RenditionLevel> | undefined;
@@ -1061,7 +1150,9 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
 	connect: () => void;
 	getCastOptions: () => Options;
 	private connectionInfo;
+	private estimateRTT;
 	private connectHandler;
+	private emitLanguagesIfChanged;
 	private filterRenditions;
 	private patchSubscription;
 	private isSupportedVideoCodecProfile;
@@ -1136,6 +1227,16 @@ declare class TimerModule {
 	setInterval: (callback: (...args: unknown[]) => void, interval: number, ...args: unknown[]) => number;
 	unload: () => void;
 }
+declare class UnpauseModule {
+	private logger;
+	private element;
+	private documentState;
+	private timers;
+	private constructor();
+	static create: (logger: Logger, element: MediaElement, documentState: DocumentState) => UnpauseModule;
+	unload: () => void;
+	private unpause;
+}
 interface VideoPlayerModuleListeners {
 	["decoded frame"]: Readonly<DecodedSample>;
 }
@@ -1185,6 +1286,7 @@ export interface Modules {
 	telemetry?: TelemetryModule;
 	documentState: DocumentStateModule;
 	incomingData: IncomingDataModule;
+	unpause?: UnpauseModule;
 }
 export interface ReconnectState {
 	reconnectRetries: number;
@@ -1221,15 +1323,6 @@ export interface Options {
 	advanced?: AdvancedOptions;
 	media?: Media;
 }
-export interface PlaybackSource {
-	volume: number;
-	muted: boolean;
-	currentTime: number;
-	playbackRate?: number;
-	readonly seekTime: number;
-	readonly isSeeking: boolean;
-	play(): Promise<void>;
-}
 export interface PublicVindralEvents {
 	["error"]: Readonly<VindralError>;
 	["needs user input"]: NeedsUserInputContext;
@@ -1240,6 +1333,7 @@ export interface PublicVindralEvents {
 	["rendition level"]: Readonly<RenditionLevel>;
 	["languages"]: ReadonlyArray<string>;
 	["channels"]: ReadonlyArray<Channel>;
+	["context switch"]: Readonly<ContextSwitchState>;
 	["server wallclock time"]: Readonly<number>;
 	["buffer state event"]: Readonly<BufferStateEvent>;
 	["initialized media"]: void;
@@ -1472,12 +1566,22 @@ export interface PlayerOptions {
 	fullscreenButtonEnabled?: boolean;
 	pipButtonEnabled?: boolean;
 	channelSelectionEnabled?: boolean;
+	channelSelectionOptions?: {
+		barButton?: {
+			enabled?: boolean;
+			thumbnails?: boolean;
+		};
+		list?: {
+			enabled?: boolean;
+		};
+	};
 	renditionLevelsEnabled?: boolean;
 	languagesButtonEnabled?: boolean;
 	oneToOneButtonEnabled?: boolean;
 	hideTimeout?: number;
 	castBackground?: string;
 	castReceiverApplicationId?: string;
+	thumbnailUpdateInterval?: number;
 }
 export interface PlayerState {
 	isBuffering: boolean;
@@ -1492,9 +1596,11 @@ export declare class Player {
 	private playerElement;
 	private bufferingOverlay;
 	private playOverlay;
+	private channelSelectionList?;
 	private bar;
 	private stateInterval?;
 	private showBufferingTimeout?;
+	private thumbnailModule?;
 	constructor(optionsOrInstance: Options | Vindral, playerOptions?: PlayerOptions);
 	unload: () => void;
 	attach: (container: HTMLElement) => void;
@@ -1509,6 +1615,7 @@ export declare class Player {
 	private lockOrientation;
 	private unlockOrientation;
 	private checkState;
+	private needsThumbnails;
 	private bumpInteractTime;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vindral/web-sdk",
-  "version": "2.0.9",
+  "version": "2.0.13",
   "homepage": "https://vindral.com",
   "description": "Web SDK for viewing Vindral streams",
   "license": "SEE LICENSE IN https://www.vindral.com/terms-conditions",