Vindral Composer Reference Guide

Generated for Composer R2-2026-2.6.9642.28010 on 2026-05-27

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.

Manuals

• Getting Started
  Install Composer, activate a license, and open your first project.
• User Guide
  The Composer Desktop UI and the workflows that span multiple components — projects, scenes and layers, blend modes, chroma keying, audio mixing, performance mode.
• Tutorials
  Downloadable 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.
• Inputs
  Every Composer input component — capture cards, file readers, network sources, generators — with screenshots and per-section property tables.
• Operators
  Every Composer operator — keyers, blurs, AI, audio processors, effects — with screenshots and per-section property tables.
• Targets
  Every Composer target — file writers, streaming endpoints, hardware outputs — with screenshots and per-section property tables.
• Operations & Tuning
  Run Composer in production — performance tuning, log inspection, OpsGenie alerts.
• Composer Monitor
  The optional Composer Monitor plug-in — Grafana / Loki / Prometheus stack with pre-built dashboards for centralised multi-instance monitoring.
• Composer Runtime
  The headless playback engine — install, command-line arguments, configuration, container deployment, and logging for production deployments without a GUI.
• Integration & Runtime
  Drive 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 API
  HTTP endpoints exposed by Composer for project control, statistics, media, streaming, and more.
• Runtime API
  Lifecycle endpoints for VindralComposerRuntime — start, stop, reload, project management.
• WebSockets
  Real-time event stream — connection model, message envelope, subscription channels, and quick-start client code.
• Script Engine
  JavaScript runtime embedded in Composer — events, host objects, and helper functions for project scripts.
• Script Engine Objects
  Every scene, layer, input, operator and target exposed to project scripts.
• Settings
  Every property in `settings.xml` — the configuration file Composer reads at startup.
• Datatypes
  Enums and shared data classes referenced by properties across the rest of the docs.
• Release Notes
  What's new in each Composer release — features, changes, and breaking notes worth flagging before upgrading.
• FAQ & Troubleshooting
  FAQ and runbooks for common symptoms — startup failures, audio issues, dropped frames, license problems.