Vindral Composer Reference Guide
Welcome to the Composer Reference Guide — the home for everything you need to install, learn, run, and integrate with Vindral Composer.
Pick a manual from the cards below, browse with the panel on the left, or press Ctrl+K on any page to search the whole site.
Get started
New to Composer — install it, learn the Desktop interface, and follow worked examples.
-
Getting StartedInstall Composer, activate your license, and open your first project — the end-to-end path from a fresh download to a running composition on screen.
-
User GuideThe Composer Desktop UI and the workflows that span multiple components — projects, scenes and layers, blend modes, chroma keying, audio mixing, performance mode.
-
Tutorial ProjectsDownloadable example projects hosted by RealSprint — chroma keying, multibranding, AI overlays, audio synchronisation — each with a thumbnail and short description so you can pick one that matches what you're trying to learn.
-
How-to videosNarrated how-to videos that walk through common Composer workflows — searchable and grouped into series, each with the components it uses.
Component reference
Every input, operator, and target you can drop into a project, with screenshots and per-section property tables.
-
InputsEvery Composer input component — capture cards, file readers, network sources, generators — with screenshots and per-section property tables.
-
OperatorsEvery Composer operator — keyers, blurs, AI, audio processors, effects — with screenshots and per-section property tables.
-
TargetsEvery Composer target — file writers, streaming endpoints, hardware outputs — with screenshots and per-section property tables.
Run in production
For operators and administrators deploying, monitoring, configuring, and tuning Composer for live operation.
-
Composer RuntimeThe headless playback engine — install, command-line arguments, configuration, container deployment, and logging for production deployments without a GUI.
-
Operations & TuningRun Composer in production — performance tuning, log inspection, OpsGenie alerts.
-
Composer MonitorThe optional Composer Monitor plug-in — Grafana / Loki / Prometheus stack with pre-built dashboards for centralised multi-instance monitoring.
-
SettingsEvery property in `settings.xml` — the configuration file Composer reads at startup.
Develop & integrate
For developers driving and extending Composer from their own code — the HTTP, Runtime, and WebSocket APIs, the embedded Script Engine, and the data types they share.
-
Integration & RuntimeDrive Composer from outside — when to reach for HTTP API vs Connectors vs Batches vs Script Engine, plus Stream Deck remote control via Bitfocus Companion.
-
HTTP APIHTTP endpoints exposed by Composer for project control, statistics, media, streaming, and more.
-
Runtime APILifecycle endpoints for VindralComposerRuntime — start, stop, reload, project management.
-
WebSocketsReal-time event stream — connection model, message envelope, subscription channels, and quick-start client code.
-
Script EngineJavaScript runtime embedded in Composer — events, host objects, and helper functions for project scripts.
-
Script Engine ObjectsEvery scene, layer, input, operator and target exposed to project scripts.
-
DatatypesEnums and shared data classes referenced by properties across the rest of the docs.
Reference & help
What changed in each release, and fixes for common problems.