Getting started

What is Smelter?

Smelter is an engine for real-time video processing built by Software Mansion. It provides functionalities to apply custom effects, mix, and combine multiple videos together. By exposing an HTTP API, Smelter enables users to define video sources, specify modifications, and composition settings.

Quick start

You can use Smelter in a few ways, however we recommend the TypeScript SDK as the best option right now.

Typescript SDK

TypeScript SDK is a library that provides a set of React components you can use to control how Smelter manipulates videos. Currently, we only support running TypeScript SDK in Node.js environment, but browser and React Native support will be added soon.

You can generate a new starter project using the following commands:

npm

npx create-smelter-app

pnpm

pnpxcreate-smelter-app

yarn

yarn create smelter-app

bun

bunx create-smelter-app

To learn more, visit TypeScript SDK documentation or explore TypeScript SDK examples.

Standalone

Some intro with multimedia server You can use Smelter as a standalone multimedia server. The server can be started by:

Membrane Framework plugin

Membrane is a multimedia processing framework written in Elixir. Why use it, Cases where it is recommended, Redirect to docs

Note

Membrane has its own way of handling multimedia, so there are some notable differences in comparison to the standalone Smelter. Visit Membrane plugin section for more details.