@eyevinn/player-analytics-client-sdk-web 0.1.0 → 0.1.1

package/Readme.md

@@ -14,20 +14,18 @@ npm install @eyevinn/player-analytics-client-sdk-web
 import { PlayerAnalyticsConnector } from "@eyevinn/player-analytics-client-sdk-web";
 
 // Create your instance and set the analytics eventsink endpoint
-const playerAnalytics = new PlayerAnalyticsConnector("https://your-eventsink-url.io");
+const playerAnalytics = new PlayerAnalyticsConnector(
+  "https://your-eventsink-url.io"
+);
 
 // Initiate the analytics with the base data needed
 // This will create you session in the backend
 try {
   await playerAnalytics.init({
     sessionId: "generated-unique-uuid-session-id",
-    live: false,
-    contentId: "big-buck-bunny-720",
-    contentUrl:
-      "https://test-videos.co.uk/vids/bigbuckbunny/mp4/h264/720/Big_Buck_Bunny_720_10s_1MB.mp4",
   });
 
-  // Get you video element from the site, or your video player of choice
+  // Get your video element from the site, or your video player of choice
   const videoElement = document.querySelector("video");
   // Load the analytics library with the video element to fetch the events
   playerAnalytics.load(videoElement);
@@ -42,11 +40,11 @@ Due to bitrate changes not being reported, and errors not being reported in any
 
 ```js
 playerAnalytics.reportBitrateChange({
-  bitrate: "", // bitrate in Kbps
-  width: "", // optional, video width in pixels
-  height: "", // optional, video height in pixels
-  videoBitrate: "", // optional, if available provide the bitrate for the video track
-  audioBitrate: "", // optional, if available provide the bitrate for the audio track
+  bitrate: 246.440, // bitrate in Kbps
+  width: 320, // optional, video width in pixels
+  height: 136, // optional, video height in pixels
+  videoBitrate: 0, // optional, if available provide the bitrate for the video track
+  audioBitrate: 0, // optional, if available provide the bitrate for the audio track
 });
 ```
 
@@ -96,10 +94,9 @@ videoElement.addEventListener("play", () => {
     timestamp: Date.now(),
     playhead: 0,
     duration: 3600,
-    sessionId: "generated-unique-uuid-session-id"
+    sessionId: "generated-unique-uuid-session-id",
   });
 });
-
 ```
 
 ### Report Metadata
@@ -108,33 +105,41 @@ You can report your metadata at a later stage in your code and tailor ther callb
 In this example we're using hls.js
 
 ```js
-import Hls from "hls.js"
+import Hls from "hls.js";
 import { PlayerAnalyticsConnector } from "@eyevinn/player-analytics-client-sdk-web";
 
 // Create your instance and set the analytics eventsink endpoint
 const playerAnalytics = new PlayerAnalytics("https://your-eventsink-url.io");
 await playerAnalytics.initiateAnalyticsReporter({
   sessionId: "generated-unique-uuid-session-id",
-  contentId: "big-buck-bunny-720",
-  contentUrl:
-    "https://test-videos.co.uk/vids/bigbuckbunny/mp4/h264/720/Big_Buck_Bunny_720_10s_1MB.mp4",
 });
 
 const hls = new Hls();
 const videoElement = document.querySelector("video");
 
-hls.attachMedia(videoElement)
-hls.load(src)
+hls.attachMedia(videoElement);
+hls.load(src);
 hls.on(Hls.Events.LEVEL_LOADED, (event, data) => {
   playerAnalytics.metadata({
-    event: "metadata",
-    payload: {
-      isLive: data?.details?.level?.live
-    }
-  })
-})
+    live: data?.details?.level?.live,
+  });
+});
+```
 
+These are the available keys for metadata, which can be sent anytime between a `init` and a `stopped` call.
 
+```ts
+export interface TMetadataEventPayload {
+    live?: boolean;
+    contentTitle?: string;
+    contentId?: string;
+    contentUrl?: string;
+    drmType?: string;
+    userId?: string;
+    deviceId?: string;
+    deviceModel?: string;
+    deviceType?: string;
+}
 ```
 
 ### Constructor parameters
@@ -149,14 +154,7 @@ These applies to both the `PlayerAnalyticsConnector` and `PlayerAnalytics`.
 ```ts
 export interface IPlayerAnalyticsInitOptions {
   sessionId?: string; // should be generated by the backend if not sent in
-  live?: boolean;
-  contentId: string;
-  contentUrl: string;
-  drmType?: string;
-  userId?: string;
-  deviceId?: string;
-  deviceModel?: string;
-  deviceType?: string;
+  hearbeatInterval?: number; //Defaults to 30_000 (ms)
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eyevinn/player-analytics-client-sdk-web",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "EPAS Client SDK for Web",
   "source": "index.ts",
   "main": "dist/index.js",
@@ -39,6 +39,6 @@
   },
   "dependencies": {
     "@eyevinn/player-analytics-specification": "0.3.1",
-    "@eyevinn/video-event-filter": "^1.1.0"
+    "@eyevinn/video-event-filter": "^1.1.4"
   }
 }