Getting Started
Integrate StreamLayer into Xbox TV apps using the @streamlayer/web-os React SDK with installation, quick start, and platform-specific notes.

Xbox Integration
StreamLayer supports Xbox TV applications through the @streamlayer/web-os React SDK. This unified SDK enables interactive StreamLayer Elements, pause ads, and real-time engagement features on Xbox devices.
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 Xbox 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.
Getting Started
The Xbox integration uses the same SDK and APIs as other TV platforms. Please refer to our unified TV SDK documentation:
| Documentation | Description |
|---|---|
| Integration Guide | Step-by-step installation and setup |
| Exposed Pause Ad | VAST-compliant pause ad implementation |
System Requirements
- Xbox
- React-based application
- Node.js / JavaScript or TypeScript environment
Quick Installation
npm install @streamlayer/web-osimport { StreamLayerProvider, StreamLayerSDKTv } from '@streamlayer/web-os'
import '@streamlayer/web-os/style.css'
export const Main = () => (
<StreamLayerProvider sdkKey="your-sdk-key" event="your-event-id">
<StreamLayerSDKTv>
<video />
</StreamLayerSDKTv>
</StreamLayerProvider>
)Xbox-Specific Notes
- Remote Control: The SDK supports controller and directional pad navigation using spatial navigation
- Performance: Optimize video and StreamLayer Elements for Xbox browser environments
- Testing: Use Xbox retail devices or dev kits for validation
Support
For Xbox-specific issues or questions:
- Email: [email protected]
Related
- TV SDK Overview — Supported platforms and feature overview
- TV SDK Integration Guide — Complete setup instructions
- WebOS Getting Started — Similar setup for LG WebOS platform
Updated 25 days ago
