Reference
Factual description of the API. For learning, start with the
tutorials; for a specific task, see the how-to
guides; for design rationale, see
explanation.
Everything outside videopython.ai (and the optional MCP server) works with a plain
pip install videopython — no ML dependencies.
videopython.base
| Page |
Contents |
| Video |
Video, VideoMetadata, FrameIterator |
| Transcription and subtitles |
Transcription, TranscriptionSegment, TranscriptionWord, TranscriptionOverlay |
Shared result types (BoundingBox, DetectedObject, FaceTrack, SceneBoundary,
SceneDescription, AudioClassification, …) are documented alongside the analyzers that
produce them, in AI understanding.
videopython.audio
| Page |
Contents |
| Audio |
Audio plus its metadata, level, silence and classification types |
videopython.editing
| Page |
Contents |
| Edit plans |
VideoEdit, SegmentConfig, the JSON wire format, validation and schema generation |
| Operations |
The Operation base, the registry, and the full op table |
| Transforms |
Resize, Crop, ResampleFPS, SpeedChange, FreezeFrame, SilenceRemoval |
| Effects |
Blur, zoom, color, overlays, fades and the rest |
videopython.ai
Requires the [ai] extra (Install).
| Page |
Contents |
| Generation |
TextToVideo, ImageToVideo, TextToImage, TextToSpeech, TextToMusic |
| Understanding |
AudioToText, AudioClassifier, SceneVLM, SemanticSceneDetector, face trackers, ObjectDetector, result types |
| Video analysis |
VideoAnalyzer, VideoAnalysisConfig, VideoAnalysis |
| Auto-editing |
AutoEditor, planners, catalog and plan types |
| Dubbing |
VideoDubber, DubbingConfig, result types, supported languages |
| AI operations |
FaceTrackingCrop, ObjectDetectionOverlay, the detection renderer |
videopython.mcp
| Page |
Contents |
| MCP server |
The videopython-mcp tools and resource |
Import patterns
from videopython import Video # the one top-level convenience
from videopython.base import Video, VideoMetadata, FrameIterator, Transcription
from videopython.audio import Audio, AudioMetadata
from videopython.editing import VideoEdit, SegmentConfig # plans
from videopython.editing import Operation, Effect, TimeRange, OpCategory
from videopython.editing import Resize, Crop, Blur # operations
from videopython.ai import TextToVideo, TextToImage, AudioToText
from videopython.ai.dubbing import VideoDubber, DubbingResult, RevoiceResult