fix(Demo): Allow manifest type for DAI custom assets (#4977)

Fixes #4887
shaka-project · Feb 9, 2023 · d341f93 · d341f93
1 parent acebfa1
commit d341f93
Show file tree

Hide file tree

Showing 8 changed files with 67 additions and 2 deletions.
diff --git a/demo/common/asset.js b/demo/common/asset.js
@@ -76,6 +76,8 @@ const ShakaDemoAssetInfo = class {
     /** @type {?string} */
     this.imaContentSrcId = null;
     /** @type {?string} */
+    this.imaManifestType = null;
+    /** @type {?string} */
     this.mimeType = null;
 
 
@@ -256,6 +258,19 @@ const ShakaDemoAssetInfo = class {
     return this;
   }
 
+  /**
+   * @param {string} type
+   * @return {!ShakaDemoAssetInfo}
+   */
+  setIMAManifestType(type) {
+    this.imaManifestType = type;
+    if (!this.features.includes(shakaAssets.Feature.ADS)) {
+      this.addFeature(shakaAssets.Feature.ADS);
+    }
+
+    return this;
+  }
+
   /**
    * @param {string} headerName
    * @param {string} headerValue

diff --git a/demo/common/assets.js b/demo/common/assets.js
@@ -509,7 +509,8 @@ shakaAssets.testAssets = [
       .addFeature(shakaAssets.Feature.MP4)
       .addFeature(shakaAssets.Feature.OFFLINE)
       .setIMAContentSourceId('2528370')
-      .setIMAVideoId('tears-of-steel'),
+      .setIMAVideoId('tears-of-steel')
+      .setIMAManifestType('HLS'),
   new ShakaDemoAssetInfo(
       /* name= */ 'Tears of Steel (live, DASH, Server Side ads)',
       /* iconUri= */ 'https://storage.googleapis.com/shaka-asset-icons/tears_of_steel.png',
@@ -519,7 +520,8 @@ shakaAssets.testAssets = [
       .addFeature(shakaAssets.Feature.MP4)
       .addFeature(shakaAssets.Feature.SUBTITLES)
       .addFeature(shakaAssets.Feature.LIVE)
-      .setIMAAssetKey('PSzZMzAkSXCmlJOWDmRj8Q'),
+      .setIMAAssetKey('PSzZMzAkSXCmlJOWDmRj8Q')
+      .setIMAManifestType('DASH'),
   new ShakaDemoAssetInfo(
       /* name= */ 'Tears of Steel (multicodec, surround + stereo)',
       /* iconUri= */ 'https://storage.googleapis.com/shaka-asset-icons/tears_of_steel.png',

diff --git a/demo/common/message_ids.js b/demo/common/message_ids.js
@@ -96,6 +96,7 @@ shakaDemo.MessageIds = {
   ADS_TAB: 'DEMO_ADS_TAB',
   IMA_ASSET_KEY: 'DEMO_IMA_ASSET_KEY',
   IMA_CONTENT_SRC_ID: 'DEMO_IMA_CONTENT_SRC_ID',
+  IMA_MANIFEST_TYPE: 'DEMO_IMA_MANIFEST_TYPE',
   IMA_VIDEO_ID: 'DEMO_IMA_VIDEO_ID',
   CANCEL_BUTTON: 'DEMO_CANCEL_BUTTON',
   CUSTOM_INTRO_ONE: 'DEMO_CUSTOM_INTRO_ONE',

diff --git a/demo/custom.js b/demo/custom.js
@@ -328,6 +328,25 @@ shakaDemo.Custom = class {
     this.makeField_(
         container, assetKeyName, assetKeySetup, assetKeyChange);
 
+    // Make the manifest type field.
+    const manifestTypeSetup = (input, container) => {
+      if (assetInProgress.imaManifestType) {
+        input.value = assetInProgress.imaManifestType;
+      }
+
+      this.manifestField_.required =
+        this.checkManifestRequired_(assetInProgress);
+    };
+    const manifestTypeChange = (input) => {
+      assetInProgress.imaManifestType = input.value;
+      this.manifestField_.required =
+        this.checkManifestRequired_(assetInProgress);
+    };
+    const manifestTypeName = shakaDemoMain.getLocalizedString(
+        shakaDemo.MessageIds.IMA_MANIFEST_TYPE);
+    this.makeField_(
+        container, manifestTypeName, manifestTypeSetup, manifestTypeChange);
+
     return adsDiv;
   }
 

diff --git a/demo/locales/en.json b/demo/locales/en.json
@@ -97,6 +97,7 @@
   "DEMO_IGNORE_HLS_TEXT_FAILURES": "Ignore HLS Text Stream Failures",
   "DEMO_IMA_ASSET_KEY": "Asset key (for LIVE DAI Content)",
   "DEMO_IMA_CONTENT_SRC_ID": "Content source ID (for VOD DAI Content)",
+  "DEMO_IMA_MANIFEST_TYPE": "Manifest type (for DAI Content)",
   "DEMO_IMA_VIDEO_ID": "Video ID (for VOD DAI Content)",
   "DEMO_IGNORE_MIN_BUFFER_TIME": "Ignore Min Buffer Time",
   "DEMO_IGNORE_TEXT_FAILURES": "Ignore Text Stream Failures",

diff --git a/demo/locales/source.json b/demo/locales/source.json
@@ -391,6 +391,10 @@
     "description": "The label on a field that allows users to provide a content source id for a custom asset.",
     "message": "Asset key (for VOD DAI Content)"
   },
+  "DEMO_IMA_MANIFEST_TYPE": {
+    "description": "The label on a field that allows users to provide a manifest type for a custom asset.",
+    "message": "Manifest type (for DAI Content)"
+  },
   "DEMO_IMA_VIDEO_ID": {
     "description": "The label on a field that allows users to provide a video id for a custom asset.",
     "message": "Video ID (for VOD DAI Content)"

diff --git a/demo/main.js b/demo/main.js
@@ -1502,6 +1502,20 @@ shakaDemo.Main = class {
         request.contentSourceId = asset.imaContentSrcId;
         request.videoId = asset.imaVideoId;
       }
+      switch (asset.imaManifestType) {
+        case 'DASH':
+        case 'dash':
+        case 'MPD':
+        case 'mpd':
+          request.format = google.ima.dai.api.StreamRequest.StreamFormat.DASH;
+          break;
+        case 'HLS':
+        case 'hls':
+        case 'M3U8':
+        case 'm3u8':
+          request.format = google.ima.dai.api.StreamRequest.StreamFormat.HLS;
+          break;
+      }
 
       const uri = await adManager.requestServerSideStream(
           request, /* backupUri= */ asset.manifestUri);

diff --git a/externs/ima.js b/externs/ima.js
@@ -501,6 +501,15 @@ google.ima.dai.api.StreamRequest.prototype.streamActivityMonitorId;
 google.ima.dai.api.StreamRequest.prototype.format;
 
 
+/**
+ * @enum {string}
+ */
+google.ima.dai.api.StreamRequest.StreamFormat = {
+  DASH: 'dash',
+  HLS: 'hls',
+};
+
+
 /** @const */
 google.ima.dai.api.VODStreamRequest =
     class extends google.ima.dai.api.StreamRequest {};