Skip to content
Smelter logo Smelter logo Smelter

MediaStream (Web API)

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.

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()

RegisterStreamOutput

import { RegisterStreamOutput } from "@swmansion/smelter-web-wasm"
Type definitions 

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

Properties

video

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

audio

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

  • Type: boolean

StreamOutputVideo

Type definitions 

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

Properties

resolution

Resolution of an output video

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