bitmovin-analytics 2.34.1 → 2.36.0

package/bitmovin-analytics.d.ts

@@ -99,9 +99,196 @@ export interface AdapterAPI {
 	setCustomDataOnce: (values: CustomDataValues) => void;
 	sourceChange: (config: AnalyticsConfig) => void;
 }
+export interface SsaiAdMetadata {
+	adId?: string;
+	adSystem?: string;
+	customData?: CustomDataValues;
+}
+export interface SsaiAdBreakMetadata {
+	adPosition?: AdPosition;
+}
+export type AdPosition = "preroll" | "midroll" | "postroll";
+export interface SsaiApi {
+	adBreakStart(adBreakMetadata?: SsaiAdBreakMetadata): any;
+	adStart(adMetadata?: SsaiAdMetadata): any;
+	adBreakEnd(): any;
+}
 export interface AnalyticsStateMachineOptions {
 	starttime: any;
 }
+declare class ErrorCode {
+	readonly code: number;
+	readonly message: string;
+	static BITMOVIN_PLAYER_LICENSING_ERROR: ErrorCode;
+	static SETUP_MISSING_LICENSE_WHITELIST: ErrorCode;
+	static QUALITY_CHANGE_THRESHOLD_EXCEEDED: ErrorCode;
+	static BUFFERING_TIMEOUT_REACHED: ErrorCode;
+	static VIDEO_STARTUP_TIMEOUT_REACHED: ErrorCode;
+	private constructor();
+}
+declare class VideoStartFailedReason {
+	readonly reason: string;
+	readonly errorCode: ErrorCode | null;
+	static PAGE_CLOSED: VideoStartFailedReason;
+	static PLAYER_ERROR: VideoStartFailedReason;
+	static TIMEOUT: VideoStartFailedReason;
+	static UNKNOWN: VideoStartFailedReason;
+	private constructor();
+}
+export interface ErrorData {
+	exceptionMessage?: string | undefined;
+	exceptionStacktrace?: string[] | undefined;
+	additionalData?: string | undefined;
+}
+export interface AnalyticsEventBase {
+	currentTime?: number;
+}
+interface ErrorEvent$1 extends AnalyticsEventBase {
+	code: number | undefined;
+	message: string | undefined;
+	legacyData?: any;
+	data: ErrorData;
+}
+export interface VideoStartFailedEvent extends AnalyticsEventBase {
+	reason: VideoStartFailedReason;
+}
+export interface SsaiEventHandler {
+	onSsaiInteraction: (timestamp: number, eventData: AnalyticsEventBase) => void;
+}
+export interface DownloadSpeedInfo {
+	/**
+	 * Number of completed segment downloads
+	 */
+	segmentsDownloadCount: number;
+	/**
+	 * Total download size in bytes
+	 */
+	segmentsDownloadSize: number;
+	/**
+	 * Total time spent downloading segments in milliseconds
+	 */
+	segmentsDownloadTime: number;
+	/**
+	 * Average download speed in kbps
+	 */
+	avgDownloadSpeed: number;
+	/**
+	 * Maximum download speed in kbps
+	 */
+	maxDownloadSpeed: number;
+	/**
+	 * Minimum download speed in kbps
+	 */
+	minDownloadSpeed: number;
+	/**
+	 * Average time to first byte in milliseconds
+	 */
+	avgTimeToFirstByte: number;
+}
+export interface Sample extends CustomDataValues {
+	ad?: 0 | 1 | 2;
+	adId?: string;
+	adSystem?: string;
+	adPosition?: string;
+	adIndex?: number;
+	analyticsVersion?: any;
+	audioBitrate?: 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;
+	errorCode?: number;
+	errorData?: string;
+	errorMessage?: string;
+	errorSegments?: any[];
+	impressionId?: string;
+	isCasting?: boolean;
+	isLive?: boolean;
+	isMuted?: boolean;
+	key?: string;
+	language?: string;
+	m3u8Url?: string;
+	mpdUrl?: 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;
+	streamFormat?: string;
+	subtitleEnabled?: boolean;
+	subtitleLanguage?: string;
+	supportedVideoCodecs?: string[];
+	time?: number;
+	userAgent?: string;
+	userId?: string;
+	version?: string;
+	videoBitrate?: number;
+	videoCodec?: string;
+	videoDuration?: number;
+	videoId?: string;
+	videoPlaybackHeight?: number;
+	videoPlaybackWidth?: number;
+	videoStartFailed?: boolean;
+	videoStartFailedReason?: string;
+	videoStartupTime?: number;
+	videoTimeEnd?: number;
+	videoTimeStart?: number;
+	videoTitle?: string;
+	videoWindowHeight?: number;
+	videoWindowWidth?: number;
+}
+declare class SsaiService {
+	/**
+	 * eventHandler is outside dependency.
+	 * Due to the structure it is not possible to pass it to constructor of this class
+	 */
+	eventHandler: undefined | SsaiEventHandler;
+	private state;
+	/**
+	 * represents the current playing ad metdata
+	 * is `undefined` when no ad is playing (after endAdBreak)
+	 * or omitted by customer
+	 */
+	private currentAdMetadata;
+	private adIndex;
+	private isFirstSampleOfAd;
+	private player;
+	constructor(player: any);
+	adBreakStart(adBreakMetadata?: SsaiAdBreakMetadata): void;
+	adStart(adMetadata?: SsaiAdMetadata): void;
+	adBreakEnd(): void;
+	private reset;
+	resetSourceRelatedState(): void;
+	manipulate(sample: Sample): void;
+}
 declare class QualityChangeService {
 	private qualityChangeThreshold;
 	private qualityChangeCount;
@@ -174,36 +361,6 @@ declare abstract class Feature<TConfigContainer, TConfig extends FeatureConfig>
 	configure(authenticated: boolean, configContainer?: TConfigContainer): TConfig | undefined;
 	abstract extractConfig(configContainer: TConfigContainer): TConfig | undefined;
 }
-export interface DownloadSpeedInfo {
-	/**
-	 * Number of completed segment downloads
-	 */
-	segmentsDownloadCount: number;
-	/**
-	 * Total download size in bytes
-	 */
-	segmentsDownloadSize: number;
-	/**
-	 * Total time spent downloading segments in milliseconds
-	 */
-	segmentsDownloadTime: number;
-	/**
-	 * Average download speed in kbps
-	 */
-	avgDownloadSpeed: number;
-	/**
-	 * Maximum download speed in kbps
-	 */
-	maxDownloadSpeed: number;
-	/**
-	 * Minimum download speed in kbps
-	 */
-	minDownloadSpeed: number;
-	/**
-	 * Average time to first byte in milliseconds
-	 */
-	avgTimeToFirstByte: number;
-}
 export interface DrmPerformanceInfo {
 	readonly drmType: string;
 	readonly drmLoadTime: number;
@@ -251,118 +408,6 @@ export interface SegmentInfo {
 	timestamp: number;
 	url: string;
 }
-declare class ErrorCode {
-	readonly code: number;
-	readonly message: string;
-	static BITMOVIN_PLAYER_LICENSING_ERROR: ErrorCode;
-	static SETUP_MISSING_LICENSE_WHITELIST: ErrorCode;
-	static QUALITY_CHANGE_THRESHOLD_EXCEEDED: ErrorCode;
-	static BUFFERING_TIMEOUT_REACHED: ErrorCode;
-	static VIDEO_STARTUP_TIMEOUT_REACHED: ErrorCode;
-	private constructor();
-}
-declare class VideoStartFailedReason {
-	readonly reason: string;
-	readonly errorCode: ErrorCode | null;
-	static PAGE_CLOSED: VideoStartFailedReason;
-	static PLAYER_ERROR: VideoStartFailedReason;
-	static TIMEOUT: VideoStartFailedReason;
-	static UNKNOWN: VideoStartFailedReason;
-	private constructor();
-}
-export interface ErrorData {
-	exceptionMessage?: string | undefined;
-	exceptionStacktrace?: string[] | undefined;
-	additionalData?: string | undefined;
-}
-export interface AnalyticsEventBase {
-	currentTime?: number;
-}
-interface ErrorEvent$1 extends AnalyticsEventBase {
-	code: number | undefined;
-	message: string | undefined;
-	legacyData?: any;
-	data: ErrorData;
-}
-export interface VideoStartFailedEvent extends AnalyticsEventBase {
-	reason: VideoStartFailedReason;
-}
-export interface Sample extends CustomDataValues {
-	ad?: number;
-	analyticsVersion?: any;
-	audioBitrate?: 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;
-	errorCode?: number;
-	errorData?: string;
-	errorMessage?: string;
-	errorSegments?: any[];
-	impressionId?: string;
-	isCasting?: boolean;
-	isLive?: boolean;
-	isMuted?: boolean;
-	key?: string;
-	language?: string;
-	m3u8Url?: string;
-	mpdUrl?: 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;
-	streamFormat?: string;
-	subtitleEnabled?: boolean;
-	subtitleLanguage?: string;
-	supportedVideoCodecs?: string[];
-	time?: number;
-	userAgent?: string;
-	userId?: string;
-	version?: string;
-	videoBitrate?: number;
-	videoCodec?: string;
-	videoDuration?: number;
-	videoId?: string;
-	videoPlaybackHeight?: number;
-	videoPlaybackWidth?: number;
-	videoStartFailed?: boolean;
-	videoStartFailedReason?: string;
-	videoStartupTime?: number;
-	videoTimeEnd?: number;
-	videoTimeStart?: number;
-	videoTitle?: string;
-	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;
@@ -410,6 +455,13 @@ export interface Subscribable<TArgs> {
 	unsubscribe(callback: EventHandler<TArgs>): any;
 }
 export type EventHandler<TArgs> = (args: TArgs) => void;
+declare class EventDispatcher<TArgs> implements Subscribable<TArgs> {
+	private callbacks;
+	subscribe(callback: EventHandler<TArgs>): () => void;
+	dispatch(args: TArgs): void;
+	unsubscribe(callback: EventHandler<TArgs>): void;
+	get subscriberCount(): number;
+}
 export interface DeferredLicenseLoadingAdapterAPI {
 	readonly supportsDeferredLicenseLoading?: boolean;
 	readonly onLicenseKeyReceived: Subscribable<{
@@ -461,6 +513,13 @@ export interface InternalAdapterAPI extends DeferredLicenseLoadingAdapterAPI {
 	onError?(): void;
 	setCustomData(values: CustomDataValues): void;
 }
+declare class FeatureManager<TConfigContainer> {
+	private features;
+	registerFeatures(features: Array<Feature<TConfigContainer, FeatureConfig>>): void;
+	unregisterFeatures(): void;
+	resetFeatures(): void;
+	configureFeatures(authenticated: boolean, featureConfigs?: TConfigContainer): void;
+}
 export interface OnErrorDetailEventObject {
 	code: number | undefined;
 	message: string | undefined;
@@ -493,14 +552,19 @@ declare class BackendFactory {
 	private isEnabled;
 	private createInnerBackend;
 }
+declare class SessionPersistenceHandler {
+	readonly userId: string;
+	constructor(config: AnalyticsConfig);
+}
 declare class Analytics {
-	get version(): string;
-	static version: string;
-	private readonly sessionHandler;
-	private readonly adapter;
+	private adapter;
 	private readonly backendFactory;
+	private readonly sessionHandler;
 	private readonly featureManager;
 	private readonly onErrorDetailEventDispatcher;
+	private readonly ssaiService?;
+	get version(): string;
+	static version: string;
 	private readonly adAnalytics;
 	pageLoadTime: number;
 	playerStartupTime: number;
@@ -513,7 +577,7 @@ declare class Analytics {
 	private droppedSampleFrames;
 	private startupTime;
 	private authenticationCallback;
-	constructor(config: AnalyticsConfig, adapter: InternalAdapterAPI, backendFactory?: BackendFactory);
+	constructor(config: AnalyticsConfig, adapter: InternalAdapterAPI, backendFactory: BackendFactory, sessionHandler: SessionPersistenceHandler, featureManager: FeatureManager<FeatureConfigContainer>, onErrorDetailEventDispatcher: EventDispatcher<OnErrorDetailEventObject>, ssaiService?: SsaiService | undefined);
 	get errorDetailSubscribable(): Subscribable<OnErrorDetailEventObject>;
 	getPlayerInformationFromAdapter(): {
 		player: string;
@@ -559,6 +623,7 @@ declare class Analytics {
 	private setVideoTimeStart;
 	private setVideoTimeEnd;
 	private sendQualityChange;
+	static create(config: AnalyticsConfig, adapter: InternalAdapterAPI, ssaiService?: SsaiService): Analytics;
 }
 declare abstract class Adapter {
 	protected analytics: Analytics;
@@ -578,6 +643,7 @@ export declare class AmazonIVSAdapter extends Adapter implements AdapterAPI {
 }
 export declare class Bitmovin8Adapter extends Adapter implements AdapterAPI {
 	constructor(player: any, opts?: AnalyticsStateMachineOptions);
+	ssai: SsaiApi;
 	/**
 	 * intercept `player.load` with automated sourceChange handling
 	 */