@xibosignage/xibo-layout-renderer 1.0.19 → 1.0.20

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

@@ -1,6 +1,9 @@
 import { Emitter, Unsubscribe, DefaultEvents } from 'nanoevents';
 import Player from 'video.js/dist/types/player';
 
+type PrepareLayoutsType = {
+    moveNext?: boolean;
+};
 declare enum ELayoutType {
     CURRENT = 0,
     NEXT = 1
@@ -8,12 +11,22 @@ declare enum ELayoutType {
 type IXlrEvents = {
     layoutChange: (layoutId: number) => void;
 };
+interface IXlrPlayback {
+    currentLayout: ILayout | undefined;
+    nextLayout: ILayout | undefined;
+    currentLayoutIndex: number;
+    nextLayoutIndex: number;
+    isCurrentLayoutValid: boolean;
+    hasDefaultOnly: boolean;
+}
 interface IXlr {
     inputLayouts: InputLayoutType[];
     config: OptionsType;
-    layouts: ILayout[];
+    layouts: {
+        [key: string]: ILayout;
+    };
     currentLayoutIndex: number;
-    currentLayoutId: number | null;
+    currentLayoutId: number;
     currentLayout: ILayout | undefined;
     nextLayout: ILayout | undefined;
     emitter: Emitter<IXlrEvents>;
@@ -21,11 +34,17 @@ interface IXlr {
     init(): Promise<IXlr>;
     playSchedules(xlr: IXlr): void;
     prepareLayoutXlf(inputLayout: ILayout | undefined): Promise<ILayout>;
-    prepareLayouts(): Promise<IXlr>;
+    prepareLayouts(playback: IXlrPlayback): Promise<IXlr>;
     updateLayouts(inputLayouts: InputLayoutType[]): void;
-    updateLoop(inputLayouts: InputLayoutType[]): void;
+    updateLoop(inputLayouts: InputLayoutType[]): Promise<void>;
     gotoPrevLayout(): void;
     gotoNextLayout(): void;
+    uniqueLayouts: {
+        [layoutId: string]: InputLayoutType;
+    };
+    getLayout(inputLayout: InputLayoutType): ILayout | undefined;
+    updateScheduleLayouts(scheduleLayouts: InputLayoutType[]): Promise<void>;
+    parseLayouts(loopUpdate?: boolean): IXlrPlayback;
 }
 declare const initialXlr: IXlr;
 
@@ -126,6 +145,7 @@ interface IRegion {
     on<E extends keyof IRegionEvents>(event: E, callback: IRegionEvents[E]): Unsubscribe;
     prepareMediaObjects(): void;
     reset(): void;
+    html: HTMLDivElement;
 }
 declare const initialRegion: IRegion;
 
@@ -174,8 +194,11 @@ declare class ActionController {
 }
 
 type InputLayoutType = {
-    layoutId: number | null;
+    response: any;
+    layoutId: number;
     path?: string;
+    index?: number;
+    id?: number;
 };
 type OptionsType = {
     xlfUrl: string;
@@ -197,10 +220,14 @@ type OptionsType = {
     previewTranslations?: {
         [k: string]: any;
     };
+    icons?: {
+        splashScreen: string;
+        logo: string;
+    };
 };
 interface ILayout {
     id: number | null;
-    layoutId: number | null;
+    layoutId: number;
     scheduleId?: number;
     sw: number | null;
     sh: number | null;
@@ -244,6 +271,7 @@ interface ILayout {
     xlr: IXlr;
     finishAllRegions(): Promise<void[]>;
     inLoop: boolean;
+    removeLayout(): void;
 }
 declare const initialLayout: ILayout;
 type GetLayoutParamType = {
@@ -252,6 +280,7 @@ type GetLayoutParamType = {
 };
 type GetLayoutType = {
     currentLayoutIndex: number;
+    nextLayoutIndex: number;
     inputLayouts: InputLayoutType[];
     current: ILayout | undefined;
     next: ILayout | undefined;
@@ -315,6 +344,7 @@ interface ISplashScreen {
 }
 interface PreviewSplashElement extends HTMLDivElement {
     hide: () => void;
+    show: () => void;
 }
 
 declare const defaultTrans: (duration: number, trans: 'in' | 'out') => {
@@ -408,4 +438,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, 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 };
+export { Action, ActionsWrapper, AudioMedia, ELayoutType, type GetLayoutParamType, type GetLayoutType, type ILayout, type ILayoutEvents, type IMedia, type IRegion, type IRegionEvents, type ISplashScreen, type IXlr, type IXlrEvents, 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, 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 };