@vindral/web-sdk 2.0.17 → 2.0.20

package/LICENSES

@@ -1,26 +1,25 @@
-libopus license
----------------
+## libopus license
 
 Copyright 2001-2011 Xiph.Org, Skype Limited, Octasic,
-                    Jean-Marc Valin, Timothy B. Terriberry,
-                    CSIRO, Gregory Maxwell, Mark Borgerding,
-                    Erik de Castro Lopo
+Jean-Marc Valin, Timothy B. Terriberry,
+CSIRO, Gregory Maxwell, Mark Borgerding,
+Erik de Castro Lopo
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 
 - Redistributions of source code must retain the above copyright
-notice, this list of conditions and the following disclaimer.
+  notice, this list of conditions and the following disclaimer.
 
 - Redistributions in binary form must reproduce the above copyright
-notice, this list of conditions and the following disclaimer in the
-documentation and/or other materials provided with the distribution.
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
 
 - Neither the name of Internet Society, IETF or IETF Trust, nor the
-names of specific contributors, may be used to endorse or promote
-products derived from this software without specific prior written
-permission.
+  names of specific contributors, may be used to endorse or promote
+  products derived from this software without specific prior written
+  permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
@@ -46,10 +45,7 @@ https://datatracker.ietf.org/ipr/1914/
 Broadcom Corporation:
 https://datatracker.ietf.org/ipr/1526/
 
-
-
-h264 license
-------------
+## h264 license
 
 Copyright (C) 2009 The Android Open Source Project
 
@@ -64,3 +60,28 @@ distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
+
+## nosleep license
+
+The MIT License (MIT)
+
+Copyright (c) Rich Tibbett
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/index.d.ts

@@ -27,6 +27,7 @@ interface DecodedSampleStatistics {
 	decodeTime: number;
 	transportTimeFromWorker: number;
 	transportTimeToWorker: number;
+	samplesInBatch: number;
 }
 interface DecodedVideoSample {
 	type: "video";
@@ -191,6 +192,7 @@ interface MediaElementOptions {
 	muted: boolean;
 	type: "audio" | "video";
 	logger: Logger;
+	poster?: string;
 }
 interface NeedsUserInputContext {
 	forAudio: boolean;
@@ -208,7 +210,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;
@@ -286,11 +288,9 @@ interface QualityOfServiceConfig {
 	cooldownTime: number;
 	maxBufferingEvents: {
 		last10Seconds: number;
-		last30Seconds: number;
 	};
 	maxBufferingRatio: {
 		last10Seconds: number;
-		last30Seconds: number;
 	};
 	maxRecentDowngradesCount: number;
 	maxDowngradeLookbackMs: number;
@@ -389,6 +389,51 @@ declare class AudioPlayerModule {
 	private getAudioContext;
 	private setGain;
 }
+interface BufferTimeConfig {
+	minBufferTime: number;
+	maxBufferTime: number;
+	cooldownTime: number;
+	maxBufferingEvents: {
+		last30Seconds: number;
+	};
+	maxBufferingRatio: {
+		last30Seconds: number;
+	};
+}
+interface BufferTimeListeners {
+	["buffer state"]: Readonly<BufferState>;
+}
+interface BufferTimeStatistics {
+	bufferTimeAdjustmentCount: number;
+}
+interface TargetBufferTimeTarget {
+	targetBufferTime: number;
+}
+interface QualityOfServiceSource {
+	bufferingEventsLast(last: number): number;
+	timeSpentBufferingLast(last: number): number;
+	timeSpentActiveLast(last: number): number;
+}
+declare class BufferTimeModule {
+	private static BUFFER_TIME_STEP_SIZE;
+	private qualityOfServiceSource;
+	private targetBufferTimeTarget;
+	private config;
+	private emitter;
+	private logger;
+	private isSuspended;
+	private lastIncreaseTime;
+	private bufferTimeAdjustmentCount;
+	constructor(emitter: Emitter<BufferTimeListeners, unknown>, logger: Logger, qualityOfServiceSource: QualityOfServiceSource, targetBufferTimeTarget: TargetBufferTimeTarget, config: Partial<BufferTimeConfig>);
+	static create: (emitter: Emitter<BufferTimeListeners, unknown>, logger: Logger, qualityOfServiceSource: QualityOfServiceSource, targetBufferTimeTarget: TargetBufferTimeTarget, config?: Partial<BufferTimeConfig>) => BufferTimeModule;
+	load: () => void;
+	unload: () => void;
+	suspend: () => void;
+	unsuspend: () => void;
+	reset: () => void;
+	getStatistics: () => BufferTimeStatistics;
+	private onBufferState;
+}
 interface VindralErrorProps {
 	isFatal: boolean;
 	code: string;
@@ -459,9 +504,9 @@ declare class ConnectionModule {
 	private transport?;
 	private logger;
 	private options;
-	private pingInterval?;
 	private rtts;
-	private lastPingSentTime?;
+	private lastPingSentTime;
+	private isPingInFlight;
 	private connectCount;
 	private _firstConnectionTime?;
 	private _lastConnectionTime?;
@@ -488,7 +533,8 @@ declare class ConnectionModule {
 	private onTransportChange;
 	disconnect: (reason?: string) => void;
 	reconnect: (reason: string) => void;
-	private cleanupPingIntervals;
+	private resetPingState;
+	private pingCooldownExpired;
 	private sendPing;
 }
 interface Size {
@@ -813,8 +859,11 @@ interface MseModuleListeners {
 }
 interface MseModuleStatistics {
 	quotaErrorCount: number;
+	totalVideoFrames?: number;
+	droppedVideoFrames?: number;
 }
 declare class MseModule {
+	private readonly maxChunkSize;
 	private logger;
 	private timers;
 	private emitter;
@@ -823,8 +872,6 @@ declare class MseModule {
 	private mediaSource;
 	private trackContexts;
 	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>;
@@ -833,9 +880,8 @@ declare class MseModule {
 	private open;
 	getBuffer: (type: Type) => TimeRange[];
 	init: (initSegment: Readonly<InitSegment>) => void;
-	append: (sample: Readonly<CodedSample>) => Promise<void>;
+	append: (samples: Readonly<CodedSample>[], needsInitSegment: boolean) => Promise<void>;
 	private onCodedSample;
-	private work;
 	private onSourceEnded;
 }
 interface PictureInPictureListeners {
@@ -906,6 +952,7 @@ declare class QualityOfServiceModule {
 	getBufferFullnessRegression: () => Regression | undefined;
 	activeRatios: () => Map<string, number>;
 	bufferingRatios: () => Map<string, number>;
+	bufferingEventsLast: (last: number) => number;
 	timeSpentBufferingLast: (last: number) => number;
 	timeSpentActiveLast: (last: number) => number;
 	timeSpentPlayingInAtLeastLevelRatio: (renditionLevel: RenditionLevel) => number;
@@ -955,6 +1002,7 @@ declare class SubscriptionModule {
 	setVideoCodec: (videoCodec: VideoCodec | undefined) => void;
 	setAudioCodec: (audioCodec: AudioCodec | undefined) => void;
 	private setBurst;
+	private isNewSubscription;
 	private onSubscriptionChanged;
 	private scheduleSubscriptionChange;
 }
@@ -1069,7 +1117,9 @@ declare const defaultOptions: {
 	maxAudioBitRate: number;
 	tags: string[];
 	media: Media;
+	poster: string | boolean;
 	reconnectHandler: (state: ReconnectState) => Promise<boolean> | boolean;
+	iosWakeLockEnabled: boolean;
 	advanced: {
 		wasmDecodingConstraint: Partial<VideoConstraint>;
 	};
@@ -1123,6 +1173,7 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
 	private hasCalledConnect;
 	private apiClient;
 	private latestEmittedLanguages;
+	private wakeLock;
 	private durationSessions;
 	constructor(options: Options);
 	attach: (container: HTMLElement) => void;
@@ -1171,7 +1222,9 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
 	get bufferingRatios(): Map<string, number>;
 	get timeSpentBuffering(): number;
 	get timeActive(): number;
+	get mediaElement(): HTMLMediaElement | HTMLCanvasElement;
 	getOptions: () => Options & typeof defaultOptions;
+	getThumbnailUrl: () => string;
 	updateAuthenticationToken: (token: string) => void;
 	connect: () => void;
 	getCastOptions: () => Options;
@@ -1272,6 +1325,7 @@ interface ClockSource {
 }
 interface VideoPlayerStatistics {
 	renderedFrameCount: number;
+	rendererDroppedFrameCount: number;
 }
 declare class VideoPlayerModule {
 	private logger;
@@ -1282,6 +1336,7 @@ declare class VideoPlayerModule {
 	private isFirstFrame;
 	private animationFrameRequest?;
 	private renderedFrameCount;
+	private rendererDroppedFrameCount;
 	constructor(emitter: Emitter<VideoPlayerModuleListeners, unknown>, logger: Logger, clockSource: ClockSource);
 	unload: () => Promise<void>;
 	suspend: () => void;
@@ -1313,6 +1368,7 @@ export interface Modules {
 	telemetry?: TelemetryModule;
 	documentState: DocumentStateModule;
 	incomingData: IncomingDataModule;
+	bufferTime: BufferTimeModule;
 	unpause?: UnpauseModule;
 }
 export interface ReconnectState {
@@ -1341,6 +1397,7 @@ export interface Options {
 	maxSize?: Size;
 	maxAudioBitRate?: number;
 	maxVideoBitRate?: number;
+	poster?: boolean | string;
 	muted?: boolean;
 	reconnectHandler?: (state: ReconnectState) => Promise<boolean> | boolean;
 	tags?: string[];
@@ -1348,6 +1405,7 @@ export interface Options {
 	edgeUrl?: string;
 	logShippingEnabled?: boolean;
 	statsShippingEnabled?: boolean;
+	iosWakeLockEnabled?: boolean;
 	advanced?: AdvancedOptions;
 	media?: Media;
 }

package/package.json

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