LiveCompositor

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

import LiveCompositor from "@live-compositor/node"

new LiveCompositor()

new LiveCompositor(manager?: CompositorManager)

Creates new compositor configuration. You have to call init first before this object can be used.

CompositorManager configures how the client code will connect and manage the LiveCompositor server.

• (default) LocallySpawnedInstance from @live-compositor/node downloads LiveCompositor binaries and starts the server on the local machine.
• ExistingInstance from @live-compositor/node connects to already existing compositor instance.

init()

LiveCompositor.init(): Promise<void>

Initialize the LiveCompositor instance, depending on which CompositorManager you are using it might mean spawning new instance or just establishing connection.

After this request you can start connecting inputs/outputs or register other elements. However, no output stream will be produced until start() method is called.

start()

LiveCompositor.start(): Promise<void>

Starts the processing pipeline. Any previously registered output will start producing the video/audio stream.

---

Outputs configuration

Register output

import { Outputs } from "live-compositor"

LiveCompositor.registerOutput(
  outputId: string,
  output: Outputs.RegisterOutput,
): Promise<object>

Register external destination that can be used as a compositor output. See outputs documentation to learn more:

• Rtp
• Mp4

Unregister output

LiveCompositor.unregisterOutput(outputId: string): Promise<void>

Unregister previously registered output.

---

Inputs configuration

Register input

import { Inputs } from "live-compositor"

LiveCompositor.registerInput(
  inputId: string,
  input: Inputs.RegisterInput,
): Promise<object>

Register external source that can be used as a compositor input. See inputs documentation to learn more:

• RTP
• MP4

Unregister input

LiveCompositor.unregisterInput(inputId: string): Promise<void>

Unregister a previously registered input.

---

Renderers configuration

Register image

import { Renderers } from "live-compositor"

LiveCompositor.registerImage(
  imageId: string,
  image: Renderers.RegisterImage,
): Promise<void>

Register an image asset. See Renderers.RegisterImage to learn more.

Unregister image

LiveCompositor.unregisterImage(imageId: string): Promise<void>

Unregister a previously registered image asset.

Register shader

import { Renderers } from "live-compositor"

LiveCompositor.registerShader(
  shaderId: string,
  shader: Renderers.RegisterShader,
): Promise<void>

Register a shader. See Renderers.RegisterShader to learn more.

Unregister shader

LiveCompositor.unregisterShader(shaderId: string): Promise<void>

Unregister a previously registered shader.

Register web renderer instance

import { Renderers } from "live-compositor"

LiveCompositor.registerWebRenderer(
  instanceId: string,
  instance: Renderers.RegisterWebRenderer,
): Promise<object>

Register a web renderer instance. See Renderer.RegisterWebRenderer to learn more.

Unregister web renderer instance

LiveCompositor.unregisterWebRenderer(instanceId: string): Promise<void>

Unregister a previously registered web renderer.