bitmovin-analytics 2.29.4 → 2.30.0

package/README.md

@@ -1,6 +1,6 @@
 # Bitmovin Analytics Collector
 
-[![CircleCI](https://dl.circleci.com/status-badge/img/gh/bitmovin-engineering/bitmovin-analytics-collector/tree/main.svg?style=shield&circle-token=e3ec1c4b9bcaf4bb4818dc6f234845f2807137cc)](https://dl.circleci.com/status-badge/redirect/gh/bitmovin-engineering/bitmovin-analytics-collector/tree/main)
+[![npm version](https://badge.fury.io/js/bitmovin-analytics.svg)](https://badge.fury.io/js/bitmovin-analytics)
 [![install size](https://packagephobia.com/badge?p=bitmovin-analytics)](https://packagephobia.com/result?p=bitmovin-analytics)
 
 Instruments adaptive streaming video players and collects information to be sent to the Bitmovin Analytics service.

package/bitmovin-analytics.d.ts

@@ -96,6 +96,24 @@ export interface AdapterAPI {
 export interface AnalyticsStateMachineOptions {
 	starttime: any;
 }
+declare class QualityChangeService {
+	private qualityChangeThreshold;
+	private qualityChangeCount;
+	private previousVideoBitrate;
+	private previousAudioBitrate;
+	private resetIntervalId?;
+	constructor(qualityChangeThreshold?: number);
+	resetValues(): void;
+	isQualityChangeEventEnabled(): boolean;
+	increaseCounter(): void;
+	shouldAllowVideoQualityChange(newBitrate: number | undefined): boolean;
+	setVideoBitrate(newBitrate: number): void;
+	shouldAllowAudioQualityChange(newBitrate: number | undefined): boolean;
+	setAudioBitrate(newBitrate: number): void;
+	startResetInterval(): void;
+	stopResetInterval(): void;
+	private resetCounter;
+}
 export interface Timespan {
 	start: number;
 	end: number;
@@ -416,9 +434,7 @@ export interface InternalAdapterAPI extends DeferredLicenseLoadingAdapterAPI {
 	readonly stateMachineCallbacks: StateMachineCallbacks;
 	readonly adModule?: AdModuleAPI;
 	readonly videoCompletionTracker?: VideoCompletionTracker;
-	isQualityChangeEventEnabled(): boolean;
-	increaseQualityChangeCount(): void;
-	resetQualityChangeCount(): void;
+	readonly qualityChangeService: QualityChangeService;
 	resetSourceRelatedState(): void;
 	getPlayerVersion(): string;
 	getPlayerName(): string;
@@ -493,7 +509,6 @@ declare class Analytics {
 	private startupTime;
 	private adapter;
 	private backendFactory;
-	private resetQualityChangeCountIntervalId?;
 	private featureManager;
 	private onErrorDetailEventDispatcher;
 	private adAnalytics;
@@ -547,7 +562,6 @@ declare class Analytics {
 	private setVideoTimeStart;
 	private setVideoTimeEnd;
 	private sendQualityChange;
-	private clearResetQualityChangeInterval;
 }
 declare abstract class Adapter {
 	protected analytics: Analytics;
@@ -561,6 +575,10 @@ declare abstract class Adapter {
 	protected markPlayerInstanceAsAugmented(player: any): void;
 	private guardAgainstNotInitializedAnalytics;
 }
+export declare class AmazonIVSAdapter extends Adapter implements AdapterAPI {
+	constructor(config: AnalyticsConfig, player: any, opts?: AnalyticsStateMachineOptions);
+	private wrapPlayerLoad;
+}
 export declare class Bitmovin8Adapter extends Adapter implements AdapterAPI {
 	constructor(player: any, opts?: AnalyticsStateMachineOptions);
 	private wrapPlayerLoad;
@@ -580,7 +598,6 @@ export declare class HlsAdapter extends Adapter implements AdapterAPI {
 export declare class ShakaAdapter extends Adapter implements AdapterAPI {
 	constructor(config: AnalyticsConfig, player: any, opts?: AnalyticsStateMachineOptions);
 	private wrapPlayerLoad;
-	private sendError;
 }
 export declare class VideojsAdapter extends Adapter implements AdapterAPI {
 	constructor(config: AnalyticsConfig, player: any, opts?: AnalyticsStateMachineOptions);
@@ -606,38 +623,41 @@ declare enum Player {
 	CHROMECAST_SHAKA = "chromecast-shaka",
 	AMAZON_IVS = "amazonivs"
 }
-declare const AnalyticsPlayerModule: {
-	name: string;
-	module: {
-		Analytics: typeof Bitmovin8Adapter;
+/**
+ * @see https://github.com/bitmovin-engineering/bitdash/blob/ccd3227dac82d1416a471711b40ee0f65d7f9ddb/src/ModuleDefinition.ts#L17
+ */
+export declare const PlayerModule: {
+	readonly name: "analytics";
+	readonly module: {
+		readonly Analytics: typeof Bitmovin8Adapter;
 	};
-	hooks: {
-		setup: (module: any, player: any) => Promise<any>;
+	readonly hooks: {
+		readonly setup: (module: any, player: any) => Promise<any>;
 	};
 };
 export declare const adapters: {
-	HlsAdapter: typeof HlsAdapter;
+	AmazonIVSAdapter: typeof AmazonIVSAdapter;
 	Bitmovin8Adapter: typeof Bitmovin8Adapter;
-	VideojsAdapter: typeof VideojsAdapter;
-	ShakaAdapter: typeof ShakaAdapter;
-	DashjsAdapter: typeof DashjsAdapter;
 	CAFv3Adapter: typeof CAFv3Adapter;
+	DashjsAdapter: typeof DashjsAdapter;
 	HTMLVideoElementAdapter: typeof HTMLVideoElementAdapter;
+	HlsAdapter: typeof HlsAdapter;
+	ShakaAdapter: typeof ShakaAdapter;
+	VideojsAdapter: typeof VideojsAdapter;
 };
 declare const _default: {
 	PlayerModule: {
-		name: string;
-		module: {
-			Analytics: typeof Bitmovin8Adapter;
+		readonly name: "analytics";
+		readonly module: {
+			readonly Analytics: typeof Bitmovin8Adapter;
 		};
-		hooks: {
-			setup: (module: any, player: any) => Promise<any>;
+		readonly hooks: {
+			readonly setup: (module: any, player: any) => Promise<any>;
 		};
 	};
 };
 
 export {
-	AnalyticsPlayerModule as PlayerModule,
 	CdnProvider as CdnProviders,
 	Player as Players,
 	VERSION as version,