Class Layer

constructor

• new Layer(): Layer

  Returns Layer

clips

clipsIds

container

id

muted

name

transitions

visible

volume

addClip

• addClip(
      clipOptions: Clip,
      addClipOptions?: AddClipOptions,
  ): Promise<null | Clip<Sprite, ClipStyle<Sprite>>>

  Parameters

  • clipOptions: Clip
  • OptionaladdClipOptions: AddClipOptions

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

• addClip(
      clipOptions: ClipOptionsUnion,
      addClipOptions?: AddClipOptions,
  ): Promise<null | Clip<Sprite, ClipStyle<Sprite>>>

  Parameters

  • clipOptions: ClipOptionsUnion
  • OptionaladdClipOptions: AddClipOptions

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

addTransition

• addTransition(data: TransitionOptions | Transition): string

  Parameters

  • data: TransitionOptions | Transition

  Returns string

adjustClipsLayout

• adjustClipsLayout(): void

  Returns void

clearAllCustomData

• clearAllCustomData(): void

  Returns void

destroy

• destroy(): void

  Returns void

getAllCustomData

• getAllCustomData(): undefined | Map<string, unknown>

  Returns undefined | Map<string, unknown>

getClipById

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

  Parameters

  • clipId: string

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

getClipIds

• getClipIds(): string[]

  Returns string[]

getClips

• getClips(): Record<string, Clip<Sprite, ClipStyle<Sprite>>>

  Returns Record<string, Clip<Sprite, ClipStyle<Sprite>>>

getCustomData

• getCustomData(key: string): unknown

  Parameters

  • key: string

  Returns unknown

getDuration

• getDuration(): number

  Returns number

getName

• getName(): string

  Returns string

getNextEmptySpace

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

  Parameters

  • startTime: number
  • endTime: number

  Returns number

getTransitionById

• getTransitionById(id: string): null | Transition

  Parameters

  • id: string

  Returns null | Transition

getTransitions

• getTransitions(): Transition[]

  Returns Transition[]

getVisibility

• getVisibility(): boolean

  Returns boolean

getVolume

• getVolume(): number

  Returns number

hasCustomData

• hasCustomData(key: string): boolean

  Parameters

  • key: string

  Returns boolean

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

postRender

• postRender(currentTime: number): void

  Parameters

  • currentTime: number

  Returns void

removeAllTransitionsByTransitionId

• removeAllTransitionsByTransitionId(transitionId: string): void

  Parameters

  • transitionId: string

  Returns void

removeClip

• removeClip(clipId: string): boolean

  Parameters

  • clipId: string

  Returns boolean

removeTransition

• removeTransition(id: string): void

  Parameters

  • id: string

  Returns void

render

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

  Parameters

  • currentTime: number

  Returns Container<DisplayObject>

serialize

• serialize(): {
      clips: any[];
      customData?: [string, unknown][];
      id: string;
      muted?: boolean;
      name?: string;
      transitions: {
          endClipId: string;
          id: string;
          inDuration: number;
          outDuration: number;
          properties: [string, any][];
          provider: string;
          startClipId: string;
          transitionId: string;
      }[];
      visible?: boolean;
      volume?: number;
  }

  Returns {
      clips: any[];
      customData?: [string, unknown][];
      id: string;
      muted?: boolean;
      name?: string;
      transitions: {
          endClipId: string;
          id: string;
          inDuration: number;
          outDuration: number;
          properties: [string, any][];
          provider: string;
          startClipId: string;
          transitionId: string;
      }[];
      visible?: boolean;
      volume?: number;
  }

setAllCustomData

• setAllCustomData(data: Map<string, unknown>): void

  Parameters

  • data: Map<string, unknown>

  Returns void

setCustomData

• setCustomData(key: string, value: unknown, overwrite?: boolean): boolean

  Parameters

  • key: string
  • value: unknown
  • overwrite: boolean = true

  Returns boolean

setMuted

• setMuted(muted: boolean): void

  Parameters

  • muted: boolean

  Returns void

setName

• setName(name: string): void

  Parameters

  • name: string

  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