feat: event payloads (#210)

videojs · Mar 26, 2024 · 8bc0cff · 8bc0cff
1 parent 5820da7
commit 8bc0cff
Show file tree

Hide file tree

Showing 10 changed files with 160 additions and 43 deletions.
diff --git a/README.md b/README.md
@@ -617,8 +617,10 @@ This event is triggered directly from the underlying `keystatuseschange` event,
 When the key session is created, an event of type `keysessioncreated` will be triggered on the Video.js playback tech.
 
 ```
-player.tech().on('keysessioncreated', function(event) {
-  // note that there is no event data for keysessioncreated
+player.tech().on('keysessioncreated', function(keySession) {
+  // Event data:
+  // keySession: the mediaKeySession object 
+  // https://www.w3.org/TR/encrypted-media/#mediakeysession-interface
 });
 ```
 

diff --git a/src/eme.js b/src/eme.js
@@ -109,11 +109,17 @@ export const makeNewRequest = (player, requestOptions) => {
   try {
     const keySession = mediaKeys.createSession();
 
-    eventBus.trigger('keysessioncreated');
+    eventBus.trigger({
+      type: 'keysessioncreated',
+      keySession
+    });
 
     player.on('dispose', () => {
       keySession.close().then(() => {
-        eventBus.trigger('keysessionclosed');
+        eventBus.trigger({
+          type: 'keysessionclosed',
+          keySession
+        });
       }).catch((error) => {
         const metadata = {
           errorType: videojs.Error.EMEFailedToCloseSession,
@@ -128,7 +134,7 @@ export const makeNewRequest = (player, requestOptions) => {
       keySession.addEventListener('message', (event) => {
         eventBus.trigger({
           type: 'keymessage',
-          event
+          messageEvent: event
         });
         // all other types will be handled by keystatuseschange
         if (event.messageType !== 'license-request' && event.messageType !== 'license-renewal') {
@@ -138,7 +144,10 @@ export const makeNewRequest = (player, requestOptions) => {
         getLicense(options, event.message, contentId)
           .then((license) => {
             resolve(keySession.update(license).then(() => {
-              eventBus.trigger('keysessionupdated');
+              eventBus.trigger({
+                type: 'keysessionupdated',
+                keySession
+              });
             }).catch((error) => {
               const metadata = {
                 errorType: videojs.Error.EMEFailedToUpdateSessionWithReceivedLicenseKeys,
@@ -153,9 +162,18 @@ export const makeNewRequest = (player, requestOptions) => {
           });
       }, false);
 
-      keySession.addEventListener('keystatuseschange', (event) => {
+      const KEY_STATUSES_CHANGE = 'keystatuseschange';
+
+      keySession.addEventListener(KEY_STATUSES_CHANGE, (event) => {
         let expired = false;
 
+        // Re-emit the keystatuseschange event with the entire keyStatusesMap
+        eventBus.trigger({
+          type: KEY_STATUSES_CHANGE,
+          keyStatuses: keySession.keyStatuses
+        });
+
+        // Keep 'keystatuschange' for backward compatibility.
         // based on https://www.w3.org/TR/encrypted-media/#example-using-all-events
         keySession.keyStatuses.forEach((status, keyId) => {
           // Trigger an event so that outside listeners can take action if appropriate.
@@ -191,7 +209,10 @@ export const makeNewRequest = (player, requestOptions) => {
           // session can be created.
           videojs.log.debug('Session expired, closing the session.');
           keySession.close().then(() => {
-            eventBus.trigger('keysessionclosed');
+            eventBus.trigger({
+              type: 'keysessionclosed',
+              keySession
+            });
             removeSession(initData);
             makeNewRequest(player, requestOptions);
           }).catch((error) => {
@@ -504,7 +525,10 @@ export const standard5July2016 = ({
     }).then(() => {
       return keySystemAccess.createMediaKeys();
     }).then((createdMediaKeys) => {
-      eventBus.trigger('keysystemaccesscomplete');
+      eventBus.trigger({
+        type: 'keysystemaccesscomplete',
+        mediaKeys: createdMediaKeys
+      });
       return addPendingSessions({
         player,
         video,

diff --git a/src/fairplay.js b/src/fairplay.js
@@ -84,11 +84,18 @@ const addKey = ({video, contentId, initData, cert, options, getLicense, eventBus
       return;
     }
 
-    eventBus.trigger('keysessioncreated');
+    eventBus.trigger({
+      type: 'keysessioncreated',
+      keySession
+    });
 
     keySession.contentId = contentId;
 
     keySession.addEventListener('webkitkeymessage', (event) => {
+      eventBus.trigger({
+        type: 'keymessage',
+        messageEvent: event
+      });
       getLicense(options, contentId, event.message, (err, license) => {
         if (eventBus) {
           eventBus.trigger('licenserequestattempted');
@@ -105,6 +112,11 @@ const addKey = ({video, contentId, initData, cert, options, getLicense, eventBus
         }
 
         keySession.update(new Uint8Array(license));
+
+        eventBus.trigger({
+          type: 'keysessionupdated',
+          keySession
+        });
       });
     });
 

diff --git a/src/ms-prefixed.js b/src/ms-prefixed.js
@@ -9,6 +9,7 @@
 import window from 'global/window';
 import { requestPlayreadyLicense } from './playready';
 import videojs from 'video.js';
+import { getMediaKeySystemConfigurations } from './utils';
 
 export const PLAYREADY_KEY_SYSTEM = 'com.microsoft.playready';
 
@@ -20,7 +21,7 @@ export const addKeyToSession = (options, session, event, eventBus, emeError) =>
       if (err) {
         const metadata = {
           errorType: videojs.Error.EMEFailedToRequestMediaKeySystemAccess,
-          keySystem: PLAYREADY_KEY_SYSTEM
+          config: getMediaKeySystemConfigurations(options.keySystems)
         };
 
         emeError(err, metadata);
@@ -33,6 +34,11 @@ export const addKeyToSession = (options, session, event, eventBus, emeError) =>
       }
 
       session.update(key);
+
+      eventBus.trigger({
+        type: 'keysessionupdated',
+        keySession: session
+      });
     });
     return;
   }
@@ -92,7 +98,10 @@ export const createSession = (video, initData, options, eventBus, emeError) => {
     throw error;
   }
 
-  eventBus.trigger('keysessioncreated');
+  eventBus.trigger({
+    type: 'keysessioncreated',
+    keySession: session
+  });
 
   // Note that mskeymessage may not always be called for PlayReady:
   //
@@ -104,6 +113,10 @@ export const createSession = (video, initData, options, eventBus, emeError) => {
   // eslint-disable-next-line max-len
   // @see [PlayReady License Acquisition]{@link https://msdn.microsoft.com/en-us/library/dn468979.aspx}
   session.addEventListener('mskeymessage', (event) => {
+    eventBus.trigger({
+      type: 'keymessage',
+      messageEvent: event
+    });
     addKeyToSession(options, session, event, eventBus, emeError);
   });
 

diff --git a/src/plugin.js b/src/plugin.js
@@ -10,7 +10,7 @@ import {
   PLAYREADY_KEY_SYSTEM
 } from './ms-prefixed';
 import {detectSupportedCDMs } from './cdm.js';
-import { arrayBuffersEqual, arrayBufferFrom, merge } from './utils';
+import { arrayBuffersEqual, arrayBufferFrom, merge, getMediaKeySystemConfigurations } from './utils';
 import {version as VERSION} from '../package.json';
 
 export const hasSession = (sessions, initData) => {
@@ -103,7 +103,7 @@ export const handleEncryptedEvent = (player, event, options, sessions, eventBus,
   }).catch((error) => {
     const metadata = {
       errorType: videojs.Error.EMEFailedToRequestMediaKeySystemAccess,
-      config: options.keySystems
+      config: getMediaKeySystemConfigurations(options.keySystems)
     };
 
     emeError(error, metadata);

diff --git a/src/utils.js b/src/utils.js
@@ -1,5 +1,6 @@
 import document from 'global/document';
 import videojs from 'video.js';
+import { getSupportedConfigurations } from './eme';
 
 export const stringToUint16Array = (string) => {
   // 2 bytes for each char
@@ -78,3 +79,20 @@ export const mergeAndRemoveNull = (...args) => {
 
   return result;
 };
+
+/**
+ * Transforms the keySystems object into a MediaKeySystemConfiguration Object array.
+ *
+ * @param {Object} keySystems object from the options.
+ * @return {Array} of MediaKeySystemConfiguration objects.
+ */
+export const getMediaKeySystemConfigurations = (keySystems) => {
+  const config = [];
+
+  Object.keys(keySystems).forEach((keySystem) => {
+    const mediaKeySystemConfig = getSupportedConfigurations(keySystem, keySystems[keySystem])[0];
+
+    config.push(mediaKeySystemConfig);
+  });
+  return config;
+};