bitmovin-analytics 2.55.1 → 2.57.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/bitmovin-analytics-bitmovin-player-web-x.d.ts +1 -0
  2. package/bitmovin-analytics-bitmovin-player-web-x.js +2 -2
  3. package/bitmovin-analytics-bitmovin-player-web-x.js.map +1 -1
  4. package/bitmovin-analytics-bitmovin-player.d.ts +11 -0
  5. package/bitmovin-analytics-bitmovin-player.js +2 -2
  6. package/bitmovin-analytics-bitmovin-player.js.map +1 -1
  7. package/bitmovin-analytics.d.ts +17 -9
  8. package/bitmovin-analytics.js +2 -2
  9. package/bitmovin-analytics.js.map +1 -1
  10. package/package.json +1 -1
package/bitmovin-analytics.d.ts CHANGED
@@ -1,5 +1,6 @@
1
1
  export interface AnalyticsDebugConfig {
2
2
  fields?: string[];
3
+ adFields?: string[];
3
4
  }
4
5
  export type ErrorSeverity = "CRITICAL" | "INFO";
5
6
  export interface AnalyticsError {
@@ -242,6 +243,14 @@ export interface CustomDataValues {
242
243
  customData100?: string;
243
244
  experimentName?: string;
244
245
  }
246
+ export interface SourceMetadata {
247
+ readonly title?: string;
248
+ readonly videoId?: string;
249
+ readonly cdnProvider?: string;
250
+ readonly path?: string;
251
+ readonly isLive?: boolean;
252
+ readonly customData?: CustomDataValues;
253
+ }
245
254
  /**
246
255
  * Minimal set of shared methods among all collectors
247
256
  */
@@ -252,6 +261,7 @@ export interface AdapterAPI {
252
261
  setCustomData: (values: CustomDataValues) => void;
253
262
  setCustomDataOnce: (values: CustomDataValues) => void;
254
263
  sourceChange: (config: AnalyticsConfig) => void;
264
+ programChange: (sourceMetadata: SourceMetadata) => void;
255
265
  }
256
266
  export type AdPosition = "preroll" | "midroll" | "postroll";
257
267
  export type SsaiAdBreakMetadata = {
@@ -292,6 +302,7 @@ export declare class Bitmovin8Adapter implements AdapterAPI {
292
302
  setCustomData(values: CustomDataValues): void;
293
303
  setCustomDataOnce(values: CustomDataValues): void;
294
304
  sourceChange(config: AnalyticsConfig): void;
305
+ programChange(sourceMetadata: SourceMetadata): void;
295
306
  }
296
307
  export declare const PlayerModule: {
297
308
  readonly name: "analytics";
@@ -314,6 +325,7 @@ export declare class CAFv3Adapter implements AdapterAPI {
314
325
  setCustomData(values: CustomDataValues): void;
315
326
  setCustomDataOnce(values: CustomDataValues): void;
316
327
  sourceChange(config: AnalyticsConfig): void;
328
+ programChange(sourceMetadata: SourceMetadata): void;
317
329
  }
318
330
  export declare class HlsAdapter implements AdapterAPI {
319
331
  private readonly internalAdapter;
@@ -326,6 +338,7 @@ export declare class HlsAdapter implements AdapterAPI {
326
338
  setCustomData(values: CustomDataValues): void;
327
339
  setCustomDataOnce(values: CustomDataValues): void;
328
340
  sourceChange(config: AnalyticsConfig): void;
341
+ programChange(sourceMetadata: SourceMetadata): void;
329
342
  }
330
343
  export declare class HTMLVideoElementAdapter implements AdapterAPI {
331
344
  private readonly internalAdapter;
@@ -353,6 +366,7 @@ export declare class HTMLVideoElementAdapter implements AdapterAPI {
353
366
  streamFormat?: string;
354
367
  videoCodec?: string;
355
368
  }): void;
369
+ programChange(sourceMetadata: SourceMetadata): void;
356
370
  }
357
371
  export declare class ShakaAdapter implements AdapterAPI {
358
372
  private readonly internalAdapter;
@@ -366,12 +380,12 @@ export declare class ShakaAdapter implements AdapterAPI {
366
380
  setCustomData(values: CustomDataValues): void;
367
381
  setCustomDataOnce(values: CustomDataValues): void;
368
382
  sourceChange(config: AnalyticsConfig): void;
383
+ programChange(sourceMetadata: SourceMetadata): void;
369
384
  }
370
385
  export declare class THEOplayerAdapter implements AdapterAPI {
371
386
  private readonly internalAdapter;
372
387
  private readonly analytics;
373
388
  constructor(config: AnalyticsConfig, player: any, _opts?: AnalyticsStateMachineOptions);
374
- readonly ssai: SsaiApi;
375
389
  static readonly version: string;
376
390
  get version(): string;
377
391
  getCurrentImpressionId(): string | undefined;
@@ -379,14 +393,7 @@ export declare class THEOplayerAdapter implements AdapterAPI {
379
393
  setCustomData(values: CustomDataValues): void;
380
394
  setCustomDataOnce(values: CustomDataValues): void;
381
395
  sourceChange(config: AnalyticsConfig): void;
382
- programChange(sourceMetadata: {
383
- title?: string;
384
- videoId?: string;
385
- cdnProvider?: string;
386
- path?: string;
387
- isLive?: boolean;
388
- customData?: CustomDataValues;
389
- }): void;
396
+ programChange(sourceMetadata: SourceMetadata): void;
390
397
  }
391
398
  export declare class VideojsAdapter implements AdapterAPI {
392
399
  private readonly internalAdapter;
@@ -399,6 +406,7 @@ export declare class VideojsAdapter implements AdapterAPI {
399
406
  setCustomData(values: CustomDataValues): void;
400
407
  setCustomDataOnce(values: CustomDataValues): void;
401
408
  sourceChange(config: AnalyticsConfig): void;
409
+ programChange(sourceMetadata: SourceMetadata): void;
402
410
  }
403
411
  declare enum CdnProvider {
404
412
  AKAMAI = "akamai",