Getting Started

Xbox Integration

StreamLayer supports Xbox TV applications through the @streamlayer/web-os React SDK. This unified SDK enables interactive overlays, pause ads, and real-time engagement features on Xbox devices.

Getting Started

The Xbox integration uses the same SDK and APIs as other TV platforms. Please refer to our unified TV SDK documentation:

DocumentationDescription
Integration GuideStep-by-step installation and setup
Exposed Pause AdVAST-compliant pause ad implementation

System Requirements

  • Xbox
  • React-based application
  • Node.js / JavaScript or TypeScript environment

Quick Installation

npm install @streamlayer/web-os
import { 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 overlays for Xbox browser environments
  • Testing: Use Xbox retail devices or dev kits for validation

Support

For Xbox-specific issues or questions: