Filters Reference

Complete reference for video and audio filters.

Video Filters

ScaleFilter

Resize video.

interface ScaleFilter {
  width?: number | string;
  height?: number | string;
  algorithm?: ScalingAlgorithm;
  force_original_aspect_ratio?: 'disable' | 'decrease' | 'increase';
  force_divisible_by?: number;
}

Example:

filters: {
  scale: {
    width: 1920,
    height: 1080,
    algorithm: ScalingAlgorithm.LANCZOS,
  },
}

CropFilter

Crop video to specific dimensions.

interface CropFilter {
  width: number | string;
  height: number | string;
  x?: number | string;
  y?: number | string;
  keep_aspect?: boolean;
}

Example:

filters: {
  crop: {
    width: 1920,
    height: 800,
    x: 0,
    y: 140,  // Crop letterboxing
  },
}

TextFilter

Add text overlay.

interface TextFilter {
  text: string;
  x?: string | number;
  y?: string | number;
  fontsize?: number | string;
  fontcolor?: string | Color;
  fontfile?: string;
  shadowcolor?: string | Color;
  shadowx?: number;
  shadowy?: number;
  box?: boolean;
  boxcolor?: string;
  borderw?: number;
}

Example:

filters: {
  text: {
    text: '© 2024',
    x: '(w-tw)/2',
    y: 'h-th-50',
    fontsize: 24,
    fontcolor: Color.WHITE,
    shadowx: 2,
    shadowy: 2,
  },
}

OverlayFilter

Add image watermark.

interface WatermarkFilter {
  image: string;
  x?: number | string;
  y?: number | string;
  opacity?: number;
  scale?: number;
}

Example:

filters: {
  overlay: {
    image: 'logo.png',
    x: 10,
    y: 10,
    opacity: 0.8,
  },
}

FadeFilter

Fade in/out effect.

interface FadeFilter {
  type: 'in' | 'out';
  startTime?: number;
  duration: number;
}

Example:

filters: {
  fade: {
    type: 'in',
    startTime: 0,
    duration: 2,
  },
}

RotateFilter

Rotate video.

interface RotateFilter {
  angle?: number;      // Radians
  degrees?: number;    // Degrees
  fillcolor?: string | Color;
}

Example:

filters: {
  rotate: {
    degrees: 90,
    fillcolor: Color.BLACK,
  },
}

FlipFilter

Flip video horizontally or vertically.

interface FlipFilter {
  horizontal?: boolean;
  vertical?: boolean;
}

Example:

filters: {
  flip: {
    horizontal: true,
  },
}

Audio Filters

VolumeFilter

Adjust audio volume.

interface VolumeFilter {
  volume: number | string;
  precision?: 'fixed' | 'float' | 'double';
}

Example:

filters: {
  volume: {
    volume: 0.8,  // 80%
  },
}

TempoFilter

Change playback speed.

interface TempoFilter {
  tempo: number;  // 0.5-2.0
}

Example:

filters: {
  tempo: {
    tempo: 1.5,  // 1.5x speed
  },
}

See Also

• Video Configuration
• Audio Configuration
• Enums