Skip to main content

Overlay Streaming (Dashboard)

This guide walks through setting up overlay streaming entirely from the dashboard — no API calls required. It composites a live web page (a scoreboard, lower-third, sponsor bar) on top of your video. For the API-driven version of the same flow, see Overlay Streaming (API).

1. Create a stream​

  1. Open your video foundation project and go to the Streams page.
  2. Click Create Stream.
  3. Fill in the Stream Name and Private Key (a key is auto-generated for you).
  4. Choose an Authentication type (Public, JWT, or Webhooks).
  5. Click Create Stream.

This is your main stream — the one you'll send video into.

2. Configure the overlay​

  1. Open the stream you just created from the Streams list.
  2. Go to the Overlay Config tab.
  3. Enter the Target URL — the web page that will be captured and rendered as an overlay on the video.
  4. The Render Type is fixed to html2img (read-only).
  5. Optionally add extra Args for the render plugin with Add Arg (for example -W 1280 for a custom viewport width).
  6. Click Submit.

The dashboard wires your target URL into the render args for you and applies a default config retention, so you don't set those by hand — see the Overlay Streaming (API) guide for the exact argument shape and current defaults. On submit, it creates an overlay stream named Overlay-{yourStreamName} under the same program if one doesn't already exist.

What's happening underneath

"Overlay Config" is the dashboard's wrapper around the render config and the filtergraph overlay stream described in Overlay Streaming (API) — the dashboard just fills in the html2img args, creates the overlay stream, and wires the appdata for you.

3. Start streaming​

You can stream via RTMP or Aperture Live (WebRTC).

Option A — RTMP​

  1. Go to the RTMP Ingress tab on your main stream.
  2. Copy the RTMP URL and Stream Key.
  3. Paste them into your streaming software (for example OBS).
  4. The stream key already includes the overlay configuration — the platform composites the overlay and pushes the result to the overlay stream automatically.

Option B — Aperture Live (mobile)​

  1. Go to the Aperture Live Streaming tab on your main stream.
  2. Configure your broadcast settings — streaming mode (Fixed or Adaptive), resolution, bitrate mode, video/audio bitrate, lock orientation, and an optional platform URL.
  3. Click Generate QR Code.
  4. Scan the QR code with the Aperture Live app, or share the generated deep link.
  5. Start broadcasting from the app.

4. Play back the overlay stream​

  1. Go back to the Streams list.
  2. Find the Overlay-{yourStreamName} stream that was created automatically.
  3. Open it and go to the Stream Playback tab.
  4. Click Play Stream to see the live video with the overlay rendered on top.

You can also copy the Manifest URL from the playback tab to use in your own player or embed on your site.

Related