Creates a video clip bound to a library media asset.
Initial video clip configuration.
Uses another clip as a mask source for this clip.
Clip whose sprite should be used as the mask source.
Optionaloptions: MaskOptionsOptional mask behavior.
The created mask filter, or undefined if the source clip has no sprite.
Optionalproperties: Record<string, any>Applies clip, layer, timeline, and fade multipliers to the underlying video and split-audio element volume.
Nothing.
Removes all custom metadata stored on the clip.
Nothing.
Releases video/audio elements, decoder resources, texture state, and clip runtime data.
Nothing.
Clears any queued media actions waiting to run on the video or split-audio elements.
Nothing.
Creates a timeline audio clip from the video's audio track.
Whether the original video clip should be muted after extraction.
Whether a new audio-only media asset should be created in the library.
Audio stream index to extract.
A promise that resolves to the created audio clip, or null if extraction fails.
Captures the current rendered video frame as a base64-encoded image.
Output image encoding options.
A promise that resolves to the encoded image, or null if frame extraction is unavailable.
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 video's 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.
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 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 all available filmstrip frames for the backing media asset.
The filmstrip frame metadata.
Returns filmstrip frames that fall within the provided time range.
Range start time in seconds.
Range end time in seconds.
The matching filmstrip frame metadata.
Returns the current filmstrip generation state for the backing media asset.
The filmstrip processing state.
Returns the frozen local media time, if one is set.
The frozen media time in seconds, or undefined if freeze is disabled.
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 seek, play, pause, or render-preparation action.
true if asynchronous clip work 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 earliest timeline time where the clip may need to render, including incoming transition coverage.
The left render bound in seconds.
Returns the amount trimmed from the left edge of the clip.
Left trim in seconds.
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.
Returns the final visible playback time of the clip after right trim is applied.
The right playback bound in seconds.
Returns the latest timeline time where the clip may need to render, including outgoing transition coverage.
The right render 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 whether the clip exposes a sprite that can be added to the render stage.
true in the base implementation. Sprite-less subclasses can override this.
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 video and optional split-audio elements, 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 the clip audio is muted.
true if the clip is muted; otherwise false.
Indicates whether the clip has enough runtime state to render and update.
true when the clip is idle or loaded; otherwise false.
Moves the clip forward or backward on the timeline by the provided offset.
Time delta in seconds.
Nothing.
Pauses clip playback and seeks media elements 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 media elements to the requested time.
Current timeline time in seconds.
A promise that resolves after playback pre-roll work completes.
Cleans up clip state after an export render pass finishes.
Whether the render was canceled before completion.
A promise that resolves after render cleanup completes.
Prepares the clip for export rendering, including decoder/player mode setup.
Export options for the current render pass.
A promise that resolves after render-start preparation completes.
Preloads the clip by seeking the media elements near the requested timeline time.
Current timeline time in seconds.
Nothing.
Removes a previously attached clip mask.
Mask source clip to detach.
Nothing.
Clears any frozen playback time and resumes normal timeline-driven seeking.
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 video clip.
The serialized video 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.
Freezes video playback to a fixed local media time.
Optionaltime: numberLocal media time in seconds, or undefined to clear the freeze.
Nothing.
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 audio output.
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 video playback speed and updates duration and trims to preserve the requested timing behavior.
Playback speed multiplier.
When true, keeps the visible left edge fixed in timeline space.
When true, preserves the trimmed visible 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 video playback, lazy loading, visibility, and effect state with the timeline playhead.
Current timeline time in seconds.
Nothing.
Rebinds the clip to updated video media and refreshes derived timing, render mode, textures, and optional split-audio state.
OptionalnewMediaId: stringOptional replacement media asset ID.
Optionaloptions: ReplaceMediaOptionsOptional media replacement behavior such as fit and crop handling.
A promise that resolves to true if the media update succeeds; otherwise false.
StaticdeserializeCreates a video clip instance from serialized data.
Serialized video clip payload.
The deserialized video clip.
Clip implementation that renders video media, handles preview playback, and supports audio extraction and frame access.