bitmovin-analytics 2.31.2 → 2.32.1

package/bitmovin-analytics.d.ts

@@ -7,10 +7,13 @@ export interface CollectorConfig {
 	enabled?: boolean;
 	cookiesEnabled?: boolean;
 	cookiesDomain?: string;
+	cookiesMaxAge?: number;
 	origin?: string;
 }
 export interface AnalyticsConfig {
 	debug?: boolean | AnalyticsDebugConfig;
+	deviceType?: string;
+	deviceClass?: "Console" | "Desktop" | "Phone" | "STB" | "TV" | "Tablet" | "Wearable" | "Other";
 	key?: string;
 	playerKey?: string;
 	player?: string;
@@ -280,76 +283,80 @@ export interface VideoStartFailedEvent extends AnalyticsEventBase {
 	reason: VideoStartFailedReason;
 }
 export interface Sample extends CustomDataValues {
-	platform: string;
-	sequenceNumber?: number;
-	domain?: any;
-	path?: string;
-	language?: string;
-	userAgent?: string;
-	screenWidth?: number;
-	screenHeight?: number;
-	isLive?: boolean;
-	isCasting?: boolean;
-	castTech?: string;
-	videoDuration?: number;
-	size?: string;
-	time?: number;
-	videoWindowWidth?: number;
-	videoWindowHeight?: number;
-	droppedFrames?: number;
-	played?: number;
-	buffered?: number;
-	paused?: number;
 	ad?: number;
-	seeked?: number;
-	videoPlaybackWidth?: number;
-	videoPlaybackHeight?: number;
-	videoBitrate?: number;
+	analyticsVersion?: any;
 	audioBitrate?: number;
-	videoTimeStart?: number;
-	videoTimeEnd?: number;
-	videoStartupTime?: number;
+	audioCodec?: string;
+	audioLanguage?: string;
+	autoplay?: any;
+	buffered?: number;
+	castTech?: string;
+	cdnProvider?: any;
+	completed?: number;
+	completedTotal?: number;
+	customUserId?: string;
+	deviceInformation?: {
+		model?: string;
+		deviceClass?: string;
+	};
+	domain?: any;
+	downloadSpeedInfo?: DownloadSpeedInfo;
+	drmLoadTime?: number;
+	drmType?: string;
+	droppedFrames?: number;
 	duration?: number;
-	startupTime?: number;
-	analyticsVersion?: any;
-	playerStartupTime: number;
-	pageLoadType: number;
-	streamFormat?: string;
+	errorCode?: any;
+	errorData?: string;
+	errorMessage?: any;
+	errorSegments?: any[];
+	impressionId?: string;
+	isCasting?: boolean;
+	isLive?: boolean;
 	isMuted?: boolean;
-	progUrl?: string;
+	key?: string;
+	language?: string;
 	m3u8Url?: string;
 	mpdUrl?: string;
-	playerTech?: string;
-	version?: string;
+	pageLoadTime: number;
+	pageLoadType: number;
+	path?: string;
+	paused?: number;
+	platform: string;
+	played?: number;
 	player?: any;
+	playerKey?: any;
+	playerStartupTime: number;
+	playerTech?: string;
+	progUrl?: string;
+	screenHeight?: number;
+	screenWidth?: number;
+	seeked?: number;
+	sequenceNumber?: number;
+	size?: string;
+	startupTime?: number;
 	state?: string;
-	impressionId?: string;
+	streamFormat?: string;
+	subtitleEnabled?: boolean;
+	subtitleLanguage?: string;
+	supportedVideoCodecs?: string[];
+	time?: number;
+	userAgent?: string;
 	userId?: string;
-	errorMessage?: any;
-	errorCode?: any;
-	errorData?: string;
+	version?: string;
+	videoBitrate?: number;
+	videoCodec?: string;
+	videoDuration?: number;
+	videoId?: string;
+	videoPlaybackHeight?: number;
+	videoPlaybackWidth?: number;
 	videoStartFailed?: boolean;
 	videoStartFailedReason?: string;
-	autoplay?: any;
-	pageLoadTime: number;
-	key?: string;
-	playerKey?: any;
-	cdnProvider?: any;
-	videoId?: string;
+	videoStartupTime?: number;
+	videoTimeEnd?: number;
+	videoTimeStart?: number;
 	videoTitle?: string;
-	customUserId?: string;
-	drmType?: string;
-	drmLoadTime?: number;
-	subtitleEnabled?: boolean;
-	subtitleLanguage?: string;
-	downloadSpeedInfo?: DownloadSpeedInfo;
-	errorSegments?: any[];
-	audioCodec?: string;
-	videoCodec?: string;
-	supportedVideoCodecs?: string[];
-	audioLanguage?: string;
-	completed?: number;
-	completedTotal?: number;
+	videoWindowHeight?: number;
+	videoWindowWidth?: number;
 }
 export interface StateMachineCallbacks {
 	setup: (duration: number, state: string) => void;
@@ -459,15 +466,6 @@ export interface ErrorDetailTrackingSettingsProvider {
 	readonly impressionId: string;
 	readonly collectorConfig?: CollectorConfig;
 }
-export interface CastClientConfig {
-	config: any;
-	domain: any;
-	path: string;
-	language: string;
-	userAgent: string;
-	impressionId: string;
-	userId: string;
-}
 export interface Backend {
 	sendRequest(sample: Sample): any;
 	sendUnloadRequest(sample: Sample): any;
@@ -492,9 +490,12 @@ declare class BackendFactory {
 declare class Analytics {
 	get version(): string;
 	static version: string;
-	static LICENSE_CALL_PENDING_TIMEOUT: number;
-	static PAGE_LOAD_TYPE_TIMEOUT: number;
-	static CAST_RECEIVER_CONFIG_MESSAGE: string;
+	private readonly sessionHandler;
+	private readonly adapter;
+	private readonly backendFactory;
+	private readonly featureManager;
+	private readonly onErrorDetailEventDispatcher;
+	private readonly adAnalytics;
 	pageLoadTime: number;
 	playerStartupTime: number;
 	videoStartupTime: number;
@@ -502,28 +503,20 @@ declare class Analytics {
 	sample: Sample;
 	backend: Backend;
 	errorDetailTrackingSettingsProvider: ErrorDetailTrackingSettingsProvider;
-	get errorDetailSubscribable(): Subscribable<OnErrorDetailEventObject>;
 	private config;
-	private sessionHandler;
 	private droppedSampleFrames;
 	private startupTime;
-	private adapter;
-	private backendFactory;
-	private featureManager;
-	private onErrorDetailEventDispatcher;
-	private adAnalytics;
 	private authenticationCallback;
 	constructor(config: AnalyticsConfig, adapter: InternalAdapterAPI, backendFactory?: BackendFactory);
+	get errorDetailSubscribable(): Subscribable<OnErrorDetailEventObject>;
 	getPlayerInformationFromAdapter(): {
 		player: string;
 		version: string;
 		playerTech: string;
 	};
-	updateSamplesToCastClientConfig(samples: Sample[], castClientConfig: CastClientConfig): void;
-	updateSampleToCastClientConfig(sample: Sample, castClientConfig: CastClientConfig): void;
 	init(): void;
 	release(): void;
-	setConfigParameters(sample?: Sample, config?: AnalyticsConfig): void;
+	setConfigParameters(): void;
 	generateNewImpressionId(): void;
 	setUserId(): void;
 	setupStateMachineCallbacks(): void;