@vindral/web-sdk 2.0.12 → 2.0.16

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

@@ -7,6 +7,7 @@ interface BaseCodedSample {
 	timescale: number;
 	duration: number;
 	data: ArrayBuffer;
+	compositionTimeOffset?: number;
 }
 interface CodedAudioSample extends BaseCodedSample {
 	type: "audio";
@@ -179,7 +180,9 @@ export interface PlaybackSource {
 	muted: boolean;
 	currentTime: number;
 	playbackRate?: number;
+	isActivated: boolean;
 	readonly seekTime: number;
+	readonly paused: boolean;
 	readonly isSeeking: boolean;
 	play(initiator: PlayInitiator): Promise<void>;
 }
@@ -204,6 +207,7 @@ declare class MediaElement extends Emitter<MediaElementEvents> {
 	private seekStartTime?;
 	private _userProvidedMuted;
 	private _userHasProvidedInput;
+	isActivated: boolean;
 	constructor({ type, autoplay, muted, logger }: MediaElementOptions);
 	attach: (container: HTMLElement) => void;
 	get seekTime(): number;
@@ -359,12 +363,14 @@ declare class AudioPlayerModule {
 	private clockDelta?;
 	private startTimeIsInvalidated;
 	private lastSampleTimestamp;
+	isActivated: boolean;
 	get volume(): number;
 	set volume(volume: number);
 	get seekTime(): number;
 	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);
@@ -477,6 +483,7 @@ declare class ConnectionModule {
 	private onTransportChange;
 	disconnect: (reason?: string) => void;
 	reconnect: (reason: string) => void;
+	private cleanupPingIntervals;
 	private sendPing;
 }
 interface Size {
@@ -724,7 +731,6 @@ declare class DocumentStateModule implements DocumentState {
 	private onOffline;
 	private onPageHide;
 	private onVisibilityChanged;
-	private onFocusChange;
 	private setIsActive;
 }
 interface IncomingDataModuleListeners {
@@ -773,19 +779,23 @@ declare class LoggerModule {
 interface MetadataModuleEvents {
 	["metadata"]: Readonly<Metadata>;
 }
-interface MetadataModuleListeners {
-	["buffer state"]: Readonly<BufferState>;
+interface TimeSource {
+	readonly drift: number | undefined;
+	readonly serverCurrentTime: number;
 }
 declare class MetadataModule {
 	private static METADATA_TIMEOUT;
+	private static METADATA_CHECK_INTERVAL;
 	private logger;
 	private emitter;
 	private waitingMetadata;
 	private isTriggered;
-	constructor(emitter: Emitter<MetadataModuleListeners, MetadataModuleEvents>, logger: Logger);
+	private timeSource;
+	private timers;
+	constructor(emitter: Emitter<unknown, MetadataModuleEvents>, logger: Logger, timeSource: TimeSource);
 	load: () => void;
 	unload: () => void;
-	static create: (emitter: Emitter<MetadataModuleListeners, MetadataModuleEvents>, logger: Logger) => MetadataModule;
+	static create: (emitter: Emitter<unknown, MetadataModuleEvents>, logger: Logger, timeSource: TimeSource) => MetadataModule;
 	addMetadata: (metadata: Metadata) => void;
 	private onBufferedStateChanged;
 }
@@ -916,12 +926,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;
@@ -931,6 +943,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;
 }
@@ -957,8 +970,9 @@ interface BufferSource {
 interface SyncModuleStatistics {
 	drift: number | undefined;
 	driftAdjustmentCount: number;
-	playbackRateAdjustmentCount: number;
+	timeshiftDriftAdjustmentCount: number;
 	discardedTimeInfoCount: number;
+	seekTime: number;
 }
 declare class SyncModule {
 	private emitter;
@@ -966,25 +980,29 @@ declare class SyncModule {
 	private playbackSource;
 	private bufferSource;
 	private lastSeekTime;
-	readonly seekCooldownTime = 5000;
+	readonly seekCooldownTime = 1000;
+	readonly seekTimeoutTime = 3000;
 	readonly syncMaxBehind: number;
 	readonly syncMaxBehindMultiplierStep = 1;
 	readonly syncMaxBehindIncreaseEvery = 5;
 	readonly syncMaxBehindMaximumAllowed = 1000;
 	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;
@@ -997,11 +1015,12 @@ 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;
@@ -1012,19 +1031,21 @@ declare class SyncModule {
 	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;
@@ -1299,6 +1320,7 @@ export interface Options {
 	maxBufferTime?: number;
 	sizeBasedResolutionCapEnabled?: boolean;
 	pictureInPictureEnabled?: boolean;
+	burstEnabled?: boolean;
 	mseEnabled?: boolean;
 	mseOpusEnabled?: boolean;
 	abrEnabled?: boolean;
@@ -1389,6 +1411,7 @@ interface Subscription {
 	channelId: string;
 	video: VideoConstraint;
 	audio: AudioConstraint;
+	burstMs?: number;
 	meta?: Record<string, string>;
 	initiator?: SubscriptionInitiator;
 }
@@ -1524,6 +1547,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;
@@ -1531,7 +1555,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.12",
+  "version": "2.0.16",
   "homepage": "https://vindral.com",
   "description": "Web SDK for viewing Vindral streams",
   "license": "SEE LICENSE IN https://www.vindral.com/terms-conditions",