Vindral Documentation

Welcome to the official documentation of Vindral.

Test our interactive demo 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 streams.

Getting started

🔗 Examples

Test examples of player and sender applications and look at the code for a good entry point into the Vindral 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.

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