Reference
Shapes
Shapes that appear in more than one place, named by their schema's title. The SDKs use the same names for their types.
ChatAmount
Support with a number, kept as a value and its unit, never as text read as money.
displaystringalwaysAs the platform shows it, such as "1,000 bits" or "$4.99".
monthsintegeralwayscan be nulltierstringalwayscan be nullunitstringalwaysvolts, bits, kicks, points, subs (a gift's count), viewers (a raid's), or a currency code such as USD for real money.
valuenumberalways
ChatAuthor
avatarstringalwayscan be nullA link to their picture.
colorstringalwayscan be nullTheir name's color, "#RRGGBB".
displaystringalwaysTheir display name.
idstringalwaysTheir id on the platform.
loginstringalwaysTheir login name.
pronounsstringalwayscan be null
ChatBadge
idstringalwaysimagestringalwayscan be nulllabelstringalwaysShown on hover.
rotatesbooleanoptionalOne of the badges that take turns in one place (Velora's badge strip); absent = false.
ChatFlags
editedbooleanalwaysfirst_messagebooleanalwayshighlightedbooleanalwaysownbooleanalwaysSent from this Studio.
replaybooleanalwaysAn alert shown again on stream.
ChatModes
emote_onlybooleanalwaysfollowers_onlybooleanalwaysslow_secondsintegeralwayscan be nullSlow mode's wait between messages; null while slow mode is off.
subscribers_onlybooleanalways
ChatPart
A piece of a message, told apart by t: text, an emote, a mention, a link, or styled words (Velora chat's **bold** and *italic*).
When
t: "text"t="text"alwaystextstringalways
When
t: "emote"animatedbooleanalwayscodestringalwaysWhat was typed.
scalesarray of stringoptionalIts 1x, 2x and 4x pictures, when the service has them.
sourcestringoptionalWhere it's from, such as "7TV · channel".
t="emote"alwaysurlstringalwaysThe emote's picture (2x).
zero_widthbooleanoptionalDrawn on top of the emote before it.
When
t: "mention"loginstringalwayst="mention"always
When
t: "link"t="link"alwaysurlstringalways
When
t: "styled"boldbooleanoptionalitalicbooleanoptionalt="styled"alwaystextstringalways
ChatReplyTo
authorstringalwaysexcerptstringalwaysnative_idstringalways
ChatRoles
botbooleanalwaysbroadcasterbooleanalwaysmoderatorbooleanalwaysstaffbooleanalwayssubscriberbooleanalwaysvipbooleanalways
ChatRow
One row of chat or one activity, as Studio's chat panel shows it.
accentstringalwayscan be nullAn accent color the platform gives it, "#RRGGBB".
Support with a number, kept as a value and its unit, never as text read as money.
artstringalwayscan be nullThe platform's own picture for it (a reward's art).
channelstringalwaysThe channel's id on its platform.
eidintegeralwaysStudio's number for this row, for chat.deleted and chat.edited.
metaanyalwaysAnything else the platform sent that Studio doesn't describe yet. Any JSON; don't rely on its shape.
native_idstringalwayscan be nullThe platform's id for this message.
live, or deleted (with who deleted it, when known).
textstringalwaysThe plain text.
titlestringalwayscan be nullA card's headline: a reward's title, "Poll ended"…
tsintegeralwaysWhen, in Unix milliseconds.
ChatRowState
live, or deleted (with who deleted it, when known).
When
t: "live"t="live"always
When
t: "deleted"bystringalwayscan be nullt="deleted"always
DestinationHealth
delay_secsintegeroptionalcan be nullThe stream delay in seconds (0: none): viewers see everything this much later.
delay_starts_inintegeroptionalcan be nullSeconds until viewers see the first of a delayed stream; 0 once they do.
droppednumberoptionalcan be nullFrames Studio dropped before sending.
errorstringoptionalcan be nullWhy it stopped going out (state error: refused, failed, or stopped with an error).
fpsnumberoptionalcan be nullFrames per second being sent, while live.
frames_droppednumberoptionalcan be nullFrames the sending library lost (VELoQ): ones the ingest subscribed to and never got. Frames for tracks not subscribed yet, or before a video track's first keyframe, are not counted.
frames_publishednumberoptionalcan be nullFrames handed to the network so far (VELoQ).
kbpsnumberoptionalcan be nullThe bitrate in kbit/s, while live.
lossnumberoptionalcan be nullPacket loss, 0 to 1, while live.
networkstringoptionalcan be nullThe network card its connection goes out on (Settings › Advanced › Network cards), "(backup)" after its name on the backup; null on the system's default network.
network_notestringoptionalcan be nullWhy it isn't on the card chosen, when it isn't: the card is gone, unplugged or has no address, or the protocol (SRT) can't be sent on a chosen card.
notestringoptionalcan be nullWhat's happening now, in words (a reconnect in progress).
How it's being sent: whip, veloq, rtmps, rtmp or srt.
reconnect_attemptintegeroptionalcan be nullThe reconnect attempt under way while reconnecting (0: none).
reconnectsintegeroptionalrtt_msnumberoptionalcan be nullRound trip in milliseconds, while live.
secondsintegeroptionalHow long it's been live.
send_kbpsnumberoptionalcan be nullWhat the sender is pushing now in kbit/s, while live.
stopping_inintegeroptionalcan be nullStopping: seconds until the delay has played out and the stream ends.
LiveStats
bytesintegeralwayscan be nullkbpsnumberalwayscan be nulllossnumberalwayscan be nullreconnectsintegeralwaysrtt_msnumberalwayscan be null
OutputStats
droppedintegeralwaysFrames the stream's and the recording's encoders refused because they were behind.
laggedintegeralwayscan be nullTicks the clock missed while an output ran; each was filled by repeating the previous picture or left out.
renderedintegeralwayscan be nullProgram frames handed to the outputs (recording, stream, replay buffer, virtual camera): one per tick while any runs, at the canvas's frame rate when all is well.
PreviewStats
idleintegeralwayscan be nullTicks with nothing new for the preview to draw.
renderedintegeralwayscan be nullFrames drawn for the preview. None while the preview is hidden or nothing on it changes, whatever goes out: not a measure of the stream.
RaidAlsoLive
confidencenumberalways0 to 1 (1 for a link).
linked: an explicit link (a connected account its owner shared). likely: no link, but a near-identical name, the same game and a strongly matching title. possible: something matches, not all of it; confirm it's them.
platformstringalwaysWhere they're also live.
platform_namestringalwaysThe platform's name as shown.
precheckedbooleanalwaysStudio offers it checked: linked or likely only, never a weaker match.
reasonsarray of stringalwaysWhy, each in a few words: "Same name", "Same game", "The titles match", "But a different game".
summarystringalwaysThe reasons as one sentence: "Same name and same game, and the titles match".
Their channel there (raid.start's targets take it as is).
RaidAlsoLiveTarget
Their channel there (raid.start's targets take it as is).
avatarstringalwaysAn avatar picture (https), or empty.
categorystringalwaysWhat they're streaming, or empty.
display_namestringalwaysThe name as shown.
idstringalwaysThe platform's id for the channel.
Their other channels, by explicit link only: a Velora channel's connected Twitch/Kick account its owner shared for raid matching. Never a name guess.
loginstringalwaysThe name the platform raids by (raid.start's target).
titlestringalwaysThe stream's title.
viewersintegeralwaysWatching now.
RaidLegStatus
alreadybooleanoptionalSent because the platform says this raid already went out (a raid to the same channel moments before, from the website or another app); note says so.
ends_at_msintegeroptionalcan be nullWhen its countdown ends (epoch ms), while counting down.
messagestringoptionalThe raid card's message as you see it (Velora; subscriber message first).
message_everyonestringoptionalThe card's message for viewers who aren't subscribed, when it differs.
notestringoptionalcan be nullWhy it was cancelled or failed, or something to know.
counting_down, sent, cancelled or failed.
platformstringalwaysWhere it's raiding.
platform_namestringalwaysThe platform's name as shown.
seconds_leftintegeroptionalcan be nullSeconds until it goes out, while counting down.
send_nowbooleanalways"Raid now" can send it early.
targetRaidTargetalwaysWho it's raiding there.
Fields of
targetWith raid.targets' also_live: this person live on your other connected platforms, at most one per platform (left out otherwise).
avatarstringalwaysAn avatar picture (https), or empty.
categorystringalwaysWhat they're streaming, or empty.
display_namestringalwaysThe name as shown.
idstringalwaysThe platform's id for the channel.
Their other channels, by explicit link only: a Velora channel's connected Twitch/Kick account its owner shared for raid matching. Never a name guess.
loginstringalwaysThe name the platform raids by (raid.start's target).
titlestringalwaysThe stream's title.
viewersintegeralwaysWatching now.
via_chatbooleanalwaysStarted with Velora's /raid chat command (an older Velora).
viewersintegeroptionalcan be nullHow many went along, once sent.
RaidLinkedChannel
display_namestringalwaysIts name as shown.
idstringalwaysThat platform's id for the channel (matched on this, not the name).
loginstringalwaysIts name there.
platformstringalwaysWhere it is: twitch or kick.
RaidStatus
activebooleanalwaysA raid is in progress (or just finished and not yet dismissed).
alreadybooleanoptionalSent because the platform says the raid already went out (the first platform's); note says so.
ends_at_msintegeroptionalcan be nullWhen the countdown ends (epoch ms), while counting down.
generationintegeralwaysChanges whenever the raid does.
messagestringoptionalThe raid card's message as you see it (Velora; subscriber message first).
message_everyonestringoptionalThe card's message for viewers who aren't subscribed, when it differs.
notestringoptionalcan be nullWhy it was cancelled or failed, or something to know (the first platform's).
The whole raid: counting_down while any platform is; then sent (every platform's went out), partial (some did), cancelled or failed.
platformstringoptionalWhere it's raiding.
platform_namestringoptionalThe platform's name as shown.
Each platform's raid, one per platform, sharing one countdown. The top-level platform, target and note are the first one's.
seconds_leftintegeroptionalcan be nullSeconds until it goes out (the last platform's), while counting down.
send_nowbooleanoptional"Raid now" can send it early (on at least one platform).
targetRaidTargetoptionalWho it's raiding.
Fields of
targetWith raid.targets' also_live: this person live on your other connected platforms, at most one per platform (left out otherwise).
avatarstringalwaysAn avatar picture (https), or empty.
categorystringalwaysWhat they're streaming, or empty.
display_namestringalwaysThe name as shown.
idstringalwaysThe platform's id for the channel.
Their other channels, by explicit link only: a Velora channel's connected Twitch/Kick account its owner shared for raid matching. Never a name guess.
loginstringalwaysThe name the platform raids by (raid.start's target).
titlestringalwaysThe stream's title.
viewersintegeralwaysWatching now.
via_chatbooleanoptionalStarted with Velora's /raid chat command (an older Velora).
viewersintegeroptionalcan be nullHow many went along, once sent (all platforms together).
RecordStats
droppedintegeralwayscan be nullframesintegeralwayscan be null
RenderStats
Deprecated: use preview and output. The preview's paints (rendered, idle) and every tick the clock missed (lagged); kept for older clients for one release.
idleintegeroptionallaggedintegeroptionalTicks the clock missed, whether or not anything was going out.
renderedintegeroptionalFrames drawn for the preview (see preview.rendered).
StatsState
fpsnumberalwayscan be nullThe canvas's frame rate.
Deprecated: use preview and output. The preview's paints (rendered, idle) and every tick the clock missed (lagged); kept for older clients for one release.
StreamCategory
artstringoptionalA link to its box art, when known.
gamebooleanoptionalKnown to be a game.
namestringalwaysslugstringoptionalIts Velora slug, when it has one.
UpdateState
availablebooleanalwaysOn while an update is on offer (available, downloading or ready).
channelstringalwayscan be nullThe update channel: stable, beta or internal.
current_versionstringalwayscan be nullThe running Studio's version.
datestringalwayscan be nullIts release date.
downloaded_bytesintegeralwayserrorstringalwayscan be nullWhy the last check or download failed.
install_pendingbooleanalwaysUpdate now was pressed while live, recording or keeping a replay buffer: it starts once that ends.
last_checked_msintegeralwayscan be nullWhen the channel was last asked (Unix ms).
lateststringalwayscan be nullThe newest version on the channel, once checked.
notesstringalwayscan be nullIts release notes (Markdown).
progressnumberalwayscan be null0 to 1 while downloading; 1 once ready.
sizeintegeralwayscan be nullIts download's size in bytes (null when the package manager updates Studio).
idle (nothing on offer, or not checked yet), checking, available, downloading, ready (downloaded and verified: Studio restarts into it when asked) or error.
updates_itselfbooleanalwaysThis copy is updated by its package manager (Flatpak); Studio only says there's an update.
versionstringalwayscan be nullThe version on offer.
waiting_forstringalwayscan be nullWhat a pending install waits for (live, recording, replay buffer).
ViewerMixerRow
in_vodbooleanalwaysVelora's VOD keeps it.
labelstringalwaysWhat viewers read.
mutedbooleanalwaysIt starts muted.
sourcesarray of string (uuid)alwaysThe sources it carries.
trackstringalwaysThe track's name on the wire.
volumenumberalwaysWhere the viewer's slider starts (0 to 1).
Value sets
Named sets of words a field takes, such as StreamProtocol. Every value is listed; a field marked can be null may also be null. The SDKs generate an enum for each.
AudioGroupKind
"folder""send"
AudioMix
"full""vod_safe"
Bandwidth
"highest""lowest""audio_only"
Blur
"soft""box""motion""zoom""spin""pixelate"
CaptureChooser
"list""system"
CaptureGroup
"displays""front""games""windows""choose"
CaptureKind
"display""window""game"
Channels
"1-2""3-4""5-6""7-8""9-10""11-12"
ChatPlatform
"velora""twitch""kick""youtube""owncast""rumble"
ChatRowKind
"message""action""system""bot""announcement""follow""sub""resub""gift_sub""support""redemption""raid""card"
DestinationKind
"velora""platform""whip"
Direction
"all""line""spin""zoom"
DrawApplies
"now""when_off_air""at_start"
DynamicVariable
"category""title"
EncodeApplies
"next_encode"
LayerKind
"source""scene"
Look
"bw""sepia""duotone""tint""invert""thermal""posterize""pixelate""fisheye""vhs""hologram""ghost""glitch""vignette""anaglyph""sketch""shine""wave""shake""flicker""pulse""rainbow""reveal"
MediaAction
"play""pause""toggle""restart""stop""next""previous"
MediaPlayState
"idle""opening""playing""paused""stopped""ended"
ModerationAction
"ban""unban""timeout"
MonitorMode
"off""monitor_only""monitor_and_output"
MonitorWhen
"setting""always""on_air"
NdiSend
"off""video_audio""video""audio"
NetworkApplies
"next_connection"
Placement
"outer""inner"
Position
"outer""inner""both"
Quality
"standard""high"
RaidGroupPhase
"counting_down""sent""partial""cancelled""failed"
RaidMatch
"linked""likely""possible"
RaidPhase
"counting_down""sent""cancelled""failed"
ReplayRides
"recording""stream""own"
Shader
"rounded_rect""pulse""border""blink""rgb_split""scan_lines""gradient""zoom""swirl""simple_gradient""file"
SourceSettingKind
"toggle""trigger""number""integer""choice""color""text""colors""sources""path"
SourceSettingsFrom
"studio""plugin"
Spread
"average""by_position"
StreamProtocol
"whip""veloq""rtmps""rtmp""srt"
StreamStatus
"offline""delayed""connecting""live""reconnecting""stopping""refused""error"
ThemeAppearance
"dark""light"
UpdateStatus
"idle""checking""available""downloading""ready""error"
VcamSource
"on_air""scene"
VeloqTrackKind
"program""source""send""hidden""other""stem"
VeloqVisibility
"public""public_drop_vod""hidden_keep_vod""hidden_drop_vod""not_sent"
VeloraProtocol
"whip""veloq"
WebPageState
"idle""loading""ok""failed"

