@vindral/web-sdk 2.0.14 → 2.0.18

package/index.d.ts

@@ -7,6 +7,7 @@ interface BaseCodedSample {
 	timescale: number;
 	duration: number;
 	data: ArrayBuffer;
+	compositionTimeOffset?: number;
 }
 interface CodedAudioSample extends BaseCodedSample {
 	type: "audio";
@@ -181,6 +182,7 @@ export interface PlaybackSource {
 	playbackRate?: number;
 	isActivated: boolean;
 	readonly seekTime: number;
+	readonly paused: boolean;
 	readonly isSeeking: boolean;
 	play(initiator: PlayInitiator): Promise<void>;
 }
@@ -189,6 +191,7 @@ interface MediaElementOptions {
 	muted: boolean;
 	type: "audio" | "video";
 	logger: Logger;
+	poster?: string;
 }
 interface NeedsUserInputContext {
 	forAudio: boolean;
@@ -206,7 +209,7 @@ declare class MediaElement extends Emitter<MediaElementEvents> {
 	private _userProvidedMuted;
 	private _userHasProvidedInput;
 	isActivated: boolean;
-	constructor({ type, autoplay, muted, logger }: MediaElementOptions);
+	constructor({ type, autoplay, muted, logger, poster }: MediaElementOptions);
 	attach: (container: HTMLElement) => void;
 	get seekTime(): number;
 	get isSeeking(): boolean;
@@ -281,6 +284,7 @@ declare class PlaybackModule {
 }
 declare type Direction = "upgrade" | "downgrade" | "double downgrade" | "reconnect";
 interface QualityOfServiceConfig {
+	cooldownTime: number;
 	maxBufferingEvents: {
 		last10Seconds: number;
 		last30Seconds: number;
@@ -300,6 +304,9 @@ interface QualityOfServiceConfig {
 interface AdaptivityEvents {
 	["adapt level"]: Readonly<Direction>;
 }
+interface AdaptivityStatistics {
+	isAbrEnabled: boolean;
+}
 interface QualityOfServiceSource {
 	getMetrics(): Metrics;
 	getLevelStats(level: RenditionLevel): PerLevelStats | undefined;
@@ -317,7 +324,6 @@ declare class AdaptivityModule {
 	private logger;
 	private isSuspended;
 	private lastAdaptTime;
-	private cooldownTime;
 	isEnabled: boolean;
 	constructor(emitter: Emitter<AdaptivityEvents>, logger: Logger, qualityOfServiceSource: QualityOfServiceSource, config: Partial<QualityOfServiceConfig>);
 	static create: (emitter: Emitter<AdaptivityEvents>, logger: Logger, qualityOfServiceSource: QualityOfServiceSource, config?: Partial<QualityOfServiceConfig>) => AdaptivityModule;
@@ -326,6 +332,7 @@ declare class AdaptivityModule {
 	suspend: () => void;
 	unsuspend: () => void;
 	reset: () => void;
+	getStatistics: () => AdaptivityStatistics;
 	isQoSOk: (renditionLevel: RenditionLevel) => boolean;
 	private onBufferState;
 	private onAdaptedLevel;
@@ -368,6 +375,7 @@ declare class AudioPlayerModule {
 	get isSeeking(): boolean;
 	get muted(): boolean;
 	set muted(muted: boolean);
+	get paused(): boolean;
 	get currentTime(): number;
 	set currentTime(currentTime: number);
 	constructor(emitter: Emitter<AudioPlayerModuleListeners, AudioPlayerModuleEvents>, logger: Logger, clockSource: ClockSource, muted: boolean);
@@ -441,6 +449,7 @@ interface ConnectionStatistics {
 	estimatedBandwidth: number;
 	edgeUrl?: string;
 	connectCount: number;
+	connectionAttemptCount: number;
 }
 declare class ConnectionModule {
 	private static PING_INTERVAL;
@@ -480,7 +489,7 @@ declare class ConnectionModule {
 	private onTransportChange;
 	disconnect: (reason?: string) => void;
 	reconnect: (reason: string) => void;
-	private cleanupOnDisconnect;
+	private cleanupPingIntervals;
 	private sendPing;
 }
 interface Size {
@@ -803,6 +812,9 @@ interface MseModuleListeners {
 	["init segment"]: Readonly<InitSegment>;
 	["coded sample"]: Readonly<CodedSample>;
 }
+interface MseModuleStatistics {
+	quotaErrorCount: number;
+}
 declare class MseModule {
 	private logger;
 	private timers;
@@ -814,9 +826,11 @@ declare class MseModule {
 	private autoRecoverFromMediaErrors;
 	private pendingSamples;
 	private isWorkingOnPendingSamples;
+	private quotaErrorCount;
 	constructor(logger: Logger, emitter: Emitter<MseModuleListeners, MseModuleEvents>, mediaElement: HTMLMediaElement, tracks: Track[]);
 	static create: (logger: Logger, emitter: Emitter<MseModuleListeners, MseModuleEvents>, mediaElement: HTMLMediaElement, tracks: Track[]) => Promise<MseModule>;
 	unload: () => void;
+	getStatistics: () => MseModuleStatistics;
 	private open;
 	getBuffer: (type: Type) => TimeRange[];
 	init: (initSegment: Readonly<InitSegment>) => void;
@@ -868,6 +882,7 @@ interface QualityOfServiceModuleStatistics {
 	};
 }
 declare class QualityOfServiceModule {
+	private readonly minBufferFullnessLengthForRegression;
 	private logger;
 	private emitter;
 	private timers;
@@ -923,12 +938,14 @@ declare class SubscriptionModule {
 	private currentSubscription;
 	private _isSwitchingSubscription;
 	private pendingSubscriptionTimeoutId?;
+	private burstMs;
 	private constructor();
 	unload: () => void;
 	static create: (logger: Logger, emitter: Emitter<SubscriptionModuleListeners>, subscription: Subscription) => SubscriptionModule;
 	isSwitchingSubscription: () => boolean;
 	getTargetSubscription: () => Subscription;
 	getCurrentSubscription: () => Subscription;
+	enableBurst: (bufferTimeMs: number) => void;
 	setSize: (size: Readonly<Size>) => void;
 	setVideoConstraint: (constraint: VideoConstraint) => void;
 	setAudioConstraint: (constraint: AudioConstraint) => void;
@@ -938,6 +955,7 @@ declare class SubscriptionModule {
 	setLanguage: (language: string | undefined) => void;
 	setVideoCodec: (videoCodec: VideoCodec | undefined) => void;
 	setAudioCodec: (audioCodec: AudioCodec | undefined) => void;
+	private setBurst;
 	private onSubscriptionChanged;
 	private scheduleSubscriptionChange;
 }
@@ -964,8 +982,9 @@ interface BufferSource {
 interface SyncModuleStatistics {
 	drift: number | undefined;
 	driftAdjustmentCount: number;
-	playbackRateAdjustmentCount: number;
+	timeshiftDriftAdjustmentCount: number;
 	discardedTimeInfoCount: number;
+	seekTime: number;
 }
 declare class SyncModule {
 	private emitter;
@@ -973,25 +992,29 @@ declare class SyncModule {
 	private playbackSource;
 	private bufferSource;
 	private lastSeekTime;
-	readonly seekCooldownTime = 5000;
+	readonly seekCooldownTime = 1000;
+	readonly seekTimeoutTime = 5000;
 	readonly syncMaxBehind: number;
 	readonly syncMaxBehindMultiplierStep = 1;
-	readonly syncMaxBehindIncreaseEvery = 5;
-	readonly syncMaxBehindMaximumAllowed = 1000;
+	readonly syncMaxBehindIncreaseEvery = 3;
+	readonly syncMaxBehindMaximumAllowed = 2000;
 	syncMaxBehindMultiplier: number;
 	readonly syncMaxAhead = 150;
-	readonly playbackRateSyncConstants: {
-		readonly enabled: true;
-		readonly maxBehind: 1000;
-		readonly catchupRate: 1.05;
-		readonly slowdownRate: 0.95;
+	timeshiftSync: {
+		enabled: boolean;
+		maxBehind: number;
+		multiplier: number;
+		maxBehindAllowed: number;
+		overshoot: number;
+		minOvershootAllowed: number;
+		maxOvershootAllowed: number;
 	};
-	readonly maxTimeSyncDifferenceTolerance = 20;
+	readonly maxTimeSyncDifferenceTolerance = 150;
 	private timers;
 	private rtt;
 	private channelSyncInfo;
 	private driftAdjustmentsCount;
-	private playbackRateAdjustmentCount;
+	private timeshiftDriftAdjustmentCount;
 	private timestampOffset?;
 	private currentChannelId?;
 	private highestSeenTimestamps;
@@ -1004,34 +1027,38 @@ declare class SyncModule {
 	suspend: () => void;
 	unsuspend: () => void;
 	activateSyncAdjustments: () => void;
-	static create: (emitter: Emitter<SyncModuleListeners, SyncModuleEvents>, logger: Logger, playbackSource: PlaybackSource, bufferSource: BufferSource, syncMaxBehind: number) => SyncModule;
+	static create: (emitter: Emitter<SyncModuleListeners, SyncModuleEvents>, logger: Logger, playbackSource: PlaybackSource, bufferSource: BufferSource, isTimeshiftSyncEnabled: boolean) => SyncModule;
 	reset: () => void;
 	getTimeshiftOffset: () => number;
 	getCurrentChannelId: () => string | undefined;
 	updateChannelSyncInfo(channelId: string, syncInfo: SyncInfo): void;
+	private tryApplySyncInfo;
 	getLiveEdgeTime: (channelId: string) => number | undefined;
 	getLiveEdgeTimeLatencyAdjusted: (channelId: string) => number | undefined;
 	getWallclockTime: (channelId: string) => number | undefined;
 	getWallclockTimeLatencyAdjusted: (channelId: string) => number | undefined;
 	get serverCurrentTime(): number;
+	get channelCurrentTime(): number;
 	processSample: <T extends SyncSample>(sample: T) => T;
 	getStatistics: () => SyncModuleStatistics;
 	get drift(): number | undefined;
 	private updateRtt;
 	isPlaybackSourceReadyToSeek: () => boolean;
+	private isSeeking;
 	private isAllowedToSync;
 	private isSeekCooldownExpired;
+	private isSeekTimeoutExpired;
+	private currentTimeshiftMaxBehind;
 	private currentSyncMaxBehind;
+	private currentSyncMaxAhead;
+	private tryTimeshiftSync;
 	private onSync;
-	playbackRateSync: (drift: number, playbackRate: number) => [
-		boolean,
-		number
-	];
 }
 declare const defaultOptions: {
 	sizeBasedResolutionCapEnabled: boolean;
 	pictureInPictureEnabled: boolean;
 	abrEnabled: boolean;
+	burstEnabled: boolean;
 	mseEnabled: boolean;
 	mseOpusEnabled: boolean;
 	muted: boolean;
@@ -1043,6 +1070,7 @@ declare const defaultOptions: {
 	maxAudioBitRate: number;
 	tags: string[];
 	media: Media;
+	posterEnabled: boolean;
 	reconnectHandler: (state: ReconnectState) => Promise<boolean> | boolean;
 	advanced: {
 		wasmDecodingConstraint: Partial<VideoConstraint>;
@@ -1117,6 +1145,7 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
 	get serverEdgeTime(): number | undefined;
 	get serverWallclockTime(): number | undefined;
 	get currentTime(): number;
+	get channelCurrentTime(): number;
 	get targetBufferTime(): number;
 	set targetBufferTime(bufferTimeMs: number);
 	get playbackLatency(): number | undefined;
@@ -1145,6 +1174,7 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
 	get timeSpentBuffering(): number;
 	get timeActive(): number;
 	getOptions: () => Options & typeof defaultOptions;
+	getThumbnailUrl: () => string;
 	updateAuthenticationToken: (token: string) => void;
 	connect: () => void;
 	getCastOptions: () => Options;
@@ -1203,6 +1233,7 @@ declare class TelemetryModule {
 	private unsentLines;
 	private retries;
 	private errorCount;
+	private statsCount;
 	private constructor();
 	unload: () => void;
 	static create: (logger: Logger, emitter: Emitter<TelemetryModuleListeners, unknown>, options: TelemetryModuleOptions, statisticsSource: TelemetryStatisticsSource) => TelemetryModule;
@@ -1306,12 +1337,14 @@ export interface Options {
 	maxBufferTime?: number;
 	sizeBasedResolutionCapEnabled?: boolean;
 	pictureInPictureEnabled?: boolean;
+	burstEnabled?: boolean;
 	mseEnabled?: boolean;
 	mseOpusEnabled?: boolean;
 	abrEnabled?: boolean;
 	maxSize?: Size;
 	maxAudioBitRate?: number;
 	maxVideoBitRate?: number;
+	posterEnabled?: boolean;
 	muted?: boolean;
 	reconnectHandler?: (state: ReconnectState) => Promise<boolean> | boolean;
 	tags?: string[];
@@ -1372,12 +1405,16 @@ interface AudioRenditionProps {
 	channels: number;
 	sampleRate: number;
 }
+interface CodecProps {
+	codec: Codec;
+	codecString?: string;
+}
 export declare type VideoRendition = VideoRenditionProps & RenditionProps;
 export declare type AudioRendition = AudioRenditionProps & RenditionProps;
 export declare type Rendition = VideoRendition | AudioRendition;
 export declare const isVideoRendition: (rendition: Readonly<Rendition>) => rendition is VideoRendition;
 export declare const isAudioRendition: (rendition: Readonly<Rendition>) => rendition is AudioRendition;
-export declare const getMimeType: (rendition: Readonly<Rendition>) => string;
+export declare const getMimeType: (rendition: Readonly<CodecProps>) => string;
 interface AudioConstraint {
 	bitRate: number;
 	codec?: AudioCodec;
@@ -1396,6 +1433,7 @@ interface Subscription {
 	channelId: string;
 	video: VideoConstraint;
 	audio: AudioConstraint;
+	burstMs?: number;
 	meta?: Record<string, string>;
 	initiator?: SubscriptionInitiator;
 }
@@ -1531,6 +1569,7 @@ export declare class CastSender extends Emitter<CastSenderEvents> {
 	init: () => Promise<void>;
 	start: () => Promise<void>;
 	stop: () => void;
+	getReceiverName: () => string | undefined;
 	private onGCastApiAvailable;
 	private send;
 	private onMessage;
@@ -1538,7 +1577,6 @@ export declare class CastSender extends Emitter<CastSenderEvents> {
 	private onSessionStateChanged;
 	private getInstance;
 	private getSession;
-	private getReceiverName;
 	private castLibrariesAdded;
 	private verifyCastLibraries;
 }

package/package.json

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