bitmovin-analytics 2.32.4 → 2.33.0

package/README.md

@@ -72,12 +72,12 @@ player.loadSource('https://path.to/your/stream.m3u8');
 player.attachMedia(document.getElementById('video'));
 ```
 
-Before changing the video source in the player, you need to call `sourceChange()` on the assotiated analytics adapter. You can pass new configuration properties to this method like `videoId` or `videoTitle`
+Before changing the video source in the player, you need to call `sourceChange()` on the associated analytics adapter. You can pass new configuration properties to this method like `videoId` or `videoTitle`
 
 ```js
 analytics.sourceChange({
-  videoID: 'new-video-id',
-  videoTitle: 'New Video',
+  videoId: 'new-video-id',
+  title: 'New Video',
 });
 
 // Load the new source into player

package/bitmovin-analytics.d.ts

@@ -1,5 +1,3 @@
-
-
 declare const VERSION: string;
 export interface AnalyticsDebugConfig {
 	fields?: string[];
@@ -91,6 +89,9 @@ export interface CustomDataValues {
 	customData30?: string;
 	experimentName?: string;
 }
+/**
+ * Minimal set of shared methods among all collectors
+ */
 export interface AdapterAPI {
 	getCurrentImpressionId: () => string | undefined;
 	getUserId: () => string | undefined;
@@ -275,7 +276,7 @@ export interface ErrorData {
 export interface AnalyticsEventBase {
 	currentTime?: number;
 }
-export interface ErrorEvent extends AnalyticsEventBase {
+interface ErrorEvent$1 extends AnalyticsEventBase {
 	code: number | undefined;
 	message: string | undefined;
 	legacyData?: any;
@@ -360,11 +361,12 @@ export interface Sample extends CustomDataValues {
 	videoWindowHeight?: number;
 	videoWindowWidth?: number;
 }
+export type HeartbeatPayload = Pick<Sample, "played"> | Pick<Sample, "buffered"> | Pick<Sample, "paused">;
 export interface StateMachineCallbacks {
 	setup: (duration: number, state: string) => void;
 	startup: (duration: number, state: string) => void;
 	playing: (duration: number, state: string) => void;
-	heartbeat: (duration: number, state: string, payload: Pick<Sample, "played"> | Pick<Sample, "buffered">) => void;
+	heartbeat: (duration: number, state: string, payload: HeartbeatPayload) => void;
 	qualitychange: (duration: number, state: string) => void;
 	qualitychange_pause: (duration: number, state: string) => void;
 	qualitychange_rebuffering: (duration: number, state: string) => void;
@@ -375,15 +377,15 @@ export interface StateMachineCallbacks {
 	paused_seeking: (duration: number, state: string) => void;
 	end_play_seeking: (duration: number, state: string) => void;
 	rebuffering: (duration: number, state: string) => void;
-	error: (event: Readonly<ErrorEvent>) => void;
+	error: (event: Readonly<ErrorEvent$1>) => void;
 	end: (duration: number, state: string) => void;
 	unload: (duration: number, state: string) => void;
 	ad: (duration: number, state: string) => void;
 	mute: () => void;
 	unMute: () => void;
 	subtitle_changing: () => void;
-	setVideoTimeEndFromEvent: (event: any) => void;
-	setVideoTimeStartFromEvent: (event: any) => void;
+	setVideoTimeEndFromEvent: (event: AnalyticsEventBase | any) => void;
+	setVideoTimeStartFromEvent: (event: AnalyticsEventBase | any) => void;
 	videoStartFailed: (event: Readonly<VideoStartFailedEvent>, sendRequest: boolean) => void;
 	source_changing: (duration: number, state: string, event: any) => void;
 	startCasting: (duration: number, event: any) => void;
@@ -569,7 +571,7 @@ declare abstract class Adapter {
 	sourceChange(config: AnalyticsConfig): void;
 	protected hasPlayerAlreadyBeenAugmented(player: any): boolean;
 	protected markPlayerInstanceAsAugmented(player: any): void;
-	private guardAgainstNotInitializedAnalytics;
+	protected guardAgainstNotInitializedAnalytics(): boolean;
 }
 export declare class AmazonIVSAdapter extends Adapter implements AdapterAPI {
 	constructor(config: AnalyticsConfig, player: any, opts?: AnalyticsStateMachineOptions);
@@ -577,6 +579,9 @@ export declare class AmazonIVSAdapter extends Adapter implements AdapterAPI {
 }
 export declare class Bitmovin8Adapter extends Adapter implements AdapterAPI {
 	constructor(player: any, opts?: AnalyticsStateMachineOptions);
+	/**
+	 * intercept `player.load` with automated sourceChange handling
+	 */
 	private wrapPlayerLoad;
 }
 export declare class CAFv3Adapter extends Adapter implements AdapterAPI {
@@ -585,12 +590,28 @@ export declare class CAFv3Adapter extends Adapter implements AdapterAPI {
 export declare class DashjsAdapter extends Adapter implements AdapterAPI {
 	constructor(config: AnalyticsConfig, player: any, opts?: AnalyticsStateMachineOptions);
 }
-export declare class HTMLVideoElementAdapter extends Adapter implements AdapterAPI {
-	constructor(config: AnalyticsConfig, player: HTMLVideoElement, opts?: AnalyticsStateMachineOptions);
-}
 export declare class HlsAdapter extends Adapter implements AdapterAPI {
 	constructor(config: AnalyticsConfig, player: any, opts?: AnalyticsStateMachineOptions);
 }
+export declare class HTMLVideoElementAdapter extends Adapter implements AdapterAPI {
+	constructor(config: AnalyticsConfig, player: HTMLVideoElement, opts?: AnalyticsStateMachineOptions, sourceMetadata?: {
+		streamFormat?: string;
+		audioCodec?: string;
+		videoCodec?: string;
+		audioLanguage?: string;
+	});
+	get sessionMetadata(): {
+		readonly setAudioLanguage: (audioLanguage: string) => void;
+		readonly setSubtitleEnabled: (enabled: boolean) => void;
+		readonly setSubtitleLanguage: (subtitleLanguage: string) => void;
+	};
+	sourceChange(config: AnalyticsConfig, sourceMetadata?: {
+		streamFormat?: string;
+		audioCodec?: string;
+		videoCodec?: string;
+		audioLanguage?: string;
+	}): void;
+}
 export declare class ShakaAdapter extends Adapter implements AdapterAPI {
 	constructor(config: AnalyticsConfig, player: any, opts?: AnalyticsStateMachineOptions);
 	private wrapPlayerLoad;
@@ -660,4 +681,3 @@ export {
 	_default as default,
 };
 
-export {};