Feature/conviva device metadata

.changeset/sixty-pots-teach.md

@@ -0,0 +1,5 @@
+---
+"@theoplayer/conviva-connector-web": minor
+---
+
+Added `deviceMetadata` property to `ConvivaConfiguration`.

conviva/README.md

@@ -43,6 +43,26 @@ First you need to define the Conviva metadata and configuration:
     };
 ```
 
+Optionally, you can include device metadata in the ConvivaConfiguration object
+
+```typescript
+const exampleDeviceMetadata: ConvivaDeviceMetadata = {
+    [Constants.DeviceMetadata.BRAND]: "Samsung",
+    [Constants.DeviceMetadata.MANUFACTURER]: "Samsung",
+    [Constants.DeviceMetadata.MODEL]: "QE43Q64BAUXXN",
+    [Constants.DeviceMetadata.TYPE]:  Constants.DeviceType.SMARTTV,
+    [Constants.DeviceMetadata.VERSION]: "6.5.0",
+    [Constants.DeviceMetadata.OS_NAME]: "Tizen",
+    [Constants.DeviceMetadata.OS_VERSION]: "6.5.0",
+    [Constants.DeviceMetadata.CATEGORY]: Constants.DeviceCategory.SAMSUNG_TV,
+    [Constants.DeviceMetadata.SCREEN_RESOLUTION_WIDTH]: 3840,
+    [Constants.DeviceMetadata.SCREEN_RESOLUTION_HEIGHT]: 2160,
+    [Constants.DeviceMetadata.SCREEN_RESOLUTION_SCALE_FACTOR]: 1
+}
+
+convivaMetadata.deviceMetadata = exampleDeviceMetadata
+```
+
 Using these configs you can create the Conviva connector with THEOplayer.
 
 * Add as a regular script:

conviva/package.json

@@ -21,7 +21,7 @@
     "bundle": "rollup -c rollup.config.mjs",
     "watch": "npm run bundle -- --watch",
     "build": "npm run clean && npm run bundle",
-    "serve": "http-server",
+    "serve": "http-server ./.. -o /conviva/test/pages/main_umd.html",
     "test": "jest"
   },
   "author": "THEO Technologies NV",

conviva/src/integration/ConvivaHandler.ts

@@ -4,15 +4,16 @@ import {
     Analytics,
     Constants,
     type ConvivaMetadata,
-    type VideoAnalytics
+    type VideoAnalytics,
+    ConvivaDeviceMetadata,
 } from '@convivainc/conviva-js-coresdk';
 import type { YospaceConnector } from '@theoplayer/yospace-connector-web';
 import { CONVIVA_CALLBACK_FUNCTIONS } from './ConvivaCallbackFunctions';
 import {
     calculateBufferLength,
     calculateConvivaOptions,
     collectContentMetadata,
-    collectDeviceMetadata,
+    collectDefaultDeviceMetadata,
     collectPlayerInfo,
     flattenErrorObject
 } from '../utils/Utils';
@@ -25,6 +26,7 @@ export interface ConvivaConfiguration {
     customerKey: string;
     debug?: boolean;
     gatewayUrl?: string;
+    deviceMetadata?: ConvivaDeviceMetadata;
 }
 
 export class ConvivaHandler {
@@ -52,7 +54,7 @@ export class ConvivaHandler {
         this.convivaConfig = config;
         this.currentSource = player.source;
 
-        Analytics.setDeviceMetadata(collectDeviceMetadata());
+        Analytics.setDeviceMetadata(this.convivaConfig.deviceMetadata ?? collectDefaultDeviceMetadata());
         Analytics.init(
             this.convivaConfig.customerKey,
             CONVIVA_CALLBACK_FUNCTIONS,

conviva/src/utils/Utils.ts

@@ -21,7 +21,7 @@ import {
 } from 'theoplayer';
 import { ConvivaConfiguration } from '../integration/ConvivaHandler';
 
-export function collectDeviceMetadata(): ConvivaDeviceMetadata {
+export function collectDefaultDeviceMetadata(): ConvivaDeviceMetadata {
     // Most device metadata is auto-collected by Conviva.
     return {
         [Constants.DeviceMetadata.CATEGORY]: Constants.DeviceCategory.WEB

conviva/test/pages/main_umd.html

@@ -31,7 +31,20 @@
     const convivaConfig = {
         debug: false,
         gatewayUrl: 'CUSTOMER_GATEWAY_GOES_HERE',
-        customerKey: 'CUSTOMER_KEY_GOES_HERE' // Can be a test or production key.
+        customerKey: 'CUSTOMER_KEY_GOES_HERE', // Can be a test or production key.
+        deviceMetadata: {
+            [Conviva.Constants.DeviceMetadata.BRAND]: "Chrome",
+            [Conviva.Constants.DeviceMetadata.MANUFACTURER]: "Apple",
+            [Conviva.Constants.DeviceMetadata.MODEL]: "MacBook Pro M2",
+            [Conviva.Constants.DeviceMetadata.TYPE]:  Conviva.Client.DeviceType.DESKTOP,
+            [Conviva.Constants.DeviceMetadata.VERSION]: "131.0.6778.86",
+            [Conviva.Constants.DeviceMetadata.OS_NAME]: "macOS Sonoma",
+            [Conviva.Constants.DeviceMetadata.OS_VERSION]: "14.7.0",
+            [Conviva.Constants.DeviceMetadata.CATEGORY]: Conviva.Client.DeviceCategory.APPLE_DEVICE,
+            [Conviva.Constants.DeviceMetadata.SCREEN_RESOLUTION_WIDTH]: 3024,
+            [Conviva.Constants.DeviceMetadata.SCREEN_RESOLUTION_HEIGHT]: 1964,
+            [Conviva.Constants.DeviceMetadata.SCREEN_RESOLUTION_SCALE_FACTOR]: 1
+        }
     };
 
     const convivaIntegration = new THEOplayerConvivaConnector.ConvivaConnector(