@remotion/bundler/dist/index.d.ts

Bundle Remotion compositions using Webpack

import { WatchIgnoreNextChangePlugin } from './watch-ignore-next-change-plugin';
import esbuild = require('esbuild');
import webpack = require('webpack');
export declare const BundlerInternals: {
    esbuild: typeof esbuild;
    webpackConfig: ({ entry, userDefinedComponent, outDir, environment, webpackOverride, onProgress, enableCaching, maxTimelineTracks, remotionRoot, keyboardShortcutsEnabled, bufferStateDelayInMilliseconds, poll, experimentalClientSideRenderingEnabled, experimentalVisualModeEnabled, askAIEnabled, extraPlugins, }: {
        entry: string;
        userDefinedComponent: string;
        outDir: string | null;
        environment: "development" | "production";
        webpackOverride: import("./webpack-config").WebpackOverrideFn;
        onProgress?: ((f: number) => void) | undefined;
        enableCaching?: boolean | undefined;
        maxTimelineTracks: number | null;
        keyboardShortcutsEnabled: boolean;
        bufferStateDelayInMilliseconds: number | null;
        remotionRoot: string;
        poll: number | null;
        askAIEnabled: boolean;
        experimentalClientSideRenderingEnabled: boolean;
        experimentalVisualModeEnabled: boolean;
        extraPlugins: webpack.WebpackPluginInstance[];
    }) => Promise<[string, webpack.Configuration]>;
    rspackConfig: ({ entry, userDefinedComponent, outDir, environment, webpackOverride, onProgress, enableCaching, maxTimelineTracks, remotionRoot, keyboardShortcutsEnabled, bufferStateDelayInMilliseconds, poll, experimentalClientSideRenderingEnabled, experimentalVisualModeEnabled, askAIEnabled, extraPlugins, }: {
        entry: string;
        userDefinedComponent: string;
        outDir: string | null;
        environment: "development" | "production";
        webpackOverride: import("./webpack-config").WebpackOverrideFn;
        onProgress?: ((f: number) => void) | undefined;
        enableCaching?: boolean | undefined;
        maxTimelineTracks: number | null;
        keyboardShortcutsEnabled: boolean;
        bufferStateDelayInMilliseconds: number | null;
        remotionRoot: string;
        poll: number | null;
        askAIEnabled: boolean;
        experimentalClientSideRenderingEnabled: boolean;
        experimentalVisualModeEnabled: boolean;
        extraPlugins: any[];
    }) => Promise<[string, import("@rspack/core").RspackOptions]>;
    createRspackCompiler: (config: import("@rspack/core").RspackOptions) => import("@rspack/core").Compiler;
    indexHtml: ({ publicPath, editorName, inputProps, envVariables, staticHash, remotionRoot, studioServerCommand, renderQueue, completedClientRenders, numberOfAudioTags, publicFiles, includeFavicon, title, renderDefaults, publicFolderExists, gitSource, projectName, installedDependencies, packageManager, audioLatencyHint, logLevel, mode, }: {
        staticHash: string;
        publicPath: string;
        editorName: string | null;
        inputProps: object | null;
        envVariables?: Record<string, string> | undefined;
        remotionRoot: string;
        studioServerCommand: string | null;
        renderQueue: unknown;
        completedClientRenders?: unknown;
        numberOfAudioTags: number;
        audioLatencyHint: AudioContextLatencyCategory;
        publicFiles: import("remotion").StaticFile[];
        publicFolderExists: string | null;
        includeFavicon: boolean;
        title: string;
        renderDefaults: import("@remotion/studio-shared").RenderDefaults | undefined;
        gitSource: import("@remotion/studio-shared").GitSource | null;
        projectName: string;
        installedDependencies: string[] | null;
        packageManager: "unknown" | import("@remotion/studio-shared").PackageManager;
        logLevel: "error" | "info" | "trace" | "verbose" | "warn";
        mode: "bundle" | "dev";
    }) => string;
    cacheExists: (remotionRoot: string, environment: "development" | "production", hash: string) => "does-not-exist" | "exists" | "other-exists";
    clearCache: (remotionRoot: string, env: "development" | "production") => Promise<void>;
    getConfig: ({ entryPoint, outDir, resolvedRemotionRoot, onProgress, options, bufferStateDelayInMilliseconds, maxTimelineTracks, experimentalClientSideRenderingEnabled, experimentalVisualModeEnabled, }: {
        outDir: string;
        entryPoint: string;
        resolvedRemotionRoot: string;
        bufferStateDelayInMilliseconds: number | null;
        experimentalClientSideRenderingEnabled: boolean;
        experimentalVisualModeEnabled: boolean;
        maxTimelineTracks: number | null;
        onProgress: (progress: number) => void;
        options: import("./bundle").MandatoryLegacyBundleOptions;
    }) => Promise<[string, webpack.Configuration]> | Promise<[string, import("@rspack/core").RspackOptions]>;
    readRecursively: ({ folder, output, startPath, staticHash, limit, }: {
        folder: string;
        startPath: string;
        output?: import("remotion").StaticFile[] | undefined;
        staticHash: string;
        limit: number;
    }) => import("remotion").StaticFile[];
    findClosestFolderWithItem: (currentDir: string, file: string) => string | null;
    internalBundle: (actualArgs: {
        entryPoint: string;
    } & {
        entryPoint: string;
        onProgress: (progress: number) => void;
        ignoreRegisterRootWarning: boolean;
        onDirectoryCreated: (dir: string) => void;
        gitSource: import("@remotion/studio-shared").GitSource | null;
        maxTimelineTracks: number | null;
        bufferStateDelayInMilliseconds: number | null;
        audioLatencyHint: AudioContextLatencyCategory | null;
        experimentalClientSideRenderingEnabled: boolean;
        experimentalVisualModeEnabled: boolean;
        renderDefaults: import("@remotion/studio-shared").RenderDefaults | null;
    } & import("./bundle").MandatoryLegacyBundleOptions) => Promise<string>;
};
export type { GitSource } from '@remotion/studio-shared';
export { bundle, BundleOptions, LegacyBundleOptions, MandatoryLegacyBundleOptions, } from './bundle';
export { WebpackConfiguration, WebpackOverrideFn } from './webpack-config';
export { WatchIgnoreNextChangePlugin };
export { webpack };