Class Engine

customClipTypes

Readonly events

callStaticCustomClipMethod

• callStaticCustomClipMethod(typeEnum, methodName, ...args): any

• Parameters

  • typeEnum: string
  • methodName: string
  • Rest ...args: any[]

  Returns any

createCustomClipInstance

• createCustomClipInstance<T>(typeEnum, ...args): T

• Type Parameters

  • T extends CustomClip = CustomClip

  Parameters

  • typeEnum: string
  • Rest ...args: any[]

  Returns T

destroy

• destroy(): void

• Returns void

export

• export(path): Promise<Blob>

• Parameters

  • path: string

  Returns Promise<Blob>

getClipById

• getClipById(clipId): undefined | Clip<Sprite, ClipStyle<Sprite>>

• Parameters

  • clipId: string

  Returns undefined | Clip<Sprite, ClipStyle<Sprite>>

getClipsIdsForPoint

• getClipsIdsForPoint(x, y): null

• Parameters

  • x: number
  • y: number

  Returns null

getDisplay

• getDisplay(): Display

• Returns Display

getFFmpeg

• getFFmpeg(): FFmpeg

• Returns FFmpeg

getFontRegistry

• getFontRegistry(): FontRegistry

• Returns FontRegistry

getLibrary

• getLibrary(): Library

• Returns Library

getRenderer

• getRenderer(): PixiRenderer

• Returns PixiRenderer

getRendererStage

• getRendererStage(): null | Container<DisplayObject>

• Returns null | Container<DisplayObject>

getSubtitlesManager

• getSubtitlesManager(): SubtitleManager

• Returns SubtitleManager

getTimeline

• getTimeline(): Timeline

• Returns Timeline

hasCustomClipType

• hasCustomClipType(typeEnum): boolean

• Parameters

  • typeEnum: string

  Returns boolean

init

• init(options): Promise<void>

• Parameters

  • options: EngineOptions

  Returns Promise<void>

isInitialized

• isInitialized(): boolean

• Returns boolean

isRendering

• isRendering(): boolean

• Returns boolean

pause

• pause(): Promise<void>

• Returns Promise<void>

play

• play(): Promise<void>

• Returns Promise<void>

registerCustomClip

• registerCustomClip<T>(classType, typeEnum): void

• Type Parameters

  • T extends CustomClip = CustomClip

  Parameters

  • classType: CustomClipConstructor<T>
  • typeEnum: string

  Returns void

seek

• seek(value): Promise<void>

• Parameters

  • value: number

  Returns Promise<void>

serialize

• serialize(): {
      display: {
          backgroundColor: string;
          height: number;
          width: number;
      };
      library: {
          media: {
              filename: string;
              id: string;
              permanentUrl?: string;
              type: string;
          }[];
          subtitles: {
              duration: number;
              id: string;
              language: string;
              textBlocks: {
                  duration: number;
                  text: string;
                  time: number;
              }[];
          }[];
      };
      timeline: {
          fps: number;
          layers: {
              clips: any[];
              id: string;
              isEnabled: boolean;
              isMuted: boolean;
              transitions: {
                  endClipId: string;
                  id: string;
                  inDuration: number;
                  name: string;
                  outDuration: number;
                  startClipId: string;
                  transitionSrc: string;
                  type: "transition";
              }[];
          }[];
          startTime: number;
      };
      version?: string;
  }

• Returns {
      display: {
          backgroundColor: string;
          height: number;
          width: number;
      };
      library: {
          media: {
              filename: string;
              id: string;
              permanentUrl?: string;
              type: string;
          }[];
          subtitles: {
              duration: number;
              id: string;
              language: string;
              textBlocks: {
                  duration: number;
                  text: string;
                  time: number;
              }[];
          }[];
      };
      timeline: {
          fps: number;
          layers: {
              clips: any[];
              id: string;
              isEnabled: boolean;
              isMuted: boolean;
              transitions: {
                  endClipId: string;
                  id: string;
                  inDuration: number;
                  name: string;
                  outDuration: number;
                  startClipId: string;
                  transitionSrc: string;
                  type: "transition";
              }[];
          }[];
          startTime: number;
      };
      version?: string;
  }

  • display: {
        backgroundColor: string;
        height: number;
        width: number;
    }

    • backgroundColor: string

    • height: number

    • width: number

  • library: {
        media: {
            filename: string;
            id: string;
            permanentUrl?: string;
            type: string;
        }[];
        subtitles: {
            duration: number;
            id: string;
            language: string;
            textBlocks: {
                duration: number;
                text: string;
                time: number;
            }[];
        }[];
    }

    • media: {
          filename: string;
          id: string;
          permanentUrl?: string;
          type: string;
      }[]

    • subtitles: {
          duration: number;
          id: string;
          language: string;
          textBlocks: {
              duration: number;
              text: string;
              time: number;
          }[];
      }[]

  • timeline: {
        fps: number;
        layers: {
            clips: any[];
            id: string;
            isEnabled: boolean;
            isMuted: boolean;
            transitions: {
                endClipId: string;
                id: string;
                inDuration: number;
                name: string;
                outDuration: number;
                startClipId: string;
                transitionSrc: string;
                type: "transition";
            }[];
        }[];
        startTime: number;
    }

    • fps: number

    • layers: {
          clips: any[];
          id: string;
          isEnabled: boolean;
          isMuted: boolean;
          transitions: {
              endClipId: string;
              id: string;
              inDuration: number;
              name: string;
              outDuration: number;
              startClipId: string;
              transitionSrc: string;
              type: "transition";
          }[];
      }[]

    • startTime: number

  • Optional version?: string

setSubtitles

• setSubtitles(subtitlesId, offset): void

• Parameters

  • subtitlesId: string
  • offset: number

  Returns void

shouldSplitAudio

• shouldSplitAudio(): boolean

• Returns boolean

stop

• stop(): Promise<void>

• Returns Promise<void>

Static deserialize

• deserialize(data): Promise<undefined | Engine>

• Parameters

  • data: object

  Returns Promise<undefined | Engine>

Static getInstance

• getInstance(): Engine

• Returns Engine