@rendley/sdk - v1.16.1
    Preparing search index...

    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;
                clipImageLoadOnInit: boolean;
                clipVideoDynamicLoad: boolean;
                clipVideoDynamicLoadTime: number;
                clipVideoFilmstripInterval: number;
                clipVideoFilmstripKeyframesOnly: boolean;
                clipVideoFilmstripMaxFrames: number;
                clipVideoFilmstripMaxHeight: number;
                clipVideoFilmstripMaxWidth: number;
                clipVideoFilmstripMaxWorkers: number;
                clipVideoFilmstripUseMediaBunny: boolean;
                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];
                mediaBackgroundHashing: boolean;
                mediaBunnyAudioInWorker: boolean;
                mediaBunnyAudioResyncThreshold: number;
                mediaBunnyAudioScheduleAhead: number;
                mediaBunnyCatchupCooldown: number;
                mediaBunnyCatchupThreshold: number;
                mediaBunnySeekForwardScanMax: number;
                mediaHashAlgorithm: HashAlgorithmEnum;
                mediaHashMaxWorkers: number;
                mediaInfoMaxWorkers: number;
                mediaTranscodeMaxWorkers: number;
                renderAudioUseWorker: boolean;
                renderCancelFailTimeout: number;
                renderChunkedOutputMaxSize: number;
                renderFixAntialiasDiagonal: boolean;
                renderMaxQueueSize: number;
                renderProcessingStallTimeout: number;
                renderShowPreview: boolean;
                renderThrottleFactor: number;
                renderUseChunkedOutput: boolean;
                renderVideoUseDirectFrames: boolean;
                subtitlesAutoWrapOnResize: boolean;
                subtitlesScaleOnResize: boolean;
                useInternalTranscoder: boolean;
                useMediaBunnyAsVideoPlayer: boolean;
                viewAutoLayoutOnResize: AutoLayoutMode;
            },
        >;
        ignoreProjectSettings?: boolean;
        license?: EngineLicense;
        onSetupLibrary?: (data: LibrarySetupData) => Promise<void>;
        project?: object;
        storages?: StorageProviderBase[];
        transcoder?: ITranscodeProvider;
    }
    Index

    Properties

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

    Properties

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

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

    display?: DisplayOptions

    Display configuration applied to the engine canvas.

    enableUndoRedo?: boolean

    Enables undo and redo tracking after initialization.

    ffmpeg?: FFmpegOptions

    Optional FFmpeg runtime location overrides.

    forcedSettings?: Partial<
        {
            clipAudioMonoChannelsWeight: number[];
            clipAudioMonoMixType: MonoMixType;
            clipAudioSampleForceMono: boolean;
            clipAudioSampleRate: number;
            clipAudioSeekThreshold: number;
            clipAudioStoreSamples: boolean;
            clipImageLoadOnInit: boolean;
            clipVideoDynamicLoad: boolean;
            clipVideoDynamicLoadTime: number;
            clipVideoFilmstripInterval: number;
            clipVideoFilmstripKeyframesOnly: boolean;
            clipVideoFilmstripMaxFrames: number;
            clipVideoFilmstripMaxHeight: number;
            clipVideoFilmstripMaxWidth: number;
            clipVideoFilmstripMaxWorkers: number;
            clipVideoFilmstripUseMediaBunny: boolean;
            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];
            mediaBackgroundHashing: boolean;
            mediaBunnyAudioInWorker: boolean;
            mediaBunnyAudioResyncThreshold: number;
            mediaBunnyAudioScheduleAhead: number;
            mediaBunnyCatchupCooldown: number;
            mediaBunnyCatchupThreshold: number;
            mediaBunnySeekForwardScanMax: number;
            mediaHashAlgorithm: HashAlgorithmEnum;
            mediaHashMaxWorkers: number;
            mediaInfoMaxWorkers: number;
            mediaTranscodeMaxWorkers: number;
            renderAudioUseWorker: boolean;
            renderCancelFailTimeout: number;
            renderChunkedOutputMaxSize: number;
            renderFixAntialiasDiagonal: boolean;
            renderMaxQueueSize: number;
            renderProcessingStallTimeout: number;
            renderShowPreview: boolean;
            renderThrottleFactor: number;
            renderUseChunkedOutput: boolean;
            renderVideoUseDirectFrames: boolean;
            subtitlesAutoWrapOnResize: boolean;
            subtitlesScaleOnResize: boolean;
            useInternalTranscoder: boolean;
            useMediaBunnyAsVideoPlayer: boolean;
            viewAutoLayoutOnResize: AutoLayoutMode;
        },
    >

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

    ignoreProjectSettings?: boolean

    Ignores the settings stored in loaded projects (both EngineOptions.project and every later Engine.deserialize): the engine keeps the settings it runs with (defaults, setters) and applies forcedSettings on top. By default a project's settings are applied on load, which lets a front end hand its encoder/render choices to a renderer through the project; enable this where the payload is not trusted to configure the host, e.g. a server that renders projects submitted by third parties (a payload could otherwise change timeouts, worker counts, encoder limits...). Default false.

    license?: EngineLicense

    Licensing data used to authenticate FFmpeg-enabled export features.

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

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

    project?: object

    Serialized project payload (as produced by Engine.serialize) to load during initialization, avoiding a separate init() + deserialize() cycle. Requires display.

    The payload is validated before any engine state is touched: an invalid payload rejects init() with a ProjectLoadError and leaves the engine un-initialized, so init() can be retried (for example without project to open an empty editor).

    storages?: StorageProviderBase[]

    Storage providers registered for project asset persistence.

    transcoder?: ITranscodeProvider

    Optional transcode provider used for media compatibility workflows.

    Settings

    Member Visibility

    On This Page

    Properties