Creates an audio clip bound to a library media asset.
Initial audio clip configuration.
Queues an audio element action so it can run after the current async media operation completes.
Action name such as play, pause, or seek.
Additional action parameters.
Nothing.
Uses another clip as a mask source for this clip.
A clip that is already a mask source is left untouched: the call is ignored and its existing mask filter returned, rather than stacking a duplicate.
Clip whose sprite should be used as the mask source.
Optionaloptions: MaskOptionsOptional mask behavior.
Optionalindex: numberOptional position among the existing masks; appended when omitted.
The mask filter, or undefined if the source clip has no sprite or the attachment
would be circular.
Optionalproperties: Record<string, any>Optionalindex: numberOptionalindex: numberApplies clip, layer, timeline, and fade multipliers to the underlying audio element volume.
Nothing.
Begins an interactive bounds-editing gesture (drag-resize / move / rotate) on this clip.
The returned session translates composition-space box changes into the clip's underlying
properties, records ONE undo entry per gesture on commit(), and restores everything on
cancel() — see BoundsEditSession. An unfinished previous session on this clip is
cancelled first.
Removes all custom metadata stored on the clip.
Nothing.
Releases clip-owned runtime resources, masks, transitions, effects, and cached lookup state.
Nothing.
Clears any queued media actions waiting to run on the audio element.
Nothing.
Generates a new clip ID and updates dependent runtime objects that store that ID.
Nothing.
Returns a copy of all custom metadata stored on the clip.
A copied metadata map, or undefined if no custom data has been stored.
Returns decoded audio samples from the underlying media asset.
Start time in seconds, relative to the source media.
Optionalduration: numberOptional duration in seconds to extract.
The audio sample channels, or null if the media data is unavailable.
Audio clips have no visual presence — no bounds interactions apply.
Returns the clip's unified bounding description in composition space — the box selection handles, guidelines and snapping should use — so hosts don't need per-clip-type measurement logic (media width vs text wrap width vs subtitles, anchor assumptions, etc.).
Geometry is derived purely from the clip's logical style state (never from texture internals), so
it is stable across renderer changes, valid before media loads, and synchronously fresh after any
style setter; zIndex is the layer container's. See ClipBoundingInfo for the exact
coordinate contract.
Subclasses with different geometry sources (subtitles, shapes) override this.
The clip's bounding info.
Returns a stored metadata value for the clip.
Metadata key to look up.
The stored value, or undefined if the key is not present.
Returns the full (untrimmed) clip duration as it was in the serialized project, or undefined
for clips created in this session. Unlike getDuration(), this is not refreshed from the
loaded media, so it reflects the media the project was serialized with.
Returns the full media size implied by the serialized clip style (raw style size plus crop),
or null when unknown (runtime-created clips, or clips serialized before their texture ever
loaded). Used as a backwards-compatible source of the previous media dimensions for projects
that predate media width/height serialization.
Returns the full clip duration before trims are applied.
The clip duration in seconds.
Returns the clip end time in timeline space.
The clip end time in seconds.
Returns the clip ID.
The clip ID.
Indicates whether the clip is currently part of any transition.
true if the clip is inside an incoming or outgoing transition; otherwise false.
Indicates whether the clip is currently processing a queued play, pause, or seek operation.
true if an asynchronous media action is still in progress; otherwise false.
Returns the ID of the layer that currently owns the clip.
The owning layer ID.
Returns the first visible playback time of the clip after left trim is applied.
The left playback bound in seconds.
Returns the amount trimmed from the left edge of the clip.
Left trim in seconds.
Returns this clip's rounded-corner crop in mask-source local space.
Corner masks are applied while rendering the source and are not part of the sampled texture, so the mask shader must reproduce them.
Returns the sprite sampled when this clip is used as a mask source.
Clips whose visible content lives in a child sprite can override this without changing mask ownership or serialization.
Returns the media asset ID currently bound to the clip.
The media asset ID, or undefined for clips without media.
Returns the user-visible clip name.
The clip name.
Indicates whether pitch preservation is enabled during speed changes.
true if pitch preservation is enabled; otherwise false.
Returns the playback speed multiplier.
The playback speed multiplier.
Describes the clip's in-flight asynchronous work, used by the export stall watchdog to report exactly which clips are stuck and what they are waiting on. Subclasses with asynchronous processing override this with their specific state.
A single-line human-readable description of the clip's processing state.
Returns the final visible playback time of the clip after right trim is applied.
The right playback bound in seconds.
Returns the amount trimmed from the right edge of the clip.
Right trim in seconds.
Returns the clip start time in timeline space.
The clip start time in seconds.
Returns the subtitles asset ID currently assigned to the clip.
The subtitles asset ID, or undefined if none is assigned.
Returns the stored subtitles offset for the clip.
The subtitles offset in seconds.
Returns the incoming transition ID associated with the clip.
The incoming transition ID, or null if none is set.
Returns the outgoing transition ID associated with the clip.
The outgoing transition ID, or null if none is set.
Returns the playable duration after both trims are applied.
The trimmed duration in seconds.
Returns the clip type identifier.
The clip type.
Indicates whether the clip is marked as visible.
true if the clip is renderable; otherwise false.
Returns the clip volume multiplier.
The clip volume multiplier.
Returns the fade curve used for the clip fade-in.
The configured fade-in curve.
Returns the configured fade-in duration.
The fade-in duration in seconds.
Returns the fade curve used for the clip fade-out.
The configured fade-out curve.
Returns the configured fade-out duration.
The fade-out duration in seconds.
Indicates whether the clip has a stored metadata value for the provided key.
Metadata key to test.
true if the key exists; otherwise false.
Indicates whether the clip has a non-empty user-visible name.
true if a name is set; otherwise false.
Indicates that audio clips do not expose a renderable PIXI sprite.
false.
Tests whether a screen-space point falls inside the clip's local bounds.
Screen-space cursor coordinates.
OptionalignoreVisibility: booleanWhen true, performs the hit test even if the sprite is not currently visible.
true if the point hits the clip; otherwise false.
Creates the backing audio element, binds media data, and initializes runtime playback state.
Layer ID that owns this clip.
A promise that resolves after initialization completes.
Indicates whether the clip is active on the specified timeline frame.
Timeline time in seconds.
true if the current frame falls within the clip playback bounds; otherwise false.
Indicates whether this clip's mask texture should be sampled by alpha only.
Indicates whether the clip is muted.
true if the clip is muted; otherwise false.
Indicates whether the backing audio element has loaded enough data to seek and play.
true if the audio element is ready; otherwise false.
Moves the clip forward or backward on the timeline by the provided offset.
Time delta in seconds.
Nothing.
Pauses audio playback and seeks the audio element back to the requested timeline time.
Current timeline time in seconds.
A promise that resolves after pause handling completes.
Primes the clip for timeline playback and seeks the audio element to the requested time.
Current timeline time in seconds.
A promise that resolves after playback pre-roll work completes.
Preloads the audio element by seeking it near the requested timeline time.
Current timeline time in seconds.
Nothing.
Runs the next queued audio element action, if any.
Nothing.
Removes a previously attached clip mask.
Mask source clip to detach.
Nothing.
Removes any subtitles association from the clip.
Nothing.
Resets every animated clip property back to its non-animated base value.
Nothing.
Resets a single animated property back to its base clip/style value.
Registered animation property key.
Nothing.
Serializes the audio clip.
The serialized audio clip payload.
Replaces all custom clip metadata with a copy of the provided map.
Metadata entries to store.
Nothing.
Applies a single animated property value to the clip runtime state.
Registered animation property key.
Value to apply.
Nothing.
Sets the clip blend mode and applies the matching PIXI blend mode.
Blend mode to apply.
Nothing.
Stores arbitrary metadata on the clip.
Metadata key.
Metadata value.
Whether an existing key may be overwritten.
true if the value was stored; otherwise false when overwrite is disabled and the key already exists.
Marks whether the clip is currently inside an incoming transition.
Whether the clip participates in an incoming transition.
Nothing.
Marks whether the clip is currently inside an outgoing transition.
Whether the clip participates in an outgoing transition.
Nothing.
Updates the owning layer ID tracked by the clip.
Owning layer ID.
Nothing.
Mutes or unmutes the clip.
Whether the clip should be muted.
Nothing.
Sets the user-visible clip name.
Name to assign.
Nothing.
Sets whether pitch correction should be preserved while changing playback speed.
Whether pitch should be preserved.
Nothing.
Changes audio playback speed and updates duration and trims to preserve the requested timing behavior.
Playback speed multiplier.
When true, keeps the audible left edge fixed in timeline space.
When true, preserves the trimmed audible duration after the speed change.
Nothing.
Associates a subtitles asset with the clip and stores its playback offset.
Subtitles asset ID to attach.
Global subtitles offset in seconds.
Nothing.
Replaces the subtitles asset ID assigned to the clip without changing the stored offset.
Subtitles asset ID to assign.
Nothing.
Sets the stored subtitles offset for the clip.
Subtitles offset in seconds.
Nothing.
Sets the incoming transition ID currently associated with the clip.
Incoming transition ID, or null to clear it.
Nothing.
Sets the outgoing transition ID currently associated with the clip.
Outgoing transition ID, or null to clear it.
Nothing.
Sets whether the clip sprite is renderable.
Whether the clip should render.
Nothing.
Sets the clip volume multiplier.
Clip volume multiplier.
Nothing.
Sets the interpolation curve used for the clip fade-in.
Fade curve to use.
Nothing.
Sets the audible fade-in duration at the start of the clip.
Fade-in duration in seconds.
Nothing.
Sets the interpolation curve used for the clip fade-out.
Fade curve to use.
Nothing.
Sets the audible fade-out duration at the end of the clip.
Fade-out duration in seconds.
Nothing.
Sets the texture wrap mode used by the clip.
Wrap mode to apply.
Nothing.
Synchronizes audio playback state with the timeline playhead.
Current timeline time in seconds.
Nothing.
Rebinds the clip to updated audio media and refreshes derived timing and playback state.
OptionalnewMediaId: stringOptional replacement media asset ID.
Optional_: ReplaceMediaOptionsUnused replacement options placeholder kept for signature compatibility.
A promise that resolves to true if the media update succeeds; otherwise false.
StaticdeserializeCreates an audio clip instance from serialized data.
Serialized audio clip payload.
The deserialized audio clip.
Clip implementation that plays and trims an audio-only media asset on the timeline.