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.

Start with your AI coding assistant

Connect your assistant to StreamLayer docs before changing code, then use this prompt. The connection lets it search the current guides and read the platform integration skill as it works.

Help me integrate StreamLayer into my existing React-based TV app using @streamlayer/web-os.
Use the streamlayer-docs MCP to search for and fetch the matching integration
guide and the streamlayer-web-integration skill page before editing code.
If search does not return the skill, read https://docs.streamlayer.io/docs/web-sdk-integration-skill
or ask me to copy that page into this session.
Cite the sources, confirm my SDK version and prerequisites, and make the smallest
documented change while preserving my player and app structure. Report missing
or conflicting guidance instead of guessing. Use placeholder keys in examples.
Finish with the checks run and the remaining platform/device validation steps.

Review the diff and follow the platform setup and testing guidance linked below.

Supported Platforms

The @streamlayer/web-os package supports the following TV platforms:

Module Formats

@streamlayer/web-os ships as a dual-format package — ESM and CJS:

// ESM — esnext, modern syntax
import { StreamLayerProvider, StreamLayerSDKTv } from '@streamlayer/web-os'

// CJS — ES2015, transpiled with Babel for older environments
const { StreamLayerProvider, StreamLayerSDKTv } = require('@streamlayer/web-os')

Classic (/classic)

The /classic entry point is a mirror of the default exports — it resolves to the same files. It exists for backward compatibility with integrators already using /classic import paths:

// These are equivalent:
import { StreamLayerProvider } from '@streamlayer/web-os'
import { StreamLayerProvider } from '@streamlayer/web-os/classic'

Polyfills

The SDK provides an optional polyfills bundle for environments that lack modern browser APIs. Import it once at the top of your application entry point, before any SDK imports:

import '@streamlayer/web-os/polyfills'

The polyfill packages are listed as peer dependencies — install only the ones you need:

pnpm add core-js regenerator-runtime text-encoding-utf-8 \
  intersection-observer resize-observer-polyfill \
  web-streams-polyfill whatwg-fetch abortcontroller-polyfill

Note: If your application already polyfills these APIs (e.g., via @babel/preset-env with useBuiltIns), you may not need the polyfills bundle at all.

Styles

Import the SDK stylesheet in your application:

import '@streamlayer/web-os/style.css'

This is required for all visual SDK components to render correctly.

Quick Start

1. 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.

2. Review the Integration Guide
   Visit the Integration Guide for a step-by-step walkthrough on installing, configuring, and initializing the SDK.

3. Explore Features
   Learn about specific features available for TV platforms:

• Exposed Pause Ad – High-impact advertising when video is paused
• Double Box Ad – 50/50 split-screen advertising alongside the video player
• Split Components – Fine-grained control over SDK UI element placement

What You Can Build

System Requirements

• Node.js: 18+
• React: 17+
• Package: @streamlayer/web-os (single unified package for all TV platforms)

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]

Related

• TV SDK Integration Guide — Complete setup and configuration
• Exposed Pause Ad — High-impact pause ad implementation
• Double Box Ad — 50/50 split-screen ad integration
• Platform-Specific Getting Started Guides — WebOS, Tizen, VIDAA, and Xbox setup