PySceneDetect Documentation

Welcome to the PySceneDetect docs. The docs are split into two separate parts: one for the command-line interface (the scenedetect command) and another for the Python API (the scenedetect module).

You can install the latest release of PySceneDetect by running pip install scenedetect (or pip install scenedetect-headless on servers without GUI libraries), or by downloading the Windows build from scenedetect.com/download. PySceneDetect requires ffmpeg or mkvmerge for video splitting support.

Note

If you see any errors in the documentation, or want to suggest improvements, feel free to raise an issue on the PySceneDetect issue tracker.

PySceneDetect development happens on Github at github.com/Breakthrough/PySceneDetect.

Table of Contents

scenedetect Command Reference 🖥️

.. toctree::
    :maxdepth: 2
    :caption: Command-Line Interface:
    :name: clitoc

    cli
    cli/config_file
    cli/backends

scenedetect Python Module 🐍

.. toctree::
    :maxdepth: 2
    :caption: API Documentation:
    :name: apitoc

    api
    api/detectors
    api/output
    api/backends
    api/common
    api/scene_manager
    api/detector
    api/video_stream
    api/stats_manager
    api/platform
    api/migration_guide

Indices and Tables

• :ref:`genindex`
• :ref:`modindex`
• :ref:`search`