Getting Started
Welcome to the StreamLayer Web SDK for TV Platforms documentation. This SDK enables seamless integration of StreamLayer's interactive features into smart TV applications built with React.
Supported Platforms
The @streamlayer/web-os package supports the following TV platforms:
| Platform | Documentation |
|---|---|
| LG WebOS | Getting Started |
| Samsung Tizen | Getting Started |
| Hisense VIDAA OS | Getting Started |
| Xbox | Getting Started |
React 17 (Classic) Build
If your app is on React 17 or earlier, use our classic build with integrated polyfills by importing from the classic path:
@streamlayer/web-os/classic
Quick Start
-
Understand StreamLayer's Capabilities Start by reading the Introduction and Architecture Overview sections for a high-level overview of the SDK and its key features.
-
Review the Integration Guide Visit the Integration Guide for a step-by-step walkthrough on installing, configuring, and initializing the SDK.
-
Explore Features Learn about specific features available for TV platforms:
- Exposed Pause Ad – High-impact advertising when video is paused
- Split Components – Fine-grained control over SDK UI element placement
Key Features
- React-Based Integration – Built for React applications, making it easy to integrate with existing TV app codebases
- Unified Package – Single
@streamlayer/web-ospackage works across all supported TV platforms - Interactive Overlays – Display polls, trivia, stats, and more during live streams
- Pause Ad Support – VAST-compliant advertising overlays when content is paused
- Remote Control Navigation – Full support for TV remote interactions using spatial navigation
Support
Need assistance? Use our AI-assisted search in the documentation to quickly find answers to your questions.
For direct support, reach out via:
- Email: [email protected]
Updated 2 days ago