@swmansion/smelter
TypeScript icon, indicating that this package has built-in type declarations

0.2.1 • Public • Published

@swmansion/smelter

This package provides a set of React components that can be used to define a composition of a video stream. Available components can only be used with React renderers specific for Smelter. Currently, we only support Node.js runtime with @swmansion/smelter-node package, but support for more runtimes is planned in the future.

Smelter components should not be mixed with other React or React Native components, but you can still use hooks like useState/useEffect from React.

Getting started

To try smelter, generate a new project by running:

npm create smelter-app

Usage

import { View, Text, InputStream, Rescaler } from '@swmansion/smelter';

function ExampleApp() {
  return (
    <View style={{ direction: 'column' }}>
      <Rescaler style={{ rescaleMode: 'fill' }}>
        <InputStream inputId="example_input_1" />
      </Rescaler>
      <Text style={{ fontSize: 20 }}>Example label</Text>
    </View>
  );
}

Check out @swmansion/smelter-node to learn how to use those components for video composition.

See our docs to learn more.

License

@swmansion/smelter package is MIT licensed, but it is only useful when used with Smelter server that is licensed under a custom license.

Smelter is created by Software Mansion

swm

Since 2012 Software Mansion is a software agency with experience in building web and mobile apps as well as complex multimedia solutions. We are Core React Native Contributors and experts in live streaming and broadcasting technologies. We can help you build your next dream product – Hire us.

Readme

Keywords

none

Package Sidebar

Install

npm i @swmansion/smelter

Homepage

smelter.dev

Weekly Downloads

54

Version

0.2.1

License

MIT

Unpacked Size

255 kB

Total Files

140

Last publish

Collaborators

  • kmag
  • kacperkapusciak
  • patrycjakalinska
  • wolewicki
  • tjzel
  • tomekzaw
  • jakub.piasecki
  • wkozyra