Class FFmpeg

Singleton wrapper that initializes and manages the SDK's FFmpeg runtime.

Index

Methods

createCustomInstance destroy getCoreURL getFFmpeg getWasmURL initialize reload getInstance

Methods

createCustomInstance

createCustomInstance(): Promise<null | FFmpeg>
Creates a separate low-level FFmpeg instance using the already loaded runtime assets.

Returns Promise<null | FFmpeg>
A promise that resolves to a loaded FFmpeg instance, or null if loading fails.

destroy

destroy(): void
Terminates the loaded FFmpeg instance and clears the singleton reference.

Returns void
Nothing.

getCoreURL

getCoreURL(): string
Returns the blob URL currently used for the FFmpeg core script.

Returns string
The FFmpeg core URL.

getFFmpeg

getFFmpeg(): FFmpeg
Returns the underlying low-level FFmpeg instance.

Returns FFmpeg
The root FFmpeg instance.

getWasmURL

getWasmURL(): string
Returns the blob URL currently used for the FFmpeg WASM binary.

Returns string
The FFmpeg WASM URL.

initialize

initialize(config: FFMessageLoadConfig): Promise<undefined | boolean>
Loads the FFmpeg runtime from the supplied asset URLs.
Parameters
- config: FFMessageLoadConfig
  FFmpeg core and WASM asset URLs.
Returns Promise<undefined | boolean>
A promise that resolves after FFmpeg has been loaded.

reload

reload(): Promise<void>
Reloads the current FFmpeg instance using the stored runtime asset URLs.

Returns Promise<void>
A promise that resolves after FFmpeg has been reloaded.

`Static`getInstance

getInstance(): FFmpeg
Returns the shared FFmpeg wrapper instance.

Returns FFmpeg
The singleton FFmpeg wrapper.