Dialogue Guardian Documentation

Dialogue Guardian is a universal media censor that automatically detects and censors profane language in video files by processing SRT subtitle files.

Features

• Direct Audio Censoring: Uses FFmpeg’s audio filters to mute profane segments

• Universal Compatibility: Works on any OS with FFmpeg installed (Windows, macOS, Linux)

• Automatic SRT Extraction: Extracts embedded SRT tracks from video files

• Non-Destructive: Creates new video files, leaving originals untouched

• Efficient Processing: Copies video streams without re-encoding

• Python API: Programmatic access to all functionality

• Command Line Interface: Easy-to-use CLI with comprehensive options

Quick Start

Installation:

pip install dialogue-guardian

Basic Usage:

# Command line
guardian movie.mp4

# Python API
from guardian import GuardianProcessor
processor = GuardianProcessor()
result = processor.process_video("movie.mp4")

Contents

User Guide:

• Installation
  • Requirements
  • Installing Python
  • Installing FFmpeg
  • Installing Dialogue Guardian
  • Verification
• Quick Start Guide
  • Basic Usage
  • Command Line Options
  • Python API
  • Custom Configuration
  • File Requirements
  • Troubleshooting
• Command Line Interface
  • Basic Syntax
  • Arguments
  • Options
  • Examples
  • Alternative Command
  • Exit Codes
  • Error Handling
  • Logging

API Reference:

• Guardian Package API
  • Core Module
  • CLI Module
  • Package Module

Development:

• Contributing to Dialogue Guardian
• Changelog

Indices and tables

• Index

• Module Index

• Search Page