Getting Started

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

LG WebOS Integration

StreamLayer provides full support for LG WebOS TV applications through the @streamlayer/web-os React SDK. This unified SDK enables interactive StreamLayer Elements and real-time engagement features on LG Smart TVs.

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 LG webOS 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 WebOS 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

  • LG WebOS
  • 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>
)

WebOS-Specific Notes

  • Remote Control: The SDK handles LG Magic Remote and standard remote navigation automatically using spatial navigation
  • Performance: The SDK is optimized for WebOS's rendering engine
  • Testing: Use the LG WebOS TV Simulator or physical LG TV for development

Support

For WebOS-specific issues or questions:


Related