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.
For details about Vindral Composer, visit its dedicated documentation page.
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 hosted Vindral Publisher to broadcast from the browser over MoQ without installing additional software.
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 player
Learn how to use the Web SDK to create a custom player interface on your own websites and applications.
📄️ Custom browser publisher
Learn how to use the Publisher SDK to integrate browser-based publishing over MoQ on your own website.
📄️ 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.
📄️ Troubleshooting
Find solutions to common issues.
API Reference
🔗 Web SDK API Reference
Delve into the functions, properties and interfaces of the Web SDK.
🔗 Publisher SDK API Reference
Explore the Publisher SDK API to publish live streams from the browser over MoQ.
🔗 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.