Home - shycats/PyVirtuCamera GitHub Wiki

Welcome to the PyVirtuCamera wiki!

PyVirtuCamera is a Python module API to create VirtuCamera plug-ins.

To use it, just download it from the releases section and place it within your project, where you would normally place other Python dependencies. It contains a Python C-Extension module, so it's important to pick a release compatible with your Python version. (e.g.: cp37 for CPython 3.7)

Then you can just import virtucamera.

It has two main classes, virtucamera.VCServer and virtucamera.VCBase. The first one provides the methods to handle communication with the app, the second one is an abstract base class that must be overloaded to implement most of its methods, where each method is dedicated to set or get some specific data related to the scene, the cameras, viewport capturing, server feedback, and custom script calling.

API Reference

You can check the source code of plug-ins already using PyVirtuCamera, as examples of how to use the API:

Disclaimer - We cannot be held responsible for any damages to your code or project-schedule as a result of your study and use of this documentation. We are not obliged to make any changes to the API at your request. When using this reference or inquiring for support, you do so at your own risk.