Developer
Log in

Streaming

Destinations and protocols

Studio streams to one destination at a time per canvas. This page is how a client sees where the stream is going, which protocol carries it, and how well it's going.

Destinations

The destinations topic lists every place Go live can send to, keyed by a stable id:

Id Kind What it is
velora velora The signed-in Velora account, sent over VELoQ. Velora takes the horizontal canvas only.
platform:<id> platform A streaming platform set up in Studio, such as platform:twitch.
whip:<12 hex digits> whip A WHIP server you added by address. The id comes from a hash of the address, so the address, which can hold a credential, never crosses the API.

destination.select chooses where Go live sends, and stream.golive goes live there (or to the destination you name). Every field of a destination is in the topics reference.

Protocols

A destination's protocol and its health's protocol are a StreamProtocol:

Value Used for What it is
whip WHIP servers you add WebRTC ingest over HTTP (RFC 9725): a simulcast ladder of H.264 pictures and one Opus track, the stream mix.
veloq Velora, always CLEARLYlogic's low-latency transport technology, made for Velora.tv's player and features and built on Media over QUIC and WebTransport, carrying a two-picture ladder and an audio track per source beside the stream mix. See VELoQ.
rtmps Platforms whose ingest address is rtmps:// RTMP over TLS, one picture and one AAC mix.
rtmp Platforms whose ingest address is plain rtmp:// RTMP without TLS, one picture and one AAC mix.
srt Platforms whose ingest address is srt:// SRT, one picture and one mix.

A platform's protocol is the scheme of the ingest address Studio uses for it. Studio may add protocols later, so treat a value you don't know as unknown rather than an error.

Where the protocol shows

  • destinations.items.<id>.protocol: how Velora is sent. Only the velora destination carries it, and it's always veloq. Beside it, layers is how many qualities VELoQ sends (1 to 4; null is the default, 2).
  • destinations.items.<id>.health.protocol: how the stream is actually going out, while it's live. An offline destination's health is just {"state": "offline"}.

Qualities for Velora

Studio always sends to Velora over VELoQ; there's no protocol to choose. What a control can change is how many qualities go out: veloq.send_with with layers 1 to 4, or 0 for the default. Its protocol parameter is still accepted for older clients, but Velora stays on VELoQ whatever it says, and the result always reports "veloq". Studio keeps the choice and uses it on every Go live to Velora, whether it starts from the window or from stream.golive. A change applies the next time Studio goes live, never to a stream already running, and it needs the broadcast scope on a paired device. Studio pushes the destinations topic again when it changes.

Reading the choice
→ { "jsonrpc": "2.0", "id": 4, "method": "state.get", "params": { "topics": ["destinations"] } }

In the result, destinations.items.velora.protocol is "veloq", with layers beside it.

Changing it
→ { "jsonrpc": "2.0", "id": 5, "method": "veloq.send_with", "params": { "layers": 3 } }
← { "jsonrpc": "2.0", "id": 5, "result": { "protocol": "veloq", "layers": 3 } }

Health

Each destination has a health object, a DestinationHealth. Only the live destination shows numbers; the others are {"state": "offline"}. destination.health points a control at it.

Field WHIP (WHIP servers) VELoQ (Velora)
state offline, connecting, live, reconnecting, or refused (the server said no and Studio stopped) The same. VELoQ turns live once the main picture's first keyframe has gone out.
protocol whip veloq
kbps The connection's bandwidth estimate when there is one, else what's being sent What's being sent (VELoQ has no estimate)
send_kbps What's being sent, over the last second The same
fps Main-picture frames sent per second, over the last second The same
loss, rtt_ms Packet loss (0 to 1) and round trip, from WebRTC's reports null
frames_published, frames_dropped null The publish library's own counters for the current connection: frames it put on the network, and frames it dropped
dropped Frames Studio dropped before sending Frames Studio dropped before the publish library: while reconnecting, with a full queue, or while waiting for a keyframe
reconnects Times the connection was rebuilt The same
seconds How long it's been live The same

A field is null when the sender doesn't measure it, or before its first second of numbers. For a VELoQ stream, this is what Studio's own test of that mapping checks:

health, live over VELoQ (from Studio's test)
{ "state": "live", "protocol": "veloq", "kbps": 12480.0, "send_kbps": 12480.0, "fps": 59.8,
  "loss": null, "rtt_ms": null, "reconnects": 1, "seconds": 42,
  "frames_published": 9000, "frames_dropped": 3, "dropped": 0 }

Secrets stay out

Stream keys, platform tokens, WHIP addresses and VELoQ connect addresses never appear in a topic or a result. A VELoQ connect address carries the stream key, so Studio shows the ingest it goes to by its host name only.

to open · ↑ ↓ to move · Esc to close