Welcome to voctomix's documentation!
=====================================

**voctomix** is a live video mixer based on Python and GStreamer.

Depending on the capabilities of your hardware, you can use it to mix
up to 4K video. voctomix includes a so-called "stream blanker" (blinder),
which can be used to show an animation on the livestream while still recording
the mixed video feed to disk.

.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   installation
   definitions

.. toctree::
   :maxdepth: 2
   :caption: voctocore

   voctocore/index
   man/voctocore
   voctocore/configuration
   voctocore/sources/index
   voctocore/ports

.. toctree::
   :maxdepth: 2
   :caption: voctogui

   voctogui/index
   man/voctogui
   voctogui/configuration

.. toctree::
   :maxdepth: 2
   :caption: Advanced

   transitions
   example-scripts


Indices and tables
==================

* :ref:`search`