SplitCam Plugin API — Develop Your Own Plugins

Plugin types

Available now — and planned.

Currently SplitCam supports image source plugins: they add still images and videos to any scene inside the SplitCam user interface. Audio sources cannot be added yet. Other types may be added in future versions:

Image source Available

Add your own still images, dynamic content and videos as a scene layer.

Image processor Planned

Custom filters processing the video image on the scene.

Event handler Planned

React to SplitCam events from your own code.

Audio source Planned

Provide your own audio streams to the mixer.

Network provider Planned

Custom network transports and integrations.

Other types

The plugin system is designed to grow — more types may follow.

Requirements

How a SplitCam plugin works.

A plugin is a stand-alone DLL library with a well-defined exported function set. Any language works, as long as the output is a DLL with the required unmangled exports.
Every exported function name must start with the splitcam::plugin predicate.
Every plugin must implement at least the minimum IPlugin interface. The actual functionality is defined by the value returned from IPlugin::getType().
Image source plugins must implement the IImageSource interface.
Every plugin must have a unique identifier to distinguish it from other plugins.
Design for multiple instances: SplitCam scenes can contain several instances of your plugin layer, and the user can add one on any scene they find suitable.

Downloads

Everything you need to start.

The documentation, example code and the accompanying header file are primarily aimed at C++ developers — but you can use any language, as long as your output is a DLL with the required exported functions.

C++ header file

splitcam_plugin.h · 20 KB

The commented header declaring all required exports and interfaces — IPlugin, IImageSource and friends. The single source of truth for the API.

Download header

Sample Plugin project

SamplePlugin.zip · MS Visual Studio 2019

A complete, buildable example plugin for Visual Studio — the fastest way to see the exported function set and the plugin lifecycle in working code.

Download sample

Deploying your plugin: place the DLL inside the plugins folder next to the SplitCam executable. On startup SplitCam scans this folder, verifies that each plugin exports enough functions for its type, and adds it to the user interface automatically — where it appears depends on the plugin type.

API reference

Full class-level documentation.

The complete generated reference for the splitcam::plugin namespace — every interface, method, enum and type, straight from the header.

Class list

IPlugin · ISource · IImageSource · IWebSource · IEventHandler — all interfaces with member docs.

Namespace

splitcam::plugin — functions, typedefs, enumerations and exported entry points.

Header reference

splitcam_plugin.h documented line by line — macros, exports and usage comments.

Questions about the API? The fastest way to reach the team is the Telegram support chat — the same developers who build SplitCam read every message.

Develop your own plugins for SplitCam.