@xibosignage/xibo-layout-renderer 1.0.22 → 1.0.23

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

@@ -2,6 +2,55 @@ import * as nanoevents from 'nanoevents';
 import { Emitter, Unsubscribe, DefaultEvents } from 'nanoevents';
 import Player from 'video.js/dist/types/player';
 
+/**
+ * Centralized event type definitions
+ * All module events should be defined here
+ */
+
+/**
+ * Events emitted by Layout
+ */
+interface ILayoutEvents {
+    start: (layout: ILayout) => void;
+    end: (layout: ILayout) => void;
+    cancelled: (layout: ILayout) => void;
+    layoutStart?: (layout: ILayout) => void;
+    layoutEnd?: (layout: ILayout) => void;
+}
+/**
+ * Events emitted by Region
+ */
+interface IRegionEvents {
+    start: (region: IRegion) => void;
+    end: (region: IRegion) => void;
+}
+/**
+ * Events emitted by Media
+ */
+interface IMediaEvents {
+    start: (media: IMedia) => void;
+    end: (media: IMedia) => void;
+    cancelled: (media: IMedia) => void;
+}
+/**
+ * Type alias for event unsubscriber
+ */
+type EventUnsubscriber = () => void;
+type EventEmitter<T> = <K extends keyof T>(event: K, ...args: Parameters<T[K] extends (...args: any[]) => any ? T[K] : never>) => void;
+
+declare enum ConsumerPlatform {
+    CMS = "CMS",
+    CHROMEOS = "chromeOS",
+    ELECTRON = "electron",
+    IOS = "ios",
+    MACOS = "macos",
+    ANDROID = "android",
+    LINUX = "linux",
+    WINDOWS = "windows",
+    WEBOS = "webos",
+    TIZEN = "tizen"
+}
+
 declare class Action {
     readonly id: string;
     readonly xml: Element;
@@ -83,6 +132,7 @@ declare class Layout implements ILayout {
     layoutNode?: Document;
     path?: string;
     errorCode: number | null;
+    html: HTMLElement | null;
     options: OptionsType;
     xlr: IXlr;
     private readonly layoutObj;
@@ -94,11 +144,11 @@ declare class Layout implements ILayout {
     playRegions(): void;
     regionExpired(): void;
     end(): void;
-    regionEnded(): Promise<void>;
+    regionEnded(): void;
     stopAllMedia(): Promise<void>;
     resetLayout(): Promise<void>;
     finishAllRegions(): Promise<void[]>;
-    removeLayout(): void;
+    removeLayout(caller?: LayoutPlaybackType): void;
     getXlf(): string;
     isInterrupt(): boolean;
     on<E extends keyof ILayoutEvents>(event: E, callback: ILayoutEvents[E]): nanoevents.Unsubscribe;
@@ -144,6 +194,8 @@ type IXlrEvents = {
     updateOverlays: (overlays: InputLayoutType[]) => void;
     overlayStart: (overlay: ILayout) => void;
     overlayEnd: (overlay: ILayout) => void;
+    commandCodeReceived: (commandCode: string) => void;
+    commandStringReceived: (commandString: string) => void;
 };
 interface IXlrPlayback {
     currentLayout: ILayout | undefined;
@@ -179,7 +231,7 @@ interface IXlr {
     overlays: InputLayoutType[];
     parseLayouts(loopUpdate?: boolean): IXlrPlayback;
     playLayouts(xlr: IXlr): void;
-    playSchedules(xlr: IXlr): void;
+    playSchedules(xlr: IXlr): Promise<void>;
     prepareForSsp(nextLayout: ILayout): Promise<ILayout>;
     prepareLayoutXlf(inputLayout: ILayout | undefined): Promise<ILayout>;
     prepareLayouts(): Promise<IXlr>;
@@ -193,10 +245,27 @@ interface IXlr {
 }
 declare const initialXlr: IXlr;
 
-interface IMediaEvents {
-    start: (media: IMedia) => void;
-    end: (media: IMedia) => void;
+declare function composeVideoSource($media: HTMLVideoElement, media: IMedia): HTMLVideoElement;
+declare const defaultVjsOpts: {
+    autoplay: boolean;
+    muted: boolean;
+    preload: string;
+    controls: boolean;
+};
+declare const vjsDefaultOptions: (opts?: any) => any;
+interface IVideoMediaHandler {
+    player: Player | undefined;
+    duration: number;
+    stop(disposeOnly?: boolean): void;
 }
+declare function videoMediaHandler(media: IMedia, platform: OptionsType['platform']): IVideoMediaHandler;
+declare function VideoMedia(media: IMedia, xlr: IXlr): {
+    duration: number;
+    init: () => void;
+    stop: (disposeOnly?: boolean) => void;
+    play: () => void;
+};
+
 declare class Media implements IMedia {
     attachedAudio: boolean;
     checkIframeStatus: boolean;
@@ -236,23 +305,37 @@ declare class Media implements IMedia {
     url: string | null;
     useDuration: boolean;
     xml: Element | null;
-    private mediaTimer;
+    videoHandler?: IVideoMediaHandler;
+    mediaTimer: ReturnType<typeof setInterval> | undefined;
     private mediaTimeCount;
     private xlr;
     private readonly statsBC;
+    private hasCommandExecuted;
     constructor(region: IRegion, mediaId: string, xml: Element, options: OptionsType, xlr: IXlr);
     private startMediaTimer;
     private on;
     private init;
     run(): void;
     stop(): Promise<void>;
+    /**
+     * Emits a command from the shell command widget.
+     *
+     * @param media
+     * @private
+     */
+    private emitCommand;
 }
 
-type MediaState = 'idle' | 'playing' | 'ended';
+declare function AudioMedia(media: IMedia): {
+    init(): void;
+};
+
+type MediaState = 'idle' | 'playing' | 'ended' | 'cancelled';
 declare const MediaState: {
     readonly IDLE: "idle";
     readonly PLAYING: "playing";
     readonly ENDED: "ended";
+    readonly CANCELLED: "cancelled";
 };
 interface IMedia {
     attachedAudio: boolean;
@@ -295,18 +378,16 @@ interface IMedia {
     url: string | null;
     useDuration: boolean;
     xml: Element | null;
+    videoHandler?: IVideoMediaHandler;
+    mediaTimer: ReturnType<typeof setInterval> | undefined;
 }
 declare const initialMedia: IMedia;
 
-interface IRegionEvents {
-    start: (layout: IRegion) => void;
-    end: (layout: IRegion) => void;
-}
 interface IRegion {
     complete: boolean;
     containerName: string;
     currMedia: IMedia | undefined;
-    currEl: HTMLElement | undefined;
+    currEl: HTMLElement | null;
     currentMedia: number;
     currentMediaIndex: number;
     emitter?: Emitter<DefaultEvents>;
@@ -323,7 +404,7 @@ interface IRegion {
     mediaObjects: IMedia[];
     mediaObjectsActions: IMedia[];
     nxtMedia: IMedia | undefined;
-    nxtEl: HTMLElement | undefined;
+    nxtEl: HTMLElement | null;
     offsetX: number;
     offsetY: number;
     oldMedia: IMedia | undefined;
@@ -347,14 +428,11 @@ interface IRegion {
     uniqueId: string;
     xml: null | Element;
     zIndex: number;
+    prepareNextMedia(): void;
+    xlr: IXlr;
 }
 declare const initialRegion: IRegion;
 
-interface ILayoutEvents {
-    start: (layout: ILayout) => void;
-    end: (layout: ILayout) => void;
-    cancelled: (layout: ILayout) => void;
-}
 declare enum ELayoutState {
     IDLE = 0,
     RUNNING = 1,
@@ -362,6 +440,11 @@ declare enum ELayoutState {
     CANCELLED = 3,
     ERROR = 4
 }
+declare enum LayoutPlaybackType {
+    CURRENT = "current",
+    NEXT = "next",
+    OVERLAY = "overlay"
+}
 type InputLayoutType = {
     response: any;
     layoutId: number;
@@ -383,7 +466,7 @@ type OptionsType = {
     idCounter: number;
     inPreview: boolean;
     appHost?: string | null;
-    platform: 'CMS' | 'chromeOS';
+    platform: ConsumerPlatform;
     config?: {
         cmsUrl: string | null;
         schemaVersion: number;
@@ -436,7 +519,7 @@ interface ILayout {
     on<E extends keyof ILayoutEvents>(event: E, callback: ILayoutEvents[E]): Unsubscribe;
     regionExpired(): void;
     end(): void;
-    regionEnded(): Promise<void>;
+    regionEnded(): void;
     stopAllMedia(): Promise<void>;
     resetLayout(): Promise<void>;
     index: number;
@@ -445,7 +528,7 @@ interface ILayout {
     xlr: IXlr;
     finishAllRegions(): Promise<void[]>;
     inLoop: boolean;
-    removeLayout(): void;
+    removeLayout(caller?: LayoutPlaybackType): void;
     xlfString: string;
     getXlf(): string;
     ad: any;
@@ -454,6 +537,7 @@ interface ILayout {
     isInterrupt(): boolean;
     state: ELayoutState;
     errorCode: number | null;
+    html: HTMLElement | null;
 }
 declare const initialLayout: ILayout;
 type GetLayoutParamType = {
@@ -513,19 +597,60 @@ declare function setExpiry(numDays: number): string;
  */
 declare function isLayoutValid(layouts: InputLayoutType[], layoutId: number | undefined): boolean;
 declare function hasDefaultOnly(inputLayouts: InputLayoutType[]): boolean;
+declare function createMediaElement(mediaObject: IMedia): HTMLElement;
 
-declare function composeVideoSource($media: HTMLVideoElement, media: IMedia): HTMLVideoElement;
-declare function VideoMedia(media: IMedia, xlr: IXlr): {
-    duration: number;
-    init: () => void;
-    stop: (disposeOnly?: boolean) => void;
-};
-
-declare function AudioMedia(media: IMedia): {
-    init(): void;
-};
-
-declare function Region(layout: ILayout, xml: Element, regionId: string, options: OptionsType, xlr: IXlr): IRegion;
+declare class Region implements IRegion {
+    layout: ILayout;
+    xml: Element | null;
+    regionId: string;
+    options: OptionsType;
+    xlr: IXlr;
+    complete: boolean;
+    containerName: string;
+    currMedia: IMedia | undefined;
+    currEl: HTMLElement | null;
+    currentMedia: number;
+    currentMediaIndex: number;
+    ended: boolean;
+    ending: boolean;
+    html: HTMLDivElement;
+    id: string;
+    index: number;
+    mediaObjects: IMedia[];
+    mediaObjectsActions: IMedia[];
+    nxtMedia: IMedia | undefined;
+    nxtEl: HTMLElement | null;
+    offsetX: number;
+    offsetY: number;
+    oldMedia: IMedia | undefined;
+    oneMedia: boolean;
+    ready: boolean;
+    sHeight: number;
+    sWidth: number;
+    totalMediaObjects: number;
+    uniqueId: string;
+    zIndex: number;
+    emitter: nanoevents.Emitter<IRegionEvents>;
+    constructor(layout: ILayout, xml: Element, regionId: string, options: OptionsType, xlr: IXlr);
+    prepareRegion(): void;
+    prepareMedia(media: IMedia): void;
+    prepareFirstMedia(): void;
+    prepareNextMedia(): void;
+    prepareMediaObjects(): void;
+    finished(): void;
+    private prepareVideo;
+    private prepareImage;
+    private prepareIframe;
+    run(): void;
+    transitionNodes(oldMedia: IMedia | undefined, newMedia: IMedia | undefined): void;
+    playNextMedia(): void;
+    playPreviousMedia(): void;
+    end(): void;
+    exitTransition(): void;
+    exitTransitionComplete(): void;
+    reset(): void;
+    on<E extends keyof IRegionEvents>(event: E, callback: IRegionEvents[E]): nanoevents.Unsubscribe;
+}
 
 interface ISplashScreen {
     init: () => void;
@@ -628,4 +753,4 @@ type flyTransitionParams = {
 };
 declare const flyTransitionKeyframes: (params: flyTransitionParams) => KeyframeOptionsType;
 
-export { Action, ActionsWrapper, AudioMedia, ELayoutState, ELayoutType, type GetLayoutParamType, type GetLayoutType, type ILayout, type ILayoutEvents, type IMedia, type IMediaEvents, type IRegion, type IRegionEvents, type ISplashScreen, type IXlr, type IXlrEvents, type IXlrPlayback, type InactOptions, type InputLayoutType, type KeyframeOptionsType, Media, type MediaTypes, type OptionsType, type PrepareLayoutsType, type PreviewSplashElement, Region, type TransitionElementOptions, type TransitionNameType, VideoMedia, audioFileType, capitalizeStr, type compassPoints, composeBgUrlByPlatform, composeMediaUrl, composeResourceUrl, composeResourceUrlByPlatform, composeVideoSource, XiboLayoutRenderer as default, defaultTrans, fadeInElem, fadeOutElem, fetchJSON, fetchText, flyInElem, flyOutElem, flyTransitionKeyframes, type flyTransitionParams, getDataBlob, getFileExt, getIndexByLayoutId, getLayout, getMediaId, getXlf, hasDefaultOnly, initRenderingDOM, initialLayout, initialMedia, initialRegion, initialXlr, isEmpty, isLayoutValid, nextId, preloadMediaBlob, setExpiry, transitionElement, videoFileType };
+export { Action, ActionsWrapper, AudioMedia, ConsumerPlatform, ELayoutState, ELayoutType, type EventEmitter, type EventUnsubscriber, type GetLayoutParamType, type GetLayoutType, type ILayout, type ILayoutEvents, type IMedia, type IMediaEvents, type IRegion, type IRegionEvents, type ISplashScreen, type IVideoMediaHandler, type IXlr, type IXlrEvents, type IXlrPlayback, type InactOptions, type InputLayoutType, type KeyframeOptionsType, LayoutPlaybackType, Media, MediaState, type MediaTypes, type OptionsType, type PrepareLayoutsType, type PreviewSplashElement, Region, type TransitionElementOptions, type TransitionNameType, VideoMedia, audioFileType, capitalizeStr, type compassPoints, composeBgUrlByPlatform, composeMediaUrl, composeResourceUrl, composeResourceUrlByPlatform, composeVideoSource, createMediaElement, XiboLayoutRenderer as default, defaultTrans, defaultVjsOpts, fadeInElem, fadeOutElem, fetchJSON, fetchText, flyInElem, flyOutElem, flyTransitionKeyframes, type flyTransitionParams, getDataBlob, getFileExt, getIndexByLayoutId, getLayout, getMediaId, getXlf, hasDefaultOnly, initRenderingDOM, initialLayout, initialMedia, initialRegion, initialXlr, isEmpty, isLayoutValid, nextId, preloadMediaBlob, setExpiry, transitionElement, videoFileType, videoMediaHandler, vjsDefaultOptions };