Media Collection support

scripts/helpers/createExtensionManifest.mjs

@@ -308,6 +308,26 @@ const createExtensionManifest = ({ version }) => {
                   minLength: 1
                 },
                 edgeConfigOverrides: createEdgeConfigOverridesSchema(false),
+                streamingMedia: {
+                  type: "object",
+                  properties: {
+                    channel: {
+                      type: "string"
+                    },
+                    playerName: {
+                      type: "string"
+                    },
+                    appVersion: {
+                      type: "string"
+                    },
+                    mainPingInterval: {
+                      type: "integer"
+                    },
+                    adPingInterval: {
+                      type: "integer"
+                    }
+                  }
+                },
                 personalizationStorageEnabled: {
                   type: "boolean"
                 }
@@ -796,6 +816,58 @@ const createExtensionManifest = ({ version }) => {
         libPath: "dist/lib/actions/updateVariable/index.js",
         viewPath: "actions/updateVariable.html"
       },
+      {
+        displayName: "Send Media Event",
+        name: "send-media-event",
+        schema: {
+          $schema: "http://json-schema.org/draft-04/schema#",
+          type: "object",
+          properties: {
+            instanceName: {
+              type: "string",
+              minLength: 1
+            },
+            handleMediaSessionAutomatically: {
+              type: "boolean"
+            },
+            eventType: {
+              type: "string",
+              minLength: 1
+            },
+            playerId: {
+              type: "string",
+              minLength: 1
+            },
+            xdm: {
+              type: "object"
+            }
+          },
+          required: ["instanceName", "playerId"]
+        },
+        libPath: "dist/lib/actions/sendMediaEvent/index.js",
+        viewPath: "actions/sendStreamingMediaEvent.html"
+      },
+      {
+        displayName: "Get Media Analytics Tracker",
+        name: "get-media-tracker",
+        schema: {
+          $schema: "http://json-schema.org/draft-04/schema#",
+          type: "object",
+          properties: {
+            instanceName: {
+              type: "string",
+              minLength: 1
+            },
+            objectName: {
+              type: "string",
+              minLength: 1
+            }
+          },
+          required: ["instanceName"]
+        },
+        libPath: "dist/lib/actions/getMediaAnalyticsTracker/index.js",
+        viewPath: "actions/createMediaTracker.html"
+      },
       {
         displayName: "Evaluate rulesets",
         name: "evaluate-rulesets",
@@ -894,6 +966,63 @@ const createExtensionManifest = ({ version }) => {
       }
     ],
     dataElements: [
+      {
+        displayName: "Media: Quality of Experience data",
+        name: "qoe-details-data",
+        schema: {
+          $schema: "http://json-schema.org/draft-04/schema#",
+          type: "object",
+          properties: {
+            bitrate: {
+              oneOf: [
+                {
+                  type: "integer"
+                },
+                {
+                  type: "string",
+                  pattern: "^%[^%]+%$"
+                }
+              ]
+            },
+            droppedFrames: {
+              oneOf: [
+                {
+                  type: "integer"
+                },
+                {
+                  type: "string",
+                  pattern: "^%[^%]+%$"
+                }
+              ]
+            },
+            framesPerSecond: {
+              oneOf: [
+                {
+                  type: "integer"
+                },
+                {
+                  type: "string",
+                  pattern: "^%[^%]+%$"
+                }
+              ]
+            },
+            timeToStart: {
+              oneOf: [
+                {
+                  type: "integer"
+                },
+                {
+                  type: "string",
+                  pattern: "^%[^%]+%$"
+                }
+              ]
+            }
+          },
+          additionalProperties: false
+        },
+        libPath: "dist/lib/dataElements/qoeDetailsData/index.js",
+        viewPath: "dataElements/qoeDetailsDataElement.html"
+      },
       {
         displayName: "Event merge ID",
         name: "event-merge-id",

src/lib/actions/getMediaAnalyticsTracker/getMediaAnalyticsTracker.js

@@ -0,0 +1,28 @@
+/*
+Copyright 2024 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+module.exports =
+  ({ instanceManager, windowObject }) =>
+  settings => {
+    const { instanceName, objectName = "Media" } = settings;
+    const instance = instanceManager.getInstance(instanceName);
+
+    if (!instance) {
+      throw new Error(
+        `Failed to get a Media Analytics Tracker for "${instanceName}". No matching instance was configured with this name.`
+      );
+    }
+
+    return instance("getMediaAnalyticsTracker", {}).then(result => {
+      windowObject[objectName] = result;
+    });
+  };

src/lib/actions/getMediaAnalyticsTracker/index.js

@@ -0,0 +1,21 @@
+/*
+Copyright 2023 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+const getMediaAnalyticsTracker = require("./getMediaAnalyticsTracker");
+const instanceManager = require("../../instanceManager/index");
+
+const windowObject = window;
+
+module.exports = getMediaAnalyticsTracker({
+  instanceManager,
+  windowObject
+});

src/lib/actions/sendMediaEvent/createMediaSession.js

@@ -0,0 +1,76 @@
+/*
+Copyright 2024 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+module.exports =
+  ({ instanceManager, mediaCollectionSessionStorage, satelliteApi }) =>
+  settings => {
+    const { instanceName, handleMediaSessionAutomatically, playerId, xdm } =
+      settings;
+    const instance = instanceManager.getInstance(instanceName);
+
+    const options = { xdm };
+    const sessionDetails = mediaCollectionSessionStorage.get({ playerId });
+
+    if (sessionDetails) {
+      return Promise.resolve();
+    }
+    const { playhead, qoeDataDetails } = xdm.mediaCollection;
+    // eslint-disable-next-line no-underscore-dangle
+    const playheadVar = window._satellite.getVar(playhead);
+    xdm.mediaCollection.playhead = playheadVar;
+
+    if (qoeDataDetails) {
+      // eslint-disable-next-line no-underscore-dangle
+      const qoeDataDetailsVar = window._satellite.getVar(qoeDataDetails);
+      xdm.mediaCollection.qoeDataDetails = qoeDataDetailsVar;
+    }
+
+    if (handleMediaSessionAutomatically) {
+      options.playerId = playerId;
+
+      options.getPlayerDetails = () => {
+        // eslint-disable-next-line no-underscore-dangle
+        const playerDetails = {
+          // eslint-disable-next-line no-underscore-dangle
+          playhead: window._satellite.getVar(playhead)
+        };
+
+        if (qoeDataDetails) {
+          // eslint-disable-next-line no-underscore-dangle
+          playerDetails.qoeDataDetails = satelliteApi.getVar(qoeDataDetails);
+        }
+
+        return playerDetails;
+      };
+    }
+
+    const sessionPromise = instance("createMediaSession", options)
+      .then(result => {
+        const { sessionId } = result;
+        return sessionId;
+      })
+      .catch(error => {
+        console.error("Error creating media session", error);
+        throw error;
+      });
+
+    mediaCollectionSessionStorage.add({
+      playerId,
+      sessionDetails: {
+        handleMediaSessionAutomatically,
+        sessionPromise,
+        playhead,
+        qoeDataDetails
+      }
+    });
+    return sessionPromise;
+  };

src/lib/actions/sendMediaEvent/createSendMediaEvent.js

@@ -0,0 +1,71 @@
+/*
+Copyright 2024 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+module.exports = ({
+  instanceManager,
+  trackMediaSession,
+  mediaCollectionSessionStorage,
+  satelliteApi
+}) => {
+  return settings => {
+    const {instanceName, eventType, playerId, xdm} = settings;
+    const instance = instanceManager.getInstance(instanceName);
+
+    if (!instance) {
+      throw new Error(
+        `Failed to send media event for instance "${instanceName}". No matching instance was configured with this name.`
+      );
+    }
+
+    if (eventType === "media.sessionStart") {
+      return trackMediaSession(settings);
+    }
+
+    const sessionDetails = mediaCollectionSessionStorage.get({playerId});
+    if (!sessionDetails) {
+      console.warn(
+        `No media session found for player ID ${playerId}. Skipping media event ${eventType}. Make sure the session has started.`
+      );
+      return Promise.resolve();
+    }
+    return sessionDetails.sessionPromise.then(sessionID => {
+      if (
+        eventType === "media.sessionEnd" ||
+        eventType === "media.sessionComplete"
+      ) {
+        mediaCollectionSessionStorage.remove({playerId});
+      }
+
+      xdm.eventType = eventType;
+
+      const options = {xdm};
+
+      if (sessionDetails.handleMediaSessionAutomatically) {
+        options.playerId = playerId;
+      } else {
+        xdm.mediaCollection.playhead = satelliteApi.getVar(
+          sessionDetails.playhead
+        );
+
+        if (sessionDetails.qoeDataDetails) {
+          xdm.mediaCollection.qoeDataDetails = satelliteApi.getVar(
+            sessionDetails.qoeDataDetails
+          );
+        }
+
+        xdm.mediaCollection.sessionID = sessionID;
+      }
+
+      return instance("sendMediaEvent", options);
+    });
+  }
+};

src/lib/actions/sendMediaEvent/index.js

@@ -0,0 +1,31 @@
+/*
+Copyright 2024 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+const createMediaEvent = require("./createSendMediaEvent");
+const createMediaSession = require("./createMediaSession");
+const instanceManager = require("../../instanceManager/index");
+const { mediaCollectionSessionStorage } = require("../../index");
+
+// eslint-disable-next-line no-underscore-dangle
+const satelliteApi = window._satellite;
+
+const trackMediaSession = createMediaSession({
+  instanceManager,
+  mediaCollectionSessionStorage,
+  satelliteApi
+});
+module.exports = createMediaEvent({
+  instanceManager,
+  trackMediaSession,
+  mediaCollectionSessionStorage,
+  satelliteApi
+});