Skip to content

API Reference

videopython is organized into two main modules:

videopython.base

Core video and audio processing functionality with no AI dependencies:

  • Video - Core video class for loading, manipulating, and saving videos
  • Audio - Core audio class for loading, manipulating, analyzing, and saving audio
  • Scene Detection - Detect scene changes using histogram comparison
  • Editing Plans (VideoEdit) - Multi-segment editing plans with JSON parsing, validation, and schema generation
  • Transforms - Frame transformations (cut, resize, resample)
  • Transitions - Video transitions (fade, blur)
  • Effects - Visual effects (blur, zoom, overlays)
  • Text & Transcription - Subtitle rendering and transcription data structures
  • Operation Registry - Machine-readable operation metadata and discovery API

videopython.ai

AI-powered generation and understanding (requires [ai] extra):

  • Generation - Generate videos, images, music, and speech from text
  • Understanding - Transcribe audio, describe images, detect scenes
  • Video Analysis - Aggregate serializable analysis across audio, temporal, motion, and frame understanding
  • Dubbing - Dub videos into different languages or revoice with custom text
  • Object Swapping - Replace, remove, or modify objects in videos
  • AI Transforms - Face tracking crops, split-screen, and auto-framing

Import Patterns

# Top-level import for core class
from videopython import Video

# Import specific classes from base
from videopython.base import (
    Video,
    Audio,
    AudioMetadata,
    SceneDetector,
    CutSeconds,
    FadeTransition,
    Transcription,
)

# Import registry API
from videopython.base import (
    get_operation_specs,
    get_operation_spec,
    get_specs_by_category,
    OperationCategory,
)

# Import AI classes
from videopython.ai import (
    TextToVideo,
    TextToImage,
    AudioToText,
)

# Import dubbing classes
from videopython.ai.dubbing import (
    VideoDubber,
    DubbingResult,
    RevoiceResult,
)