Documentation

Web Games (5 min)

Stream any HTML5 canvas game with 5 lines of code. Works with Phaser, Three.js, PixiJS, Unity WebGL, and more.

import Substream from '@substream/web-sdk';

const session = await Substream.startStream({
  canvasElement: document.querySelector('canvas'),
  backendUrl: 'https://your-api.com',
  authToken: 'your-token',
});

Unity Native

Copy the SDK scripts into your Unity project, add the streaming component, and configure your backend URL.

// 1. Add IVSRealTimeStreamControl to a GameObject
// 2. Configure in Inspector:
//    Backend URL: https://your-api.com
//    Streamer ID: player-123
//    Auth Token:  your-token
// 3. Start streaming:
streamControl.StartStreaming(); // or press 'U'

Script Tags (zero build step)

For the simplest integration, just add two script tags. No npm, no bundler.

<script src="https://web-broadcast.live-video.net/1.32.0/amazon-ivs-web-broadcast.js"></script>
<script src="substream.js"></script>
<script>
  const session = await Substream.startStream({
    canvas: document.getElementById('game-canvas'),
    backendUrl: 'https://your-api.com',
    childId: 'player-123',
    authToken: 'your-token',
  });
</script>

Streams

A stream is created when a player starts broadcasting. The SDK captures the canvas, encodes it via WebRTC, and publishes to an IVS Real-Time stage. Streams are tracked in the dashboard with live status, duration, and viewer count.

Recordings

Every stream is automatically recorded to S3 via IVS. Recordings appear in the dashboard once the stream ends. They can be played back as VODs or used as input for AI highlight generation.

AI Highlights

The highlight service analyzes recordings using Google Cloud Video Intelligence and Gemini to identify the best moments. It scores segments by visual action, audio intensity, and AI analysis, then assembles a polished highlight reel with crossfade transitions.

Webhooks

Register webhook endpoints to receive real-time notifications. Events include stream.started, stream.stopped, viewer.joined, and viewer.left. Payloads are HMAC-signed for security.