bitmovin-analytics 2.45.1 → 2.47.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.
package/README.md CHANGED
@@ -5,21 +5,23 @@
5
5
 
6
6
  Instruments adaptive streaming video players and collects information to be sent to the Bitmovin Analytics service.
7
7
 
8
- To get started collecting data with Bitmovin Analytics you need a License-Key which you can get for free by signing up for a [free Bitmovin account](https://bitmovin.com/dashboard/signup).
8
+ To get started collecting data with Bitmovin Analytics you need a License-Key which you can get for free by signing up for a [free Bitmovin account](https://dashboard.bitmovin.com/signup).
9
9
 
10
- ## Supported Players
10
+ ## Supported Players, Platforms and Devices
11
11
 
12
- The supported video players are shown here: [Analytics Collectors - HTML5](https://developer.bitmovin.com/playback/docs/analytics-collectors#html5-collectors)
12
+ The supported video players are shown here: [Analytics Collectors - HTML5](https://developer.bitmovin.com/playback/docs/supported-platforms-analytics#html5-collectors)
13
+
14
+ The supported platforms and devices are shown here: [Analytics Collectors - Platforms & Devices](https://developer.bitmovin.com/playback/docs/supported-platforms-analytics#overview)
13
15
 
14
16
  ## Usage
15
17
 
16
18
  [A getting started guide](https://developer.bitmovin.com/playback/docs/setup-analytics-web#bitmovin-player) on how to integrate Bitmovin Analytics Collector with the Bitmovin Player is available on our homepage.
17
19
 
18
- For more comprehensive integration documentation please consult the [Bitmovin Analytics documentation](https://developer.bitmovin.com/playback/docs/setup-analytics).
20
+ For more comprehensive integration documentation, please consult the [Bitmovin Analytics documentation](https://developer.bitmovin.com/playback/docs/setup-analytics).
19
21
 
20
22
  ### Integrating Bitmovin 8
21
23
 
22
- Bitmovin Player v8 comes with Analtyics pre-installed and just requires an `analytics` section containing your license key in the player configuration.
24
+ Bitmovin Player v8 comes with Analytics pre-installed and just requires an `analytics` section containing your license key in the player configuration.
23
25
 
24
26
  A minimal example:
25
27
 
@@ -55,7 +57,7 @@ Player.addModule(AnalyticsModule);
55
57
 
56
58
  ### Integrating 3rd Party Players
57
59
 
58
- To integrate other players pick the appropriate adapter (`AmazonIVSAdapter`, `CAFv3Adapter`, `DashjsAdapter`, `HlsAdapter`, `ShakaAdapter`, `VideojsAdapter` or `HTMLVideoElementAdapter`) and instantiate the adapter by passing the player instance.
60
+ To integrate other players pick the appropriate adapter (`AmazonIVSAdapter`, `BitmovinPwxAnalyticsPackage`, `CAFv3Adapter`, `DashjsAdapter`, `HlsAdapter`, `ShakaAdapter`, `VideojsAdapter` or `HTMLVideoElementAdapter`) and instantiate the adapter by passing the player instance.
59
61
 
60
62
  An example for HLS.js:
61
63
 
@@ -25,6 +25,18 @@ declare const VERSION: string;
25
25
  export interface AnalyticsDebugConfig {
26
26
  fields?: string[];
27
27
  }
28
+ export type ErrorSeverity = "CRITICAL" | "INFO";
29
+ export interface AnalyticsError {
30
+ code: number | undefined;
31
+ message: string | undefined;
32
+ severity: ErrorSeverity;
33
+ }
34
+ export interface ErrorContext {
35
+ originalError?: any;
36
+ }
37
+ export interface ErrorTransformerCallback {
38
+ transform: (error: AnalyticsError, context: ErrorContext) => AnalyticsError;
39
+ }
28
40
  export interface CollectorConfig {
29
41
  backendUrl?: string;
30
42
  enabled?: boolean;
@@ -33,6 +45,7 @@ export interface CollectorConfig {
33
45
  cookiesMaxAge?: number;
34
46
  origin?: string;
35
47
  ssaiEngagementTrackingEnabled?: boolean;
48
+ errorTransformerCallback?: ErrorTransformerCallback;
36
49
  }
37
50
  export interface AnalyticsConfig {
38
51
  config?: CollectorConfig;