@xibosignage/xibo-layout-renderer 1.0.26 → 1.0.27

package/dist/xibo-layout-renderer.js

@@ -755,6 +755,7 @@ var XiboLayoutRenderer = (function (exports) {
     options: {},
     playNextMedia: function playNextMedia() {},
     playPreviousMedia: function playPreviousMedia() {},
+    prepareMedia: function prepareMedia(_media) {},
     prepareMediaObjects: function prepareMediaObjects() {},
     prepareRegion: function prepareRegion() {},
     ready: false,
@@ -73985,6 +73986,9 @@ ${segmentInfoString(segmentInfo)}`); // If there's an init segment associated wi
       _defineProperty(this, "xml", null);
       _defineProperty(this, "videoHandler", void 0);
       _defineProperty(this, "mediaTimer", void 0);
+      _defineProperty(this, "sspImpressionUrls", undefined);
+      _defineProperty(this, "sspErrorUrls", undefined);
+      _defineProperty(this, "isSspWidget", false);
       _defineProperty(this, "mediaTimeCount", 0);
       _defineProperty(this, "xlr", {});
       _defineProperty(this, "statsBC", new BroadcastChannel('statsBC'));
@@ -74070,6 +74074,10 @@ ${segmentInfoString(segmentInfo)}`); // If there's an init segment associated wi
           layoutId: media.region.layout.id
         });
         _this.xlr.emitter.emit('widgetEnd', parseInt(media.id));
+        if (_this.isSspWidget) {
+          var _this$sspImpressionUr, _this$sspErrorUrls;
+          _this.xlr.emitter.emit('sspWidgetEnd', (_this$sspImpressionUr = _this.sspImpressionUrls) !== null && _this$sspImpressionUr !== void 0 ? _this$sspImpressionUr : [], (_this$sspErrorUrls = _this.sspErrorUrls) !== null && _this$sspErrorUrls !== void 0 ? _this$sspErrorUrls : [], _this.sspImpressionUrls ? _this.duration : 0);
+        }
         media.region.playNextMedia();
       });
       this.on('cancelled', function (media) {
@@ -74096,6 +74104,10 @@ ${segmentInfoString(segmentInfo)}`); // If there's an init segment associated wi
           layoutId: media.region.layout.id
         });
         _this.xlr.emitter.emit('widgetEnd', parseInt(media.id));
+        if (_this.isSspWidget) {
+          var _this$sspImpressionUr2, _this$sspErrorUrls2;
+          _this.xlr.emitter.emit('sspWidgetEnd', (_this$sspImpressionUr2 = _this.sspImpressionUrls) !== null && _this$sspImpressionUr2 !== void 0 ? _this$sspImpressionUr2 : [], (_this$sspErrorUrls2 = _this.sspErrorUrls) !== null && _this$sspErrorUrls2 !== void 0 ? _this$sspErrorUrls2 : [], _this.sspImpressionUrls ? _this.duration : 0);
+        }
         media.region.playNextMedia();
       });
       // Initialize Media object
@@ -74196,26 +74208,33 @@ ${segmentInfoString(segmentInfo)}`); // If there's an init segment associated wi
         if (this.mediaType === 'image' || this.mediaType === 'video') {
           resourceUrlParams.mediaType = this.mediaType;
         }
-        var tmpUrl = '';
-        if (this.xlr.config.platform === exports.ConsumerPlatform.CMS) {
-          tmpUrl = composeResourceUrlByPlatform(this.xlr.config, resourceUrlParams);
-        } else if (this.xlr.config.platform === exports.ConsumerPlatform.CHROMEOS) {
-          tmpUrl = composeResourceUrl(this.xlr.config, resourceUrlParams);
-          if (this.mediaType === 'image' || this.mediaType === 'video' || this.mediaType === 'audio') {
-            tmpUrl = composeMediaUrl(resourceUrlParams);
+        // SSP widget: URL is not known until the consumer resolves an ad at play-time.
+        // Skip all URL composition and leave url as null.
+        if (this.mediaType === 'ssp') {
+          this.url = null;
+          this.isSspWidget = true;
+        } else {
+          var tmpUrl = '';
+          if (this.xlr.config.platform === exports.ConsumerPlatform.CMS) {
+            tmpUrl = composeResourceUrlByPlatform(this.xlr.config, resourceUrlParams);
+          } else if (this.xlr.config.platform === exports.ConsumerPlatform.CHROMEOS) {
+            tmpUrl = composeResourceUrl(this.xlr.config, resourceUrlParams);
+            if (this.mediaType === 'image' || this.mediaType === 'video' || this.mediaType === 'audio') {
+              tmpUrl = composeMediaUrl(resourceUrlParams);
+              // this is an SSP Layout
+              if (this.region.layout.layoutId === -1) {
+                tmpUrl = this.uri;
+              }
+            }
+          } else if (this.xlr.config.platform === exports.ConsumerPlatform.ELECTRON) {
+            tmpUrl = composeResourceUrlByPlatform(this.xlr.config, resourceUrlParams);
             // this is an SSP Layout
             if (this.region.layout.layoutId === -1) {
               tmpUrl = this.uri;
             }
           }
-        } else if (this.xlr.config.platform === exports.ConsumerPlatform.ELECTRON) {
-          tmpUrl = composeResourceUrlByPlatform(this.xlr.config, resourceUrlParams);
-          // this is an SSP Layout
-          if (this.region.layout.layoutId === -1) {
-            tmpUrl = this.uri;
-          }
+          this.url = tmpUrl;
         }
-        this.url = tmpUrl;
         // Loop if media has loop, or if region has loop and a single media
         this.loop = this.options['loop'] == '1' || this.region.options['loop'] == '1' && this.region.totalMediaObjects == 1;
         this.html = createMediaElement(this);
@@ -74332,8 +74351,39 @@ ${segmentInfoString(segmentInfo)}`); // If there's an init segment associated wi
           }
           return null;
         };
+        // SSP widget: if the consumer did not resolve an ad during the preload window
+        // (i.e. setSspAdUrl was never called), skip this widget and advance normally.
+        if (this.mediaType === 'ssp') {
+          console.debug('??? XLR.debug >> Media.run() > SSP widget: no ad resolved during preload, skipping');
+          this.emitter.emit('end', this);
+          return;
+        }
         showCurrentMedia();
       }
+    }, {
+      key: "setSspAdUrl",
+      value: function setSspAdUrl(url, adMediaType, impressionUrls, errorUrls) {
+        // Ignore if the media has already been skipped or cancelled before the ad arrived.
+        if (this.state !== MediaState.IDLE) {
+          console.debug('??? XLR.debug >> Media::setSspAdUrl - ignoring, media is no longer idle', {
+            state: this.state
+          });
+          return;
+        }
+        // Remove the placeholder <div> so the correct element type can take its place.
+        if (this.html) {
+          this.html.remove();
+          this.html = null;
+        }
+        this.url = url;
+        this.mediaType = adMediaType;
+        this.sspImpressionUrls = impressionUrls;
+        this.sspErrorUrls = errorUrls;
+        // Re-create the element now that mediaType is known, then prepare and append to region DOM.
+        // Visibility and playback are handled by run() when this media's turn comes.
+        this.html = createMediaElement(this);
+        this.region.prepareMedia(this);
+      }
     }, {
       key: "stop",
       value: function () {
@@ -74586,6 +74636,13 @@ ${segmentInfoString(segmentInfo)}`); // If there's an init segment associated wi
     }, {
       key: "prepareMedia",
       value: function prepareMedia(media) {
+        // SSP widget: signal the consumer to fetch an ad before this media's turn to play.
+        // The consumer calls media.setSspAdUrl() to resolve it; if it never arrives,
+        // Media.run() skips the widget and advances normally.
+        if (media.mediaType === 'ssp') {
+          this.xlr.emitter.emit('sspWidgetRequest', media);
+          return;
+        }
         if (media.mediaType === 'video') {
           prepareVideoMedia(media, this);
         } else if (media.mediaType === 'image' && media.url !== null) {
@@ -74802,7 +74859,12 @@ ${segmentInfoString(segmentInfo)}`); // If there's an init segment associated wi
             }
           };
           if (oldMedia) {
-            hideOldMedia();
+            // Skip hiding old media when it is the same object as new media
+            // (single-media loop): removing it would also remove the element
+            // that is about to be shown, leaving the region blank.
+            if (oldMedia !== newMedia) {
+              hideOldMedia();
+            }
             newMedia.run();
           } else {
             newMedia.run();