@xibosignage/xibo-layout-renderer 1.0.7 → 1.0.9

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

@@ -30,6 +30,7 @@ interface IMediaEvents {
     start: (media: IMedia) => void;
     end: (media: IMedia) => void;
 }
+declare function Media(region: IRegion, mediaId: string, xml: Element, options: OptionsType, xlr: IXlr): IMedia;
 
 interface IMedia {
     checkIframeStatus: boolean;
@@ -122,6 +123,9 @@ interface IRegion {
 }
 declare const initialRegion: IRegion;
 
+declare function initRenderingDOM(targetContainer: Element | null): void;
+declare function getXlf(layoutOptions: OptionsType): Promise<string>;
+declare function getLayout(params: GetLayoutParamType): GetLayoutType;
 interface ILayoutEvents {
     start: (layout: ILayout) => void;
     end: (layout: ILayout) => void;
@@ -239,4 +243,134 @@ type GetLayoutType = {
 
 declare function XiboLayoutRenderer(inputLayouts: InputLayoutType[], options?: OptionsType): IXlr;
 
-export { ELayoutType, type GetLayoutParamType, type GetLayoutType, type ILayout, type IMedia, type IRegion, type IRegionEvents, type IXlr, type InputLayoutType, type OptionsType, XiboLayoutRenderer as default, initialLayout, initialMedia, initialRegion, initialXlr };
+declare function nextId(options: {
+    idCounter: number;
+}): number;
+declare const getMediaId: ({ mediaType, containerName }: IMedia) => string;
+declare const capitalizeStr: (inputStr: string) => string;
+type MediaTypes = 'video' | 'audio' | 'image';
+declare function preloadMediaBlob(src: string, type: MediaTypes): Promise<string>;
+declare function fetchJSON(url: string): Promise<any>;
+declare function getFileExt(filename: string): string;
+declare function audioFileType(str: string): string | undefined;
+declare function videoFileType(str: string): string | undefined;
+/**
+ * Create expiration day based on current date
+ * @param numDays Number of days as expiry
+ * @returns JSON string format of date
+ */
+declare function setExpiry(numDays: number): string;
+
+declare function VideoMedia(media: IMedia, xlr: IXlr): {
+    init(): void;
+};
+
+declare function AudioMedia(media: IMedia): {
+    init(): void;
+};
+
+declare const platform: OptionsType;
+
+declare function Region(layout: ILayout, xml: Element, regionId: string, options: OptionsType, xlr: IXlr): IRegion;
+
+interface ISplashScreen {
+    init: () => void;
+    show: () => void;
+    hide: () => void;
+}
+interface PreviewSplashElement extends HTMLDivElement {
+    hide: () => void;
+}
+
+declare const defaultTrans: (duration: number, trans: 'in' | 'out') => {
+    keyframes: {
+        display: string;
+    }[];
+    timing: KeyframeAnimationOptions;
+};
+declare const fadeInElem: (duration: number) => {
+    keyframes: {
+        opacity: number;
+    }[];
+    timing: KeyframeAnimationOptions;
+};
+declare const fadeOutElem: (duration: number) => {
+    keyframes: ({
+        opacity: number;
+        zIndex?: undefined;
+    } | {
+        opacity: number;
+        zIndex: number;
+    })[];
+    timing: KeyframeAnimationOptions;
+};
+type KeyframeOptionsType = {
+    from: {
+        [k: string]: any;
+    };
+    to: {
+        [k: string]: any;
+    };
+};
+declare const flyInElem: (duration: number, keyframeOptions: KeyframeOptionsType | undefined, direction?: string) => {
+    keyframes: ({
+        opacity: number;
+        zIndex?: undefined;
+    } | {
+        opacity: number;
+        zIndex: number;
+    })[];
+    timing: KeyframeAnimationOptions;
+};
+declare const flyOutElem: (duration: number, keyframeOptions: KeyframeOptionsType | undefined, direction?: string) => {
+    keyframes: Keyframe[];
+    timing: KeyframeAnimationOptions;
+};
+type TransitionNameType = 'fadeIn' | 'fadeOut' | 'flyIn' | 'flyOut' | 'defaultIn' | 'defaultOut';
+type TransitionElementOptions = {
+    duration: number;
+    keyframes?: KeyframeOptionsType;
+    direction?: string;
+};
+declare const transitionElement: (transition: TransitionNameType, options: TransitionElementOptions) => {
+    keyframes: {
+        display: string;
+    }[];
+    timing: KeyframeAnimationOptions;
+} | {
+    keyframes: {
+        opacity: number;
+    }[];
+    timing: KeyframeAnimationOptions;
+} | {
+    keyframes: ({
+        opacity: number;
+        zIndex?: undefined;
+    } | {
+        opacity: number;
+        zIndex: number;
+    })[];
+    timing: KeyframeAnimationOptions;
+} | {
+    keyframes: ({
+        opacity: number;
+        zIndex?: undefined;
+    } | {
+        opacity: number;
+        zIndex: number;
+    })[];
+    timing: KeyframeAnimationOptions;
+} | {
+    keyframes: Keyframe[];
+    timing: KeyframeAnimationOptions;
+};
+type compassPoints = 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW';
+type flyTransitionParams = {
+    trans: 'in' | 'out';
+    direction: compassPoints;
+    height: string | number;
+    width: string | number;
+};
+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 };