MediaStream (Web API)

Browser (WASM)

A generic browser outputs that returns MediaStream object. Stream like this can be used by various browser APIs like rendering to canvas or sending it via WebRTC connection.

Usage

streamOutputExample.tsx

import Smelter from "@swmansion/smelter-web-wasm";
import { View } from "@swmansion/smelter";

async function run() {
  const smelter = new Smelter();
  await smelter.init();
  await smelter.registerOutput('example', <View />, {
    type: 'stream',
    video: {
      resolution: { width: 1920, height: 1080 },
    },
    audio: true;
  })
}
void run()

Reference

Type definitions

type RegisterStreamOutput = {
  type: "stream";
  video?: StreamOutputVideo;
  audio?: boolean;
};

Properties

video

Parameters of a video track that will be part of MediaStream.

• Type: StreamOutputVideo

---

audio

If true MediaStream returned from a register call will include audio track.

• Type: boolean
• Defaults to: false

StreamOutputVideo

Type definitions

type RegisterCanvasOutput = {
  resolution: { width: number; height: number; }
};

Properties

resolution

Resolution of an output video

• Type: { resolution: { width: number; height: number }}