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 — drop in an iframe, configure a few attributes, and use postMessage to drive the stream from your frontend. No SDK required.

​
Pages in this section

What it covers
Basic embedThe minimum iframe markup, autoplay, fullscreen, and input handling.
Stream statesLifecycle events (authenticating, loadingComplete, etc.) for driving your UI.
Stream control commandsMute, change resolution, take a screenshot — programmatic stream control.
Frontend & app communicationSend and receive messages between your page and the iframe via postMessage.
Sample code (HTML + React)Drop-in examples.

​
Iframe vs. Web SDK

Use the iframe to embed quickly with minimal code, or when your frontend isn’t JavaScript-based. Use the Web SDK when you need fine-grained control — custom UI, voice chat, programmatic events, or full lifecycle hooks.