Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.streampixel.io/llms.txt

Use this file to discover all available pages before exploring further.

The fastest way to embed a Streampixel stream into an existing website or web app. Drop in an iframe, configure a few attributes, and use postMessage to drive the stream from your frontend — no SDK required.

What you’ll find here

Basic iframe integration

Embed the iframe and configure autoplay, fullscreen, and input handling.

Frontend and app communication

Send and receive messages between your frontend and the iframe via postMessage.

Stream states

Hook into lifecycle events like authenticating and loadingComplete to drive your UI.

Stream control commands

Mute audio, change resolution, and control the stream programmatically.

Sample code (HTML + React)

Drop-in examples for vanilla HTML and React.

When to use the iframe vs. the Web SDK

Use the iframe

You want to embed a stream quickly with minimal code, or your frontend isn’t JavaScript-based.

Use the Web SDK

You need fine-grained control over the player, custom UI, voice chat, or programmatic event handling.