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.

Once your build is approved, the project gets a share link. Use it directly to send the stream to people, or wrap it in an iframe to drop the experience into your own site.
Sharing tab in the project dashboard showing the Share Link sub-tab with the project's share URL and a Meeting Rooms (Beta) sub-tab.
The fastest way. Send the share link in an email, chat, or button on your site. Anyone who opens it loads the stream in their browser. 
https://share.streampixel.io/{your-project-id}
Each project has exactly one share link. Use the dashboard’s Security settings to gate access (passwords, domain whitelisting). See security control.

​
Option 2: Embed in an iframe

Drop the stream into your own page with a single iframe element: 
<iframe
  src="https://share.streampixel.io/{your-project-id}"
  width="1280"
  height="720"
  allow="autoplay; fullscreen; microphone; camera; xr-spatial-tracking"
  allowfullscreen>
</iframe>
PermissionWhy
autoplayLet the stream start without a user click
fullscreenEnable the fullscreen control
microphoneRequired if you use voice chat
cameraRequired if you use video chat
xr-spatial-trackingRequired for WebXR / VR sessions

​
Option 3: Custom frontend with the Web SDK

If you want full control — custom UI, programmatic events, voice chat hooks — use the Web SDK instead of an iframe.

Web SDK overview

Build a custom player with full control over events and UI.

Iframe integration

Iframe-specific guides: postMessage, stream states, control commands.

​
Embedding tips

Wrap the iframe in a 16:9 container and set the iframe to fill it:
<div style="position: relative; padding-bottom: 56.25%; height: 0;">
  <iframe
    src="https://share.streampixel.io/{your-project-id}"
    style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"
    allow="autoplay; fullscreen; microphone; camera; xr-spatial-tracking"
    allowfullscreen>
  </iframe>
</div>
In the project’s security settings, whitelist the domains that are allowed to embed your stream. Browsers will refuse to load the iframe on other origins.
Use postMessage to send commands and listen for events from the iframe.
Add a custom domain to serve the stream from your own URL.

​
Next steps

Iframe deep dive

postMessage, lifecycle events, control commands.

Custom domains

Serve your stream from play.yourcompany.com.

Security settings

Gate access with passwords or domain whitelisting.

React + HTML samples

Drop-in code for vanilla HTML and React projects.