Introducing Web SDK
Welcome to the official documentation for the Maestro Web SDK for building experiences into Browser-Based Devices (BBD) on TV. This documentation provides a comprehensive guide on how to integrate Maestro into any web based application.
This guide is for BBD applications. For other devices, please check out the other relevant SDKs.
Getting Started
If you're new to the Maestro Web SDK, we recommend starting with the Getting Started guide. This guide will walk you through the process of adding the SDK to your web based project, initializing the SDK, and getting you up and running quickly.
Overlays
Overlays are short-lived, animated surfaces the SDK renders over your page — a settled bet, a fantasy update, a promo — that dismiss themselves after a few seconds. Your app doesn't render them; it implements one delegate method and the SDK does the rest. See the Overlays section for how they work and the Overlay Integration guide to wire them up.
Example Repo
Maestro's Example Repo contains a fully working app integrated with the Maestro Web SDK. It demonstrates initialization, basic usage, and handling events in a real-world project setup. There is also a Hello World Pull Request that will help you with a minimal setup required to get the SDK and Panels working.
You can clone the repo, run it locally, and explore the code to better understand how to implement the SDK in your own projects. Further instructions for implementation are included in the README of the repo.
Need Help?
If you have any questions or need assistance while integrating or using the Maestro Web SDK, don't hesitate to reach out to our support team. We're here to help you succeed!
Now, let's dive into the documentation and unleash the power of interactive video experiences with Maestro.