Interface EngineOptions

Configures engine initialization, including rendering, storage, licensing, and media services.

interface EngineOptions {
    dataHashFunction?: (data: Uint8Array) => Promise<string>;
    display?: DisplayOptions;
    enableUndoRedo?: boolean;
    ffmpeg?: FFmpegOptions;
    forcedSettings?: Partial<
        {
            clipAudioMonoChannelsWeight: number[];
            clipAudioMonoMixType: MonoMixType;
            clipAudioSampleForceMono: boolean;
            clipAudioSampleRate: number;
            clipAudioSeekThreshold: number;
            clipAudioStoreSamples: boolean;
            clipVideoDynamicLoad: boolean;
            clipVideoDynamicLoadTime: number;
            clipVideoFilmstripInterval: number;
            clipVideoFilmstripKeyframesOnly: boolean;
            clipVideoFilmstripMaxFrames: number;
            clipVideoFilmstripMaxHeight: number;
            clipVideoFilmstripMaxWidth: number;
            clipVideoFilmstripMaxWorkers: number;
            clipVideoSeekThreshold: number;
            clipVideoStoreFilmstrip: boolean;
            clipVideoStoreSamples: boolean;
            decoderPreferredAcceleration: PreferredAcceleration;
            decoderUseSeparateWorker: boolean;
            decoderUseSubImage: boolean;
            decoderUseWebCodecs: boolean;
            encoderBitrate: number;
            encoderBitrateMode: BitrateMode;
            encoderCodec: VideoCodec;
            encoderCrf: number;
            encoderDeadline: number;
            encoderForcedCodecRFCString: string;
            encoderKeyframeInterval: number;
            encoderPerformanceMode: PerformanceMode;
            encoderPreferredAcceleration: PreferredAcceleration;
            encoderUseAlpha: boolean;
            encoderUseWebCodecs: boolean;
            m3u8MaxResolution: [number, number];
            mediaHashAlgorithm: HashAlgorithmEnum;
            renderAudioUseWorker: boolean;
            renderCancelFailTimeout: number;
            renderChunkedOutputMaxSize: number;
            renderMaxQueueSize: number;
            renderShowPreview: boolean;
            renderThrottleFactor: number;
            renderUseChunkedOutput: boolean;
            renderVideoUseDirectFrames: boolean;
            subtitlesAutoWrapOnResize: boolean;
            subtitlesScaleOnResize: boolean;
            useInternalTranscoder: boolean;
            viewAutoLayoutOnResize: AutoLayoutMode;
        },
    >;
    license?: EngineLicense;
    onSetupLibrary?: (data: LibrarySetupData) => Promise<void>;
    storages?: StorageProviderBase[];
    transcoder?: ITranscodeProvider;
}

Index

Properties

dataHashFunction? display? enableUndoRedo? ffmpeg? forcedSettings? license? onSetupLibrary? storages? transcoder?

Properties

`Optional`dataHashFunction

dataHashFunction?: (data: Uint8Array) => Promise<string>

Custom hashing function used to derive media identity from raw bytes.

`Optional`display

display?: DisplayOptions

Display configuration applied to the engine canvas.

`Optional`enableUndoRedo

enableUndoRedo?: boolean

Enables undo and redo tracking after initialization.

`Optional`ffmpeg

ffmpeg?: FFmpegOptions

Optional FFmpeg runtime location overrides.

`Optional`forcedSettings

forcedSettings?: Partial<
    {
        clipAudioMonoChannelsWeight: number[];
        clipAudioMonoMixType: MonoMixType;
        clipAudioSampleForceMono: boolean;
        clipAudioSampleRate: number;
        clipAudioSeekThreshold: number;
        clipAudioStoreSamples: boolean;
        clipVideoDynamicLoad: boolean;
        clipVideoDynamicLoadTime: number;
        clipVideoFilmstripInterval: number;
        clipVideoFilmstripKeyframesOnly: boolean;
        clipVideoFilmstripMaxFrames: number;
        clipVideoFilmstripMaxHeight: number;
        clipVideoFilmstripMaxWidth: number;
        clipVideoFilmstripMaxWorkers: number;
        clipVideoSeekThreshold: number;
        clipVideoStoreFilmstrip: boolean;
        clipVideoStoreSamples: boolean;
        decoderPreferredAcceleration: PreferredAcceleration;
        decoderUseSeparateWorker: boolean;
        decoderUseSubImage: boolean;
        decoderUseWebCodecs: boolean;
        encoderBitrate: number;
        encoderBitrateMode: BitrateMode;
        encoderCodec: VideoCodec;
        encoderCrf: number;
        encoderDeadline: number;
        encoderForcedCodecRFCString: string;
        encoderKeyframeInterval: number;
        encoderPerformanceMode: PerformanceMode;
        encoderPreferredAcceleration: PreferredAcceleration;
        encoderUseAlpha: boolean;
        encoderUseWebCodecs: boolean;
        m3u8MaxResolution: [number, number];
        mediaHashAlgorithm: HashAlgorithmEnum;
        renderAudioUseWorker: boolean;
        renderCancelFailTimeout: number;
        renderChunkedOutputMaxSize: number;
        renderMaxQueueSize: number;
        renderShowPreview: boolean;
        renderThrottleFactor: number;
        renderUseChunkedOutput: boolean;
        renderVideoUseDirectFrames: boolean;
        subtitlesAutoWrapOnResize: boolean;
        subtitlesScaleOnResize: boolean;
        useInternalTranscoder: boolean;
        viewAutoLayoutOnResize: AutoLayoutMode;
    },
>

Settings values that should override the defaults loaded by the engine.

`Optional`license

license?: EngineLicense

Licensing data used to authenticate FFmpeg-enabled export features.

`Optional`onSetupLibrary

onSetupLibrary?: (data: LibrarySetupData) => Promise<void>

Callback invoked after project data is loaded when required library assets are missing.

`Optional`storages

storages?: StorageProviderBase[]

Storage providers registered for project asset persistence.

`Optional`transcoder

transcoder?: ITranscodeProvider

Optional transcode provider used for media compatibility workflows.

Interface EngineOptions

Index

Properties

Properties

OptionaldataHashFunction

Optionaldisplay

OptionalenableUndoRedo

Optionalffmpeg

OptionalforcedSettings

Optionallicense

OptionalonSetupLibrary

Optionalstorages

Optionaltranscoder

Settings

On This Page

`Optional`dataHashFunction

`Optional`display

`Optional`enableUndoRedo

`Optional`ffmpeg

`Optional`forcedSettings

`Optional`license

`Optional`onSetupLibrary

`Optional`storages

`Optional`transcoder