Beam Docs

Production docs for Beam sessions, streaming, deployment, and integrations.

Beam supports two product surfaces on one relay-backed protocol: screenshare for support and onboarding, and stream for live apps, games, demos, and browser-ready viewer flows. These docs track the real public API and the current deployment model.

Screenshare sessions Stream sessions Browser viewer Public streams Desktop companion Mobile companion HLS/LL-HLS edge Workspace roles Relay + signaling Control-plane API

Quickstart

Launch the Windows host app, choose the right session mode, and move a viewer into Beam without exposing raw infrastructure.

Stream Mode

Use Beam for game streaming, live app sessions, product walkthroughs, and branded browser viewer experiences.

Integrations

Copy real API examples for WordPress, Laravel, PHP, Python, Java, C#, Android, iOS, Flutter, and React Native.

Discord Activity

Run Beam as a Discord Activity so viewers can watch a live stream inside a Discord voice channel.

SaaS Ecosystem

Accounts, dashboard users, roles, permissions, public/private streams, sources, layouts, and companion responsibilities.

Stream SDK

Use Beam inside websites, games, dashboards, browser capture flows, cameras, canvas streams, and custom app media sources.

AI Support

Capture live session context, suggest next steps, approve AI actions, and generate ticket-ready handoff summaries.

Embedded Assist

Create support invites from Intercom, Help Scout, native apps, or custom consoles and run Beam inside your own interface.

Support Connectors

Map Beam Assist into Intercom, Help Scout, Zendesk, custom support desks, product apps, and device companions.

Windows Companion

Create Beam streams, publish one/all Windows displays, and arrange split layouts without OBS.

Mobile Stream Studio

Publish phone cameras, invite other companions, and place face overlays inside the shared Beam scene layout.

Media Edge

Configure WHIP ingest, WHEP playback, HLS/LL-HLS output, and SFU-ready simulcast provider settings for production streams.

API Reference

See the exact payloads for typed sessions, join token exchange, acceptance, and lifecycle state.

Deployment

Review the ports, environment variables, reverse-proxy hints, and stateful caveats required for production rollout.

Beam architecture at a glance

Host surface

The Windows host app exposes a share code, hosting controls, recent sessions, relay settings, audio support, and the current capture pipeline.

Viewer surface

Beam supports a native relay viewer and a browser-facing WebRTC viewer path from the same session model.

Control plane

External systems create typed sessions, carry metadata, exchange join tokens, accept or end sessions, and fan that flow into their own UI.

Transport

The current protocol carries adaptive H.264 video over the relay, system audio over signaling, and browser viewing through the WebRTC bridge.