ReadonlyeventsStatic ReadonlycurrentStaticprojectInvokes a static method on a previously registered custom clip type.
Registered custom clip type to target.
Static method name to invoke.
Arguments forwarded to the static method.
The value returned by the static method.
Cancels the active export, if one is currently running.
A promise that resolves after cancellation has been propagated to the renderer.
Removes all custom metadata entries from the engine.
Nothing.
Creates an instance of a registered custom clip type.
Registered custom clip type to instantiate.
Arguments forwarded to the custom clip constructor.
The created custom clip instance.
Destroys the current engine state and releases runtime resources.
Optionaleverything: booleanWhen true, also destroys long-lived singletons such as display, renderer,
FFmpeg, and font registry, and clears the engine singleton reference.
A promise that resolves after teardown finishes.
Exports the current project using the supplied export settings.
Optionalpayload: ExportOptionsExport configuration describing output type, time range, resolution scale, and audio format.
A promise that resolves to the exported artifact, or null when no file is produced.
Exports an audio-only mix for the requested timeline range.
Audio export configuration, including the exported range and optional clip filtering.
A promise that resolves to the exported audio artifact, or null when no file is produced.
Returns a copy of the engine's custom metadata.
A new metadata map, or undefined when no custom metadata has been set.
Returns the shared audio mixer that routes clip audio through gain nodes.
The engine audio mixer.
Returns the background timer used for deferred work while the page is inactive.
The engine background timer.
Returns the IDs of clips intersecting the supplied canvas coordinates.
This method is currently a placeholder and always returns null.
Horizontal coordinate in canvas space.
Vertical coordinate in canvas space.
null.
Reads a custom metadata value previously stored on the engine.
Metadata key to read.
The stored value, or undefined if the key is not present.
Returns the custom media hash function configured during initialization.
The custom hash function, or undefined when the default behavior is used.
Returns the display controller used to render the project canvas.
The engine display.
Returns the low-level FFmpeg instance used by the SDK.
The initialized FFmpeg bridge.
Captures a rendered frame as a base64-encoded image.
If time is provided, the timeline is temporarily seeked before capture and then restored.
Optionaltime: numberOptional timeline time, in seconds, to capture.
Image MIME type used for encoding.
Encoder quality passed to PIXI extraction for lossy formats.
A promise that resolves to a base64 image string, or an empty string when no renderer is available.
Captures a rendered frame as raw RGBA pixels without image encoding.
The optional region uses composition coordinates and is clipped to the display bounds. If
time is provided, the timeline is temporarily seeked before capture and then restored.
Optionaltime: numberOptional timeline time, in seconds, to capture.
Optionalregion: FramePixelRegionOptional composition-space region. The full display is captured when omitted.
Raw RGBA data and the actual captured rectangle, or null when it cannot be captured.
Returns the library that owns imported media, effects, filters, transitions, and subtitles.
The project library.
Returns the background media hash service (see Settings::setMediaBackgroundHashing).
The engine-owned media hash service.
Returns the pooled media info probing service (see Settings::setMediaInfoMaxWorkers).
The engine-owned media info service.
Returns the pooled media transcoding service (see Settings::setMediaTranscodeMaxWorkers).
The engine-owned media transcode service.
Returns the identifier of the active project.
The current project ID.
Returns the renderer currently backing the engine display.
The active PIXI renderer wrapper.
Returns the root PIXI stage used for rendering.
The renderer stage.
Returns the project settings currently applied by the engine.
The active settings instance.
Returns the storage controller responsible for project persistence.
The storage controller.
Returns the subtitles manager used for subtitle track styling and playback.
The subtitles manager.
Returns the optional transcode provider configured for this engine.
The transcode provider, or null when transcoding is not configured.
Returns the undo manager associated with the engine.
The undo manager.
Checks whether a custom clip type has been registered.
Clip type identifier to test.
true if the custom clip type exists; otherwise false.
Checks whether a custom metadata entry exists.
Metadata key to check.
true if the key exists; otherwise false.
Indicates whether the engine singleton has already been created.
true if an engine instance already exists; otherwise false.
Initializes the engine and all configured subsystems.
This sets up display, FFmpeg, storage, library state, timeline state, licensing, and optional transcoding support.
Engine startup configuration.
A promise that resolves after initialization has completed.
Probes whether exporting through the WebCodecs encoding path is supported with the current encoder configuration, and reports the full capability surface: per-codec support, bitrate modes (constant/variable), hardware acceleration, a standard resolution ladder, and the supported bitrate interval.
The overall supported flag reproduces the export pipeline's runtime fallback ladder for the
active (possibly user-forced) codec, so it answers "would an export started right now find a
usable encoder configuration". Pass dryRun: true to additionally verify the selected
configuration by actually encoding a few synthetic frames through a real VideoEncoder —
the definitive check for encoders that claim support but fail once configured.
See ExportSupportInfo.
Optionaloptions: ExportSupportProbeOptionsOptional overrides (width/height/framerate/bitrate, dryRun); every omitted
value defaults to the engine's current export configuration.
A promise resolving to the capability report.
Indicates whether init() has completed successfully for this engine instance.
true if the engine has been initialized; otherwise false.
Indicates whether the engine is ready for playback, editing, and rendering work.
true if initialization has completed and the engine is ready; otherwise false.
Indicates whether preview rendering or export rendering is currently running.
true while render work is in progress; otherwise false.
Indicates whether the current engine state can be serialized safely.
This also waits for pending background media hashes (see Settings::setMediaBackgroundHashing):
a media serialized without its hash could not be restored from storage on the next load.
true when the engine is ready and the library is not processing background work; otherwise false.
Pauses timeline playback without discarding the current playhead position.
A promise that resolves after playback has paused.
Starts timeline playback.
A promise that resolves after playback has started.
Registers a custom clip constructor under a clip type identifier.
Constructor used to create clip instances of the custom type.
Clip type identifier associated with the constructor.
Nothing.
Replaces the current project with a fresh empty project.
A promise that resolves after the reset project has been deserialized.
Moves the timeline playhead to the requested time.
Target timeline time, in seconds.
A promise that resolves after seeking has completed.
Serializes the current project into a schema-validated plain object.
The serialized engine payload.
Replaces all custom metadata entries with the supplied map.
Metadata map to store.
Nothing.
Stores custom metadata on the engine instance.
Metadata key to write.
Metadata value to store.
When false, existing values are preserved and the write is rejected.
true if the value was stored; otherwise false.
Replaces the active project identifier and reinitializes storage for the new project.
Project identifier to assign.
A promise that resolves after storage has been rebound to the new project ID.
Activates a subtitles track on the timeline.
Subtitle track identifier to apply.
Time offset, in seconds, used when synchronizing the subtitles track.
Nothing.
Indicates whether imported media should have audio separated for the current platform.
true when audio splitting should be enabled; otherwise false.
Stops timeline playback.
A promise that resolves after playback has stopped.
StaticdeserializeRestores engine state from a serialized project payload.
If another deserialization is already in progress, the latest payload is queued and processed after the active deserialization finishes.
Serialized engine payload to load.
A promise that resolves to the engine instance once deserialization finishes.
StaticgetStaticgetReturns the SDK version bundled into the current build.
The current SDK version string.
Main SDK entrypoint for project editing, playback, serialization, and export.
The engine coordinates the display, timeline, library, storage, subtitles, rendering, and media-processing subsystems behind a single singleton instance.