TypeScript SDK Reference

new LiveCompositor()

Packages like @live-compositor/node export LiveCompositor class that is a main entity used to interact with or control Live Compositor server instance.

See LiveCompositor API.

Components

React components that can be used to define how input streams should be composed.

• InputStream
• View
• Rescaler
• Tiles
• Text
• Shader
• Image
• InputStream

You can't use DOM components like <div/> when composing streams. React code can only use LiveCompositor specific components.

Hooks

React hooks that can be used in React code that controls stream composition.

• useInputStreams
• useInputAudio

You can also use regular React hooks like useState, useEffect and others.

Renderers

Functionality that can be used when composing streams, but it has to be registered first e.g. Shader needs to be registered first before you use <Shader> component.

• Shader
• Image
• WebRenderer

Inputs

To deliver video/audio to the compositor you need to register some inputs. Registered stream can be used in composition using <InputStream inputId="example_input" /> component.

• RTP
• MP4

You can register an input with LiveCompositor.registerInput

Outputs

Defines protocol, format and destination of the composed video and mixed audio streams.

• RTP
• MP4

You can register an output with LiveCompositor.registerOutput