Developer
Log in

Velum Studio developer documentation

Build with Velum Studio

Velum Studio is a broadcast app for streamers. Everything it can do from a button, your code can do too: switch scenes, mix audio, go live, read chat as it arrives. Its look is a small set of tokens anyone can theme, and the extensions that will live inside it follow the same design rules as the app.

What you can build

A first look

Studio writes a small discovery file when it starts, so a client on the same computer never asks for a port or a token. Here is the whole round trip in each SDK: connect, follow the scene on air, and put a scene on air.

C#
using Velum.Studio;

await using var studio = await VelumStudioClient.ConnectAsync(new VelumClientOptions { ClientName = "My App" });

studio.SceneChanged += (_, e) => Console.WriteLine($"On air: {e.Name}");
await studio.SubscribeAsync(TopicType.Scenes);

var result = await studio.SceneSwitchAsync(new SceneSwitchParams { Scene = "Just Chatting" });
Console.WriteLine($"Switched to {result.Name}");
TypeScript
import { connectLocal } from "velum-studio-client/node";

const studio = await connectLocal({ clientName: "My App" });

studio.on("scene.changed", (e) => console.log(`On air: ${e.name}`));
await studio.subscribe("scenes");

const result = await studio.sceneSwitch({ scene: "Just Chatting" });
console.log(`Switched to ${result.name}`);
Python
import asyncio
from velum_studio import EventType, TopicType, VelumStudioClient

async def main() -> None:
    async with await VelumStudioClient.connect(client_name="My App") as studio:
        studio.on(EventType.SCENE_CHANGED, lambda e: print(f"On air: {e.name}"))
        await studio.subscribe(TopicType.SCENES)

        result = await studio.scene_switch(scene="Just Chatting")
        print(f"Switched to {result.name}")

asyncio.run(main())

Prefer the wire? It's JSON-RPC 2.0, so any WebSocket client works. Connecting shows the handshake, and every method is in the reference.

How it fits together

  • Integrations control Studio from outside: your scripts, control surfaces, chat bots, an app on a phone or tablet. They use the control API and the SDKs, and they're their own apps, with their own look.
  • Extensions live inside Studio: dock panels, sources, effects, transitions. They follow the design guidelines and take their look from the theme tokens, so a theme restyles them along with everything else.
  • Themes are data, never code. One file sets the tokens that Studio, and every extension, draws with.

Studio's catalog is the source of truth for all of it. The reference pages on this site are generated from it at build time, and the build fails if they fall out of step.

to open · ↑ ↓ to move · Esc to close