@xibosignage/xibo-layout-renderer 1.0.23 → 1.0.25

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

@@ -196,6 +196,7 @@ type IXlrEvents = {
     overlayEnd: (overlay: ILayout) => void;
     commandCodeReceived: (commandCode: string) => void;
     commandStringReceived: (commandString: string) => void;
+    navLayout: (layoutCode: string, url: string) => void;
 };
 interface IXlrPlayback {
     currentLayout: ILayout | undefined;
@@ -258,7 +259,6 @@ interface IVideoMediaHandler {
     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;
@@ -455,6 +455,7 @@ type InputLayoutType = {
     getXlf?(): string;
     duration?: number;
     isOverlay?: boolean;
+    shareOfVoice?: number;
 };
 type OptionsType = {
     xlfUrl: string;
@@ -570,7 +571,7 @@ 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;
+declare function composeBgUrlByPlatform(platform: OptionsType['platform'], params: ILayout): string;
 type LayoutIndexType = {
     [k: string]: InputLayoutType & {
         index: number;
@@ -582,6 +583,9 @@ declare function getIndexByLayoutId(layoutsInput: InputLayoutType[], layoutId?:
     index: number;
 };
 declare function isEmpty(input: any): boolean;
+declare function getAllAttributes(elem: Element): {
+    [k: string]: any;
+};
 /**
  * Create expiration day based on current date
  * @param numDays Number of days as expiry
@@ -596,8 +600,15 @@ declare function setExpiry(numDays: number): string;
  * @return boolean
  */
 declare function isLayoutValid(layouts: InputLayoutType[], layoutId: number | undefined): boolean;
+declare function getLayoutIndexByLayoutId(layouts: InputLayoutType[], layoutId: number): number | null;
 declare function hasDefaultOnly(inputLayouts: InputLayoutType[]): boolean;
+declare function hasSspLayout(inputLayouts: InputLayoutType[], defaultValue?: boolean): boolean;
 declare function createMediaElement(mediaObject: IMedia): HTMLElement;
+declare function prepareVideoMedia(media: IMedia, region: IRegion): void;
+declare function prepareImageMedia(media: IMedia, region: IRegion): void;
+declare function prepareAudioMedia(media: IMedia, region: IRegion): void;
+declare function prepareHtmlMedia(media: IMedia, region: IRegion): void;
+declare function playerReportFault(msg: string, media: IMedia): Promise<void>;
 
 declare class Region implements IRegion {
     layout: ILayout;
@@ -638,9 +649,6 @@ declare class Region implements IRegion {
     prepareNextMedia(): void;
     prepareMediaObjects(): void;
     finished(): void;
-    private prepareVideo;
-    private prepareImage;
-    private prepareIframe;
     run(): void;
     transitionNodes(oldMedia: IMedia | undefined, newMedia: IMedia | undefined): void;
     playNextMedia(): void;
@@ -753,4 +761,4 @@ type flyTransitionParams = {
 };
 declare const flyTransitionKeyframes: (params: flyTransitionParams) => KeyframeOptionsType;
 
-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 };
+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, getAllAttributes, getDataBlob, getFileExt, getIndexByLayoutId, getLayout, getLayoutIndexByLayoutId, getMediaId, getXlf, hasDefaultOnly, hasSspLayout, initRenderingDOM, initialLayout, initialMedia, initialRegion, initialXlr, isEmpty, isLayoutValid, nextId, playerReportFault, preloadMediaBlob, prepareAudioMedia, prepareHtmlMedia, prepareImageMedia, prepareVideoMedia, setExpiry, transitionElement, videoFileType, vjsDefaultOptions };