Vindral Live Documentation
Welcome to the official Vindral Live documentation.
Try our interactive demos at demo.vindral.com, find information about features at vindral.com, or read on for guides that explain how to manage, send, and consume Vindral Live streams.
Getting started
🔗 Examples
Test examples of player and sender applications and look at the code for a good entry point into the Vindral Live ecosystem.
🔗 Demo player
Test the demo player to see what an example of how channel switching works.
📄️ Demo channels
Use the 24/7 demo channels for testing your application and for faster development process.
📄️ Embeddable player
Use the embeddable player without having previous knowledge of code or video.
📄️ Broadcast from OBS
Learn how to broadcast from a popular, free, and highly customizable video software.
📄️ Broadcast from browser
Use the Vindral WebRTC Ingest to easily broadcast from the browser, without the need for plugins and software installations.
Deployment Options
Vindral Live's family of components can be used on-prem, in-cloud or hybrid, stand-alone or together as a platform.
Whichever way Vindral Live is integrated, it enables Media over QUIC (MoQ) and many other protocols for your streaming needs.
📦 Vindral LiveEngine
The self-managed live CDN platform, built for low-latency streaming at scale. It supports MoQ, LLHLS, RTMP, SRT, and more — and can be white-labeled, OEM licensed, and deployed in your own infrastructure.
☁ Vindral LiveCloud
The global live CDN service, powered by Vindral LiveEngine, with user Portal, SLAs and multi-provider redundancy.
🚚 Vindral LivePackager
The muscles of LiveEngine can be run on-prem or in-cloud, offering real-time transcode, scale, multi-input/output, multi-protocol, with or without hardware offload.
Build custom experiences
📄️ Custom web sender
Learn how to use the WebRTC Ingest SDK to integrate a sender application on your own website.
📄️ Custom web player
Learn how to use the WebSDK to create a customer player interface on your own websites and applications.
📄️ API integration
Learn how to use the API to manage channels, retrieve telemetry, and more.
📄️ Timed metadata
Learn how to use timed metadata to build synchronized user experiences.
Monitor and debug
📄️ Quality of Service player
Learn how to use the QoS Client to monitor, verify, and debug channels.
📄️ Quality of Service WebRTC sender
Learn how to use the QoS WebRTC Sender to monitor, verify, and debug channels, or just to quickly broadcast with lots of statistics.
📄️ Troubleshooting
Find solutions to common issues.
API Reference
🔗 WebSDK API Reference
Delve into the functions, properties and interfaces of the WebSDK.
🔗 WebRTC Ingest SDK API Reference
Use the WebRTC Ingest API reference to learn more about how to send streams from the browser.
🔗 AppleSDK API Reference
Read about the classes, protocols and structures of the AppleSDK.
🔗 Management API Reference
Learn how to use the API to manage channels, retrieve telemetry, and more.
Composer
🔗 Composer Documentation
Learn how to use Composer for dynamic video composition, color correction, chroma-keying, visual effects, and live streaming.
🔗 Live casino workhorse
Learn why Composer is the ultimate workhorse for authentic live casino experiences at 24/7 large-scale operations.