Types

All shared type definitions exported from ffmpeg-kit.

OperationResult<T>

The return type of .tryExecute() on all builders.

type OperationResult<T> =
  | { success: true; data: T }
  | { success: false; error: FFmpegError };

ExecuteOptions

Options accepted by .execute() and .tryExecute() on all builders.

interface ExecuteOptions {
  cwd?: string;
  timeout?: number;
  onProgress?: (progress: ProgressInfo) => void;
  signal?: AbortSignal;
  env?: Record<string, string>;
  logLevel?: FFmpegLogLevel;
  overwrite?: boolean;
}

ProgressInfo

Progress callback argument for long-running operations.

interface ProgressInfo {
  percent: number;       // 0–100
  currentTime: number;   // current time position in seconds
  speed: number;         // encoding speed multiplier
  fps: number;           // frames per second
  frame: number;         // current frame number
  size: number;          // output size so far in bytes
  bitrate: number;       // target bitrate in kbits/s
}

Result types

Each operation returns a typed result. Common fields across all operations:

// Most operations include at minimum:
interface BaseResult {
  outputPath: string;
  size: number;          // file size in bytes
  probeResult: ProbeResult;
}

See each operation page for its specific result type:

• ExtractResult
• TransformResult
• AudioResult
• ConcatResult
• ExportResult
• OverlayResult
• TextResult
• SubtitleResult
• ImageResult
• StreamingResult
• GifResult

HwAccelMode

type HwAccelMode = "auto" | "nvidia" | "vaapi" | "qsv" | "vulkan" | "cpu";

FFmpegLogLevel

type FFmpegLogLevel =
  | "quiet" | "panic" | "fatal" | "error"
  | "warning" | "info" | "verbose" | "debug" | "trace";

CreateFFmpegOptions

Options for createFFmpeg().

interface CreateFFmpegOptions {
  ffmpegPath?: string;
  ffprobePath?: string;
  tempDir?: string;
  defaultTimeout?: number;
  defaultHwAccel?: HwAccelMode;
  logLevel?: FFmpegLogLevel;
}

BatchResult<T>

interface BatchResult<T> {
  succeeded: number;
  failed: number;
  total: number;
  results: Map<T, unknown>;
  errors: Map<T, FFmpegError>;
}

SilenceRegion

interface SilenceRegion {
  start: number;
  end: number;
  duration: number;
}

Related

• Core API — execute(), ExecuteOptions
• Probe API — ProbeResult and stream types
• Errors API — FFmpegError and error codes