@xibosignage/xibo-layout-renderer 1.0.26 → 1.0.27

package/dist/xibo-layout-renderer.d.ts

@@ -191,6 +191,8 @@ type IXlrEvents = {
     widgetEnd: (widgetId: number) => void;
     widgetError: (widgetId: number) => void;
     adRequest: (sspLayoutIndex: number) => void;
+    sspWidgetRequest: (media: IMedia) => void;
+    sspWidgetEnd: (impressionUrls: string[], errorUrls: string[], duration: number) => void;
     updateLoop: (inputLayouts: InputLayoutType[]) => void;
     updateOverlays: (overlays: InputLayoutType[]) => void;
     overlayStart: (overlay: ILayout) => void;
@@ -315,6 +317,9 @@ declare class Media implements IMedia {
     xml: Element | null;
     videoHandler?: IVideoMediaHandler;
     mediaTimer: ReturnType<typeof setInterval> | undefined;
+    sspImpressionUrls: string[] | undefined;
+    sspErrorUrls: string[] | undefined;
+    private isSspWidget;
     private mediaTimeCount;
     private xlr;
     private readonly statsBC;
@@ -324,6 +329,7 @@ declare class Media implements IMedia {
     private on;
     private init;
     run(): void;
+    setSspAdUrl(url: string, adMediaType: 'image' | 'video', impressionUrls?: string[], errorUrls?: string[]): void;
     stop(): Promise<void>;
     /**
      * Emits a command from the shell command widget.
@@ -376,6 +382,9 @@ interface IMedia {
     region: IRegion;
     render: string;
     run(): void;
+    setSspAdUrl(url: string, adMediaType: 'image' | 'video', impressionUrls?: string[], errorUrls?: string[]): void;
+    sspImpressionUrls: string[] | undefined;
+    sspErrorUrls: string[] | undefined;
     schemaVersion: string;
     singlePlay: boolean;
     state: MediaState;
@@ -424,6 +433,7 @@ interface IRegion {
     };
     playNextMedia(): void;
     playPreviousMedia(): void;
+    prepareMedia(media: IMedia): void;
     prepareMediaObjects(): void;
     prepareRegion(): void;
     ready: boolean;

package/dist/xibo-layout-renderer.esm.js

@@ -752,6 +752,7 @@ var initialRegion = {
   options: {},
   playNextMedia: function playNextMedia() {},
   playPreviousMedia: function playPreviousMedia() {},
+  prepareMedia: function prepareMedia(_media) {},
   prepareMediaObjects: function prepareMediaObjects() {},
   prepareRegion: function prepareRegion() {},
   ready: false,
@@ -73982,6 +73983,9 @@ var Media = /*#__PURE__*/function () {
     _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'));
@@ -74067,6 +74071,10 @@ var Media = /*#__PURE__*/function () {
         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) {
@@ -74093,6 +74101,10 @@ var Media = /*#__PURE__*/function () {
         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
@@ -74193,26 +74205,33 @@ var Media = /*#__PURE__*/function () {
       if (this.mediaType === 'image' || this.mediaType === 'video') {
         resourceUrlParams.mediaType = this.mediaType;
       }
-      var tmpUrl = '';
-      if (this.xlr.config.platform === ConsumerPlatform.CMS) {
-        tmpUrl = composeResourceUrlByPlatform(this.xlr.config, resourceUrlParams);
-      } else if (this.xlr.config.platform === 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 === ConsumerPlatform.CMS) {
+          tmpUrl = composeResourceUrlByPlatform(this.xlr.config, resourceUrlParams);
+        } else if (this.xlr.config.platform === 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 === 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 === 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);
@@ -74329,8 +74348,39 @@ var Media = /*#__PURE__*/function () {
         }
         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 () {
@@ -74583,6 +74633,13 @@ var Region = /*#__PURE__*/function () {
   }, {
     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) {
@@ -74799,7 +74856,12 @@ var Region = /*#__PURE__*/function () {
           }
         };
         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();