Class Layer

constructor

• new Layer(): Layer

• Returns Layer

clips

clipsIds

container

id

isEnabled

isMuted

transitions

addClip

• addClip(options): Promise<null | Clip<Sprite, ClipStyle<Sprite>>>

• Parameters

  • options: Clip<Sprite, ClipStyle<Sprite>>

  Returns Promise<null | Clip<Sprite, ClipStyle<Sprite>>>

• addClip(options): Promise<null | Clip<Sprite, ClipStyle<Sprite>>>

• Parameters

  • options: ClipOptions

  Returns Promise<null | Clip<Sprite, ClipStyle<Sprite>>>

addTransition

• addTransition(transition): void

• Parameters

  • transition: Transition

  Returns void

adjustClipsLayout

• adjustClipsLayout(): void

• Returns void

destroy

• destroy(): void

• Returns void

getClipById

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

• Parameters

  • clipId: string

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

getDuration

• getDuration(): number

• Returns number

getNextEmptySpace

• getNextEmptySpace(startTime, endTime): number

• Parameters

  • startTime: number
  • endTime: number

  Returns number

hasEmptySpace

• hasEmptySpace(startTime, endTime): boolean

• Parameters

  • startTime: number
  • endTime: number

  Returns boolean

init

• init(): void

• Returns void

isEmpty

• isEmpty(): boolean

• Returns boolean

moveClipToLayer

• moveClipToLayer(clipId, newLayerId): void

• Parameters

  • clipId: string
  • newLayerId: string

  Returns void

onPause

• onPause(currentTime): void

• Parameters

  • currentTime: number

  Returns void

onPlay

• onPlay(currentTime): Promise<void>

• Parameters

  • currentTime: number

  Returns Promise<void>

onResize

• onResize(width, height): void

• Parameters

  • width: number
  • height: number

  Returns void

removeClip

• removeClip(clipId, shouldNotDestroy?): boolean

• Parameters

  • clipId: string
  • Optional shouldNotDestroy: boolean

  Returns boolean

removeTransition

• removeTransition(transitionId): void

• Parameters

  • transitionId: string

  Returns void

render

• render(currentTime): Container<DisplayObject>

• Parameters

  • currentTime: number

  Returns Container<DisplayObject>

serialize

• serialize(): {
      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";
      }[];
  }

• Returns {
      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";
      }[];
  }

  • 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";
    }[]

setZIndex

• setZIndex(zIndex): void

• Parameters

  • zIndex: number

  Returns void

splitClip

• splitClip(clipId, time): Promise<null | Clip<Sprite, ClipStyle<Sprite>>>

• Parameters

  • clipId: string
  • time: number

  Returns Promise<null | Clip<Sprite, ClipStyle<Sprite>>>

update

• update(currentTime): void

• Parameters

  • currentTime: number

  Returns void

Static deserialize

• deserialize(data): Layer

• Parameters

  • data: object

  Returns Layer