@xibosignage/xibo-layout-renderer 1.0.14 → 1.0.16

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

@@ -254,12 +254,29 @@ declare function nextId(options: {
 }): number;
 declare const getMediaId: ({ mediaType, containerName }: IMedia) => string;
 declare const capitalizeStr: (inputStr: string) => string;
+declare function getDataBlob(src: string): Promise<unknown>;
 type MediaTypes = 'video' | 'audio' | 'image';
 declare function preloadMediaBlob(src: string, type: MediaTypes): Promise<string>;
 declare function fetchJSON(url: string): Promise<any>;
+declare function fetchText(url: string): Promise<string>;
 declare function getFileExt(filename: string): string;
 declare function audioFileType(str: string): string | undefined;
 declare function videoFileType(str: string): string | undefined;
+declare function composeResourceUrlByPlatform(options: OptionsType, params: any): string;
+declare function composeResourceUrl(options: OptionsType, params: any): string;
+declare function composeMediaUrl(params: any): string;
+declare function composeBgUrlByPlatform(platform: OptionsType['platform'], params: any): string;
+type LayoutIndexType = {
+    [k: string]: InputLayoutType & {
+        index: number;
+    };
+};
+declare function getIndexByLayoutId(layoutsInput: InputLayoutType[], layoutId?: number | null): (InputLayoutType & {
+    index: number;
+}) | LayoutIndexType | {
+    index: number;
+};
+declare function isEmpty(input: any): boolean;
 /**
  * Create expiration day based on current date
  * @param numDays Number of days as expiry
@@ -269,6 +286,7 @@ declare function setExpiry(numDays: number): string;
 
 declare function VideoMedia(media: IMedia, xlr: IXlr): {
     init: () => void;
+    stop: (disposeOnly?: boolean) => void;
 };
 
 declare function AudioMedia(media: IMedia): {
@@ -379,4 +397,4 @@ type flyTransitionParams = {
 };
 declare const flyTransitionKeyframes: (params: flyTransitionParams) => KeyframeOptionsType;
 
-export { Action, ActionsWrapper, AudioMedia, ELayoutType, type GetLayoutParamType, type GetLayoutType, type ILayout, type ILayoutEvents, type IMedia, type IRegion, type IRegionEvents, type ISplashScreen, type IXlr, type InactOptions, type InputLayoutType, type KeyframeOptionsType, Media, type MediaTypes, type OptionsType, type PreviewSplashElement, Region, type TransitionElementOptions, type TransitionNameType, VideoMedia, audioFileType, capitalizeStr, type compassPoints, XiboLayoutRenderer as default, defaultTrans, fadeInElem, fadeOutElem, fetchJSON, flyInElem, flyOutElem, flyTransitionKeyframes, type flyTransitionParams, getFileExt, getLayout, getMediaId, getXlf, initRenderingDOM, initialLayout, initialMedia, initialRegion, initialXlr, nextId, platform, preloadMediaBlob, setExpiry, transitionElement, videoFileType };
+export { Action, ActionsWrapper, AudioMedia, ELayoutType, type GetLayoutParamType, type GetLayoutType, type ILayout, type ILayoutEvents, type IMedia, type IRegion, type IRegionEvents, type ISplashScreen, type IXlr, type InactOptions, type InputLayoutType, type KeyframeOptionsType, Media, type MediaTypes, type OptionsType, type PreviewSplashElement, Region, type TransitionElementOptions, type TransitionNameType, VideoMedia, audioFileType, capitalizeStr, type compassPoints, composeBgUrlByPlatform, composeMediaUrl, composeResourceUrl, composeResourceUrlByPlatform, XiboLayoutRenderer as default, defaultTrans, fadeInElem, fadeOutElem, fetchJSON, fetchText, flyInElem, flyOutElem, flyTransitionKeyframes, type flyTransitionParams, getDataBlob, getFileExt, getIndexByLayoutId, getLayout, getMediaId, getXlf, initRenderingDOM, initialLayout, initialMedia, initialRegion, initialXlr, isEmpty, nextId, platform, preloadMediaBlob, setExpiry, transitionElement, videoFileType };

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

@@ -795,6 +795,34 @@ function _fetchJSON() {
   }));
   return _fetchJSON.apply(this, arguments);
 }
+function fetchText(_x5) {
+  return _fetchText.apply(this, arguments);
+}
+function _fetchText() {
+  _fetchText = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee4(url) {
+    return _regeneratorRuntime().wrap(function _callee4$(_context4) {
+      while (1) switch (_context4.prev = _context4.next) {
+        case 0:
+          return _context4.abrupt("return", fetch(url).then(function (res) {
+            return res.text();
+          }).then(function (responseText) {
+            if (String(responseText).length > 0) {
+              return responseText;
+            } else {
+              return '';
+            }
+          })["catch"](function (err) {
+            console.debug(err);
+            return err === null || err === void 0 ? void 0 : err.message;
+          }));
+        case 1:
+        case "end":
+          return _context4.stop();
+      }
+    }, _callee4);
+  }));
+  return _fetchText.apply(this, arguments);
+}
 function getFileExt(filename) {
   var filenameArr = String(filename).split('.');
   return filenameArr[filenameArr.length - 1];
@@ -870,6 +898,9 @@ function getIndexByLayoutId(layoutsInput, layoutId) {
     index: 0
   };
 }
+function isEmpty$1(input) {
+  return !Boolean(input) || String(input).length === 0;
+}
 function getAllAttributes(elem) {
   if (!elem || elem === null) {
     return {};
@@ -72635,7 +72666,7 @@ function composeVideoSource($media, media) {
   return $media;
 }
 function VideoMedia(media, xlr) {
-  return {
+  var videoMediaInstance = {
     init: function init() {
       var vjsPlayer = media.player;
       if (vjsPlayer !== undefined) {
@@ -72663,10 +72694,10 @@ function VideoMedia(media, xlr) {
                       // Temporary setting
                       expires: format(new Date(setExpiry(1)), 'yyyy-MM-dd HH:mm:ss')
                     })["finally"](function () {
-                      // Expire the media and dispose the video
-                      vjsPlayer.dispose();
-                      media.emitter.emit('end', media);
+                      videoMediaInstance.stop();
                     });
+                  } else {
+                    videoMediaInstance.stop();
                   }
                 case 5:
                 case "end":
@@ -72686,88 +72717,130 @@ function VideoMedia(media, xlr) {
         });
         vjsPlayer.on('ready', function () {
           vjsPlayer.muted(true);
-          var promise = vjsPlayer.play();
-          if (promise !== undefined) {
-            promise.then(function () {
-              // Autoplay restarted
-              console.debug('autoplay started . . .');
-            })["catch"]( /*#__PURE__*/function () {
-              var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2(error) {
-                return _regeneratorRuntime().wrap(function _callee2$(_context2) {
-                  while (1) switch (_context2.prev = _context2.next) {
-                    case 0:
-                      console.debug("".concat(capitalizeStr(media.mediaType), " for media > ").concat(media.id, " autoplay error"));
-                      if (!(xlr.config.platform === 'chromeOS')) {
-                        _context2.next = 4;
-                        break;
-                      }
-                      _context2.next = 4;
-                      return playerReportFault('Media autoplay error');
-                    case 4:
-                    case "end":
-                      return _context2.stop();
-                  }
-                }, _callee2);
-              }));
-              return function (_x2) {
-                return _ref2.apply(this, arguments);
-              };
-            }());
-          }
+          // Race promise between a 0.5s play and a 5s skip
+          Promise.race([new Promise(function (resolve, reject) {
+            return setTimeout( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2() {
+              return _regeneratorRuntime().wrap(function _callee2$(_context2) {
+                while (1) switch (_context2.prev = _context2.next) {
+                  case 0:
+                    console.debug("".concat(capitalizeStr(media.mediaType), " for media > ").concat(media.id, " : Trying to force play after 0.1 seconds"));
+                    // Try to force play here
+                    _context2.prev = 1;
+                    _context2.next = 4;
+                    return vjsPlayer.play();
+                  case 4:
+                    // Resolve if play works
+                    resolve(true);
+                    _context2.next = 10;
+                    break;
+                  case 7:
+                    _context2.prev = 7;
+                    _context2.t0 = _context2["catch"](1);
+                    // Reject race if play fails
+                    reject('Play failed');
+                  case 10:
+                  case "end":
+                    return _context2.stop();
+                }
+              }, _callee2, null, [[1, 7]]);
+            })), 100);
+          }), new Promise(function (_, reject) {
+            return setTimeout(function () {
+              return reject('Timeout');
+            }, 5000);
+          })]).then(function () {
+            console.debug("".concat(capitalizeStr(media.mediaType), " for media > ").concat(media.id, " : Autoplay started"));
+          })["catch"]( /*#__PURE__*/function () {
+            var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee3(error) {
+              return _regeneratorRuntime().wrap(function _callee3$(_context3) {
+                while (1) switch (_context3.prev = _context3.next) {
+                  case 0:
+                    if (!(error === 'Timeout')) {
+                      _context3.next = 5;
+                      break;
+                    }
+                    console.debug("".concat(capitalizeStr(media.mediaType), " for media > ").concat(media.id, " : Promise not resolved within 5 seconds. Move to next media"));
+                    videoMediaInstance.stop();
+                    _context3.next = 9;
+                    break;
+                  case 5:
+                    console.debug("".concat(capitalizeStr(media.mediaType), " for media > ").concat(media.id, " : Autoplay error: ").concat(error));
+                    if (!(xlr.config.platform === 'chromeOS')) {
+                      _context3.next = 9;
+                      break;
+                    }
+                    _context3.next = 9;
+                    return playerReportFault('Media autoplay error');
+                  case 9:
+                  case "end":
+                    return _context3.stop();
+                }
+              }, _callee3);
+            }));
+            return function (_x2) {
+              return _ref3.apply(this, arguments);
+            };
+          }());
         });
         vjsPlayer.on('playing', function () {
           console.debug("".concat(capitalizeStr(media.mediaType), " for media > ").concat(media.id, " is now playing . . ."));
           vjsPlayer.muted(media.muted);
         });
         vjsPlayer.on('error', /*#__PURE__*/function () {
-          var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee3(err) {
-            return _regeneratorRuntime().wrap(function _callee3$(_context3) {
-              while (1) switch (_context3.prev = _context3.next) {
+          var _ref4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee4(err) {
+            return _regeneratorRuntime().wrap(function _callee4$(_context4) {
+              while (1) switch (_context4.prev = _context4.next) {
                 case 0:
                   console.debug("Media Error: ".concat(capitalizeStr(media.mediaType), " for media > ").concat(media.id));
                   if (!(xlr.config.platform === 'chromeOS')) {
-                    _context3.next = 6;
+                    _context4.next = 6;
                     break;
                   }
-                  _context3.next = 4;
+                  _context4.next = 4;
                   return playerReportFault('Video file source not supported');
                 case 4:
-                  _context3.next = 7;
+                  _context4.next = 7;
                   break;
                 case 6:
                   // End media after 5 seconds
                   setTimeout(function () {
                     console.debug("".concat(capitalizeStr(media.mediaType), " for media > ").concat(media.id, " has ended . . ."));
-                    media.emitter.emit('end', media);
-                    vjsPlayer.dispose();
+                    videoMediaInstance.stop();
                   }, 5000);
                 case 7:
                 case "end":
-                  return _context3.stop();
+                  return _context4.stop();
               }
-            }, _callee3);
+            }, _callee4);
           }));
           return function (_x3) {
-            return _ref3.apply(this, arguments);
+            return _ref4.apply(this, arguments);
           };
         }());
-        vjsPlayer.on('ended', function () {
-          var _media$emitter;
-          console.debug("VideoMedia: onended: ".concat(capitalizeStr(media.mediaType), " for media > ").concat(media.id, " has ended playing . . ."));
-          (_media$emitter = media.emitter) === null || _media$emitter === void 0 || _media$emitter.emit('end', media);
-          vjsPlayer.dispose();
-        });
-        vjsPlayer.on('durationchange', function () {
-          if (media.duration === 0 && vjsPlayer.duration() !== undefined) {
-            media.duration = vjsPlayer.duration();
-          } else if (media.duration > 0) {
-            vjsPlayer.duration(media.duration);
-          }
-          console.debug('VIDEOJS: ondurationchange: Showing Media ' + media.id + ' for ' + vjsPlayer.duration() + 's of Region ' + media.region.regionId);
-        });
+        if (media.duration === 0) {
+          vjsPlayer.on('ended', function () {
+            console.debug("VideoMedia: onended: ".concat(capitalizeStr(media.mediaType), " for media > ").concat(media.id, " has ended playing . . ."));
+            videoMediaInstance.stop();
+          });
+          vjsPlayer.on('durationchange', function () {
+            console.debug('VIDEOJS: ondurationchange: Showing Media ' + media.id + ' for ' + vjsPlayer.duration() + 's of Region ' + media.region.regionId);
+          });
+        }
+      }
+    },
+    stop: function stop() {
+      var disposeOnly = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
+      var vjsPlayer = media.player;
+      // Expire the media and dispose the video
+      if (vjsPlayer !== undefined) {
+        if (!disposeOnly) {
+          media.emitter.emit('end', media);
+        }
+        vjsPlayer.dispose();
       }
     }
   };
+  return videoMediaInstance;
 }
 
 function AudioMedia(media) {
@@ -72847,6 +72920,11 @@ function Media(region, mediaId, xml, options, xlr) {
       if (mediaTimeCount > media.duration) {
         console.debug('startMediaTimer: emit>end: on media ' + media.id + ' of Region ' + media.region.regionId);
         media.emitter.emit('end', media);
+        if (media.mediaType === 'video') {
+          // Dispose the video media
+          console.debug("VideoMedia::stop - ".concat(capitalizeStr(media.mediaType), " for media ").concat(media.id, " has been stopped."));
+          VideoMedia(media, xlr).stop(true);
+        }
       }
     }, 1000);
     console.debug('startMediaTimer: Showing Media ' + media.id + ' for ' + media.duration + 's of Region ' + media.region.regionId);
@@ -74643,5 +74721,5 @@ function XiboLayoutRenderer(inputLayouts, options) {
   return xlrObject;
 }
 
-export { Action, ActionsWrapper, AudioMedia, ELayoutType, Media, Region, VideoMedia, audioFileType, capitalizeStr, XiboLayoutRenderer as default, defaultTrans, fadeInElem, fadeOutElem, fetchJSON, flyInElem, flyOutElem, flyTransitionKeyframes, getFileExt, getLayout, getMediaId, getXlf, initRenderingDOM, initialLayout, initialMedia, initialRegion, initialXlr, nextId, platform, preloadMediaBlob, setExpiry, transitionElement, videoFileType };
+export { Action, ActionsWrapper, AudioMedia, ELayoutType, Media, Region, VideoMedia, audioFileType, capitalizeStr, composeBgUrlByPlatform, composeMediaUrl, composeResourceUrl, composeResourceUrlByPlatform, XiboLayoutRenderer as default, defaultTrans, fadeInElem, fadeOutElem, fetchJSON, fetchText, flyInElem, flyOutElem, flyTransitionKeyframes, getDataBlob, getFileExt, getIndexByLayoutId, getLayout, getMediaId, getXlf, initRenderingDOM, initialLayout, initialMedia, initialRegion, initialXlr, isEmpty$1 as isEmpty, nextId, platform, preloadMediaBlob, setExpiry, transitionElement, videoFileType };
 //# sourceMappingURL=xibo-layout-renderer.esm.js.map