Class Layer

constructor

• new Layer(): Layer

  Creates an empty layer and records its creation in the undo stack.

  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

  Adds a transition between clips on this layer.

  Parameters

  • data: TransitionOptions | Transition

    Transition instance or transition constructor options.

  Returns string

  The created transition instance ID.

adjustClipsLayout

• adjustClipsLayout(): boolean

  Resolves negative positions and overlapping clips by moving clips to the next valid slot.

  Returns boolean

  true if any clip positions changed; otherwise false.

clearAllCustomData

• clearAllCustomData(): void

  Removes all custom metadata entries from the layer.

  Returns void

  Nothing.

destroy

• destroy(): void

  Destroys the layer container and all owned clips and transitions.

  Returns void

  Nothing.

getAllCustomData

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

  Returns a copy of the layer's custom metadata.

  Returns undefined | Map<string, unknown>

  A new metadata map, or undefined if no custom metadata has been set.

getClipById

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

  Returns a clip by its ID.

  Parameters

  • clipId: string

    Clip ID to look up.

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

  The matching clip, or undefined if not found.

getClipIds

• getClipIds(): string[]

  Returns the clip IDs in layer order.

  Returns string[]

  The ordered clip ID list.

getClips

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

  Returns the clip map owned by this layer.

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

  The clip record keyed by clip ID.

getCustomData

• getCustomData(key: string): unknown

  Returns a custom metadata value stored on the layer.

  Parameters

  • key: string

    Metadata key to read.

  Returns unknown

  The stored value, or undefined if the key is not present.

getDuration

• getDuration(): number

  Returns the right-most occupied time on the layer.

  Returns number

  The layer duration in timeline seconds.

getName

• getName(): string

  Returns the display name of the layer.

  Returns string

  The layer name.

getNextEmptySpace

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

  Returns the earliest available start time at or after the requested range that avoids overlaps.

  Parameters

  • startTime: number

    Desired start time in seconds.

  • endTime: number

    Desired end time in seconds.

  Returns number

  The next available start time in seconds.

getTransitionById

• getTransitionById(id: string): null | Transition

  Returns a transition by its instance ID.

  Parameters

  • id: string

    Transition instance ID to look up.

  Returns null | Transition

  The matching transition, or null if not found.

getTransitions

• getTransitions(): Transition[]

  Returns all transitions on this layer.

  Returns Transition[]

  The transition list.

getVisibility

• getVisibility(): boolean

  Returns whether the layer is currently visible.

  Returns boolean

  true if the layer is visible; otherwise false.

getVolume

• getVolume(): number

  Returns the layer volume multiplier.

  Returns number

  The layer volume.

hasCustomData

• hasCustomData(key: string): boolean

  Checks whether a custom metadata entry exists on the layer.

  Parameters

  • key: string

    Metadata key to check.

  Returns boolean

  true if the key exists; otherwise false.

hasEmptySpace

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

  Checks whether the supplied time range is free of clip overlap on this layer.

  Parameters

  • startTime: number

    Range start time in seconds.

  • endTime: number

    Range end time in seconds.

  Returns boolean

  true if the range is empty on this layer; otherwise false.

init

• init(): Promise<void>

  Initializes the PIXI container for this layer and initializes all contained transitions and clips.

  Returns Promise<void>

  A promise that resolves after the layer is ready for rendering.

isEmpty

• isEmpty(): boolean

  Indicates whether the layer contains any clips.

  Returns boolean

  true if the layer has no clips; otherwise false.

isMuted

• isMuted(): boolean

  Indicates whether the layer is muted.

  Returns boolean

  true if the layer is muted; otherwise false.

moveClipToLayer

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

  Moves a clip from this layer to another layer.

  Parameters

  • clipId: string

    Clip ID to move.

  • newLayerId: string

    Destination layer ID.

  Returns void

  Nothing.

onPause

• onPause(currentTime: number): void

  Lifecycle hook called when playback pauses.

  Parameters

  • currentTime: number

    Current timeline time, in seconds.

  Returns void

  Nothing.

onPlay

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

  Lifecycle hook called when playback starts.

  Parameters

  • currentTime: number

    Current timeline time, in seconds.

  Returns Promise<void>

  A promise that resolves after all owned clips and transitions have handled playback start.

onResize

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

  Lifecycle hook called when the render size changes.

  Parameters

  • width: number

    New render width in pixels.

  • height: number

    New render height in pixels.

  Returns void

  Nothing.

postRender

• postRender(currentTime: number): void

  Performs post-render work for all clips and transitions on this layer.

  Parameters

  • currentTime: number

    Current timeline time, in seconds.

  Returns void

  Nothing.

removeAllTransitionsByTransitionId

• removeAllTransitionsByTransitionId(transitionId: string): void

  Removes all transitions that were created from the specified transition definition ID.

  Parameters

  • transitionId: string

    Transition definition ID to remove.

  Returns void

  Nothing.

removeClip

• removeClip(clipId: string): boolean

  Removes a clip and any transitions that depend on it.

  Parameters

  • clipId: string

    Clip ID to remove.

  Returns boolean

  true if the clip was found and removed; otherwise false.

removeTransition

• removeTransition(id: string): void

  Parameters

  • id: string

  Returns void

render

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

  Renders all clips and transitions owned by this layer for the current frame.

  Parameters

  • currentTime: number

    Current timeline time, in seconds.

  Returns Container<DisplayObject>

  The PIXI container used to display the layer.

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;
  }

  Serializes the layer, including clips, transitions, and custom data.

  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;
  }

  The serialized layer payload.

setAllCustomData

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

  Replaces all custom metadata entries on the layer.

  Parameters

  • data: Map<string, unknown>

    Metadata map to store.

  Returns void

  Nothing.

setCustomData

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

  Stores custom metadata on the layer.

  Parameters

  • key: string

    Metadata key to write.

  • value: unknown

    Metadata value to store.

  • overwrite: boolean = true

    When false, preserves existing values and rejects duplicate keys.

  Returns boolean

  true if the value was stored; otherwise false.

setMuted

• setMuted(muted: boolean): void

  Mutes or unmutes the layer.

  Parameters

  • muted: boolean

    Whether the layer should be muted.

  Returns void

  Nothing.

setName

• setName(name: string): void

  Sets the display name of the layer.

  Parameters

  • name: string

    Layer name to assign.

  Returns void

  Nothing.

setVisibility

• setVisibility(visible: boolean): void

  Shows or hides the entire layer container.

  Parameters

  • visible: boolean

    Whether the layer should be visible.

  Returns void

  Nothing.

setVolume

• setVolume(volume: number): void

  Sets the layer volume multiplier.

  Parameters

  • volume: number

    Layer volume multiplier.

  Returns void

  Nothing.

setZIndex

• setZIndex(zIndex: number): void

  Sets the renderer z-index for this layer container.

  Parameters

  • zIndex: number

    Layer z-index.

  Returns void

  Nothing.

splitClip

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

  Splits a clip into two clips at the supplied timeline time.

  Parameters

  • clipId: string

    Clip ID to split.

  • time: number

    Timeline time, in seconds, where the split should happen.

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

  A promise that resolves to the newly created right-side clip, or null if the split is invalid.

update

• update(currentTime: number): void

  Updates all clips and transitions owned by this layer for the current time.

  Parameters

  • currentTime: number

    Current timeline time, in seconds.

  Returns void

  Nothing.

Static_deserializeClip

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

  Parameters

  • clipData: any

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

Staticdeserialize

• deserialize(data: object): Layer

  Creates a layer from serialized data.

  Parameters

  • data: object

    Serialized layer payload.

  Returns Layer

  The deserialized layer.