Class Layer

constructor

• new Layer(): Layer

• Returns Layer

clips

clipsIds

container

id

muted

transitions

visible

volume

addClip

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

• Parameters

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

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

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

• Parameters

  • options: ClipOptionsUnion

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

addTransition

• addTransition(data: Transition | TransitionOptions): void

• Parameters

  • data: Transition | TransitionOptions

  Returns void

adjustClipsLayout

• adjustClipsLayout(): void

• Returns void

destroy

• destroy(): void

• Returns void

getClipById

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

• Parameters

  • clipId: string

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

getDuration

• getDuration(): number

• Returns number

getNextEmptySpace

• getNextEmptySpace(startTime: number, endTime: number): number

• Parameters

  • startTime: number
  • endTime: number

  Returns number

getTransitions

• getTransitions(): Transition[]

• Returns Transition[]

getVisibility

• getVisibility(): boolean

• Returns boolean

getVolume

• getVolume(): number

• Returns number

hasEmptySpace

• hasEmptySpace(startTime: number, endTime: number): boolean

• Parameters

  • startTime: number
  • endTime: number

  Returns boolean

init

• init(): Promise<void>

• Returns Promise<void>

isEmpty

• isEmpty(): boolean

• Returns boolean

isMuted

• isMuted(): boolean

• Returns boolean

moveClipToLayer

• moveClipToLayer(clipId: string, newLayerId: string): void

• Parameters

  • clipId: string
  • newLayerId: string

  Returns void

onPause

• onPause(currentTime: number): void

• Parameters

  • currentTime: number

  Returns void

onPlay

• onPlay(currentTime: number): Promise<void>

• Parameters

  • currentTime: number

  Returns Promise<void>

onResize

• onResize(width: number, height: number): void

• Parameters

  • width: number
  • height: number

  Returns void

removeClip

• removeClip(clipId: string): boolean

• Parameters

  • clipId: string

  Returns boolean

removeTransition

• removeTransition(transitionId: string): void

• Parameters

  • transitionId: string

  Returns void

render

• render(currentTime: number): Container<DisplayObject>

• Parameters

  • currentTime: number

  Returns Container<DisplayObject>

serialize

• serialize(): {
      clips: any[];
      id: string;
      muted?: boolean;
      transitions: {
          endClipId: string;
          id: string;
          inDuration: number;
          name: string;
          outDuration: number;
          startClipId: string;
          transitionSrc: string;
          type: "transition";
      }[];
      visible?: boolean;
      volume?: number;
  }

• Returns {
      clips: any[];
      id: string;
      muted?: boolean;
      transitions: {
          endClipId: string;
          id: string;
          inDuration: number;
          name: string;
          outDuration: number;
          startClipId: string;
          transitionSrc: string;
          type: "transition";
      }[];
      visible?: boolean;
      volume?: number;
  }

setMuted

• setMuted(muted: boolean): void

• Parameters

  • muted: boolean

  Returns void

setVisibility

• setVisibility(visible: boolean): void

• Parameters

  • visible: boolean

  Returns void

setVolume

• setVolume(volume: number): void

• Parameters

  • volume: number

  Returns void

setZIndex

• setZIndex(zIndex: number): void

• Parameters

  • zIndex: number

  Returns void

splitClip

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

• Parameters

  • clipId: string
  • time: number

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

update

• update(currentTime: number): void

• Parameters

  • currentTime: number

  Returns void

Static_deserializeClip

• _deserializeClip(clipData: any): null | Clip<Sprite, ClipStyle<Sprite>>

• Parameters

  • clipData: any

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

Staticdeserialize

• deserialize(data: object): Layer

• Parameters

  • data: object

  Returns Layer