Developer
Log in

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.

Used by chat.message, activity.follow, activity.sub, activity.resub, activity.gift_sub, activity.support, activity.redemption, activity.raid, activity.card, activity.updated, activity.

  • displaystringalways

    As the platform shows it, such as "1,000 bits" or "$4.99".

  • monthsintegeralwayscan be null
  • tierstringalwayscan be null
  • unitstringalways

    volts, bits, kicks, points, subs (a gift's count), viewers (a raid's), or a currency code such as USD for real money.

  • valuenumberalways

ChatAuthor

Used by chat.message, activity.follow, activity.sub, activity.resub, activity.gift_sub, activity.support, activity.redemption, activity.raid, activity.card, activity.updated, activity.

  • avatarstringalwayscan be null

    A link to their picture.

  • badgesarray of ChatBadgealways
  • colorstringalwayscan be null

    Their name's color, "#RRGGBB".

  • displaystringalways

    Their display name.

  • idstringalways

    Their id on the platform.

  • loginstringalways

    Their login name.

  • pronounsstringalwayscan be null
  • rolesChatRolesalways

ChatBadge

Used by chat.message, activity.follow, activity.sub, activity.resub, activity.gift_sub, activity.support, activity.redemption, activity.raid, activity.card, activity.updated, activity.

  • idstringalways
  • imagestringalwayscan be null
  • labelstringalways

    Shown on hover.

  • rotatesbooleanoptional

    One of the badges that take turns in one place (Velora's badge strip); absent = false.

ChatFlags

Used by chat.message, activity.follow, activity.sub, activity.resub, activity.gift_sub, activity.support, activity.redemption, activity.raid, activity.card, activity.updated, activity.

  • editedbooleanalways
  • first_messagebooleanalways
  • highlightedbooleanalways
  • ownbooleanalways

    Sent from this Studio.

  • replaybooleanalways

    An alert shown again on stream.

ChatModes

Used by chat.mode, chat.

  • emote_onlybooleanalways
  • followers_onlybooleanalways
  • slow_secondsintegeralwayscan be null

    Slow 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*).

Used by chat.message, chat.edited, activity.follow, activity.sub, activity.resub, activity.gift_sub, activity.support, activity.redemption, activity.raid, activity.card, activity.updated, activity.

  • When t: "text"

    • t = "text"always
    • textstringalways
  • When t: "emote"

    • animatedbooleanalways
    • codestringalways

      What was typed.

    • scalesarray of stringoptional

      Its 1x, 2x and 4x pictures, when the service has them.

    • sourcestringoptional

      Where it's from, such as "7TV · channel".

    • t = "emote"always
    • urlstringalways

      The emote's picture (2x).

    • zero_widthbooleanoptional

      Drawn on top of the emote before it.

  • When t: "mention"

    • loginstringalways
    • t = "mention"always
  • When t: "link"

    • t = "link"always
    • urlstringalways
  • When t: "styled"

    • boldbooleanoptional
    • italicbooleanoptional
    • t = "styled"always
    • textstringalways

ChatReplyTo

Used by chat.message, activity.follow, activity.sub, activity.resub, activity.gift_sub, activity.support, activity.redemption, activity.raid, activity.card, activity.updated, activity.

  • authorstringalways
  • excerptstringalways
  • native_idstringalways

ChatRoles

Used by chat.message, activity.follow, activity.sub, activity.resub, activity.gift_sub, activity.support, activity.redemption, activity.raid, activity.card, activity.updated, activity.

  • botbooleanalways
  • broadcasterbooleanalways
  • moderatorbooleanalways
  • staffbooleanalways
  • subscriberbooleanalways
  • vipbooleanalways

ChatRow

One row of chat or one activity, as Studio's chat panel shows it.

Used by chat.message, activity.follow, activity.sub, activity.resub, activity.gift_sub, activity.support, activity.redemption, activity.raid, activity.card, activity.updated, activity.

  • accentstringalwayscan be null

    An accent color the platform gives it, "#RRGGBB".

  • amountChatAmountalwayscan be null

    Support with a number, kept as a value and its unit, never as text read as money.

  • artstringalwayscan be null

    The platform's own picture for it (a reward's art).

  • authorChatAuthoralwayscan be null
  • channelstringalways

    The channel's id on its platform.

  • eidintegeralways

    Studio's number for this row, for chat.deleted and chat.edited.

  • flagsChatFlagsalways
  • kindChatRowKind (string)always

    One of "message" "action" "system" "bot" "announcement" "follow" "sub" "resub" "gift_sub" "support" "redemption" "raid" "card"

  • metaanyalways

    Anything else the platform sent that Studio doesn't describe yet. Any JSON; don't rely on its shape.

  • native_idstringalwayscan be null

    The platform's id for this message.

  • partsarray of ChatPartalways
  • platformChatPlatform (string)always

    One of "velora" "twitch" "kick" "youtube" "owncast" "rumble"

  • reply_toChatReplyToalwayscan be null
  • stateChatRowStatealways

    live, or deleted (with who deleted it, when known).

  • textstringalways

    The plain text.

  • titlestringalwayscan be null

    A card's headline: a reward's title, "Poll ended"…

  • tsintegeralways

    When, in Unix milliseconds.

ChatRowState

live, or deleted (with who deleted it, when known).

Used by chat.message, activity.follow, activity.sub, activity.resub, activity.gift_sub, activity.support, activity.redemption, activity.raid, activity.card, activity.updated, activity.

  • When t: "live"

    • t = "live"always
  • When t: "deleted"

    • bystringalwayscan be null
    • t = "deleted"always

DestinationHealth

Used by destination.health, destinations.

  • delay_secsintegeroptionalcan be null

    The stream delay in seconds (0: none): viewers see everything this much later.

  • delay_starts_inintegeroptionalcan be null

    Seconds until viewers see the first of a delayed stream; 0 once they do.

  • droppednumberoptionalcan be null

    Frames Studio dropped before sending.

  • errorstringoptionalcan be null

    Why it stopped going out (state error: refused, failed, or stopped with an error).

  • fpsnumberoptionalcan be null

    Frames per second being sent, while live.

  • frames_droppednumberoptionalcan be null

    Frames 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 null

    Frames handed to the network so far (VELoQ).

  • kbpsnumberoptionalcan be null

    The bitrate in kbit/s, while live.

  • lossnumberoptionalcan be null

    Packet loss, 0 to 1, while live.

  • networkstringoptionalcan be null

    The 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 null

    Why 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 null

    What's happening now, in words (a reconnect in progress).

  • protocolStreamProtocol (string)optionalcan be null

    How it's being sent: whip, veloq, rtmps, rtmp or srt.

    One of "whip" "veloq" "rtmps" "rtmp" "srt" null

  • reconnect_attemptintegeroptionalcan be null

    The reconnect attempt under way while reconnecting (0: none).

  • reconnectsintegeroptional
  • rtt_msnumberoptionalcan be null

    Round trip in milliseconds, while live.

  • secondsintegeroptional

    How long it's been live.

  • send_kbpsnumberoptionalcan be null

    What the sender is pushing now in kbit/s, while live.

  • stateStreamStatus (string)always

    One of "offline" "delayed" "connecting" "live" "reconnecting" "stopping" "refused" "error"

  • stopping_inintegeroptionalcan be null

    Stopping: seconds until the delay has played out and the stream ends.

LiveStats

Used by stats.show, stats.

  • bytesintegeralwayscan be null
  • kbpsnumberalwayscan be null
  • lossnumberalwayscan be null
  • reconnectsintegeralways
  • rtt_msnumberalwayscan be null

OutputStats

Used by stats.show, stats.

  • droppedintegeralways

    Frames the stream's and the recording's encoders refused because they were behind.

  • laggedintegeralwayscan be null

    Ticks the clock missed while an output ran; each was filled by repeating the previous picture or left out.

  • renderedintegeralwayscan be null

    Program 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

Used by stats.show, stats.

  • idleintegeralwayscan be null

    Ticks with nothing new for the preview to draw.

  • renderedintegeralwayscan be null

    Frames 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

Used by raid.targets, raid.start, raid.cancel.

  • confidencenumberalways

    0 to 1 (1 for a link).

  • matchRaidMatch (string)always

    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.

    One of "linked" "likely" "possible"

  • platformstringalways

    Where they're also live.

  • platform_namestringalways

    The platform's name as shown.

  • precheckedbooleanalways

    Studio offers it checked: linked or likely only, never a weaker match.

  • reasonsarray of stringalways

    Why, each in a few words: "Same name", "Same game", "The titles match", "But a different game".

  • summarystringalways

    The reasons as one sentence: "Same name and same game, and the titles match".

  • targetRaidAlsoLiveTargetalways

    Their channel there (raid.start's targets take it as is).

RaidAlsoLiveTarget

Their channel there (raid.start's targets take it as is).

Used by raid.targets, raid.start, raid.cancel.

  • avatarstringalways

    An avatar picture (https), or empty.

  • categorystringalways

    What they're streaming, or empty.

  • display_namestringalways

    The name as shown.

  • idstringalways

    The platform's id for the channel.

  • linkedarray of RaidLinkedChannelalways

    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.

  • loginstringalways

    The name the platform raids by (raid.start's target).

  • titlestringalways

    The stream's title.

  • viewersintegeralways

    Watching now.

RaidLegStatus

Used by raid.start, raid.cancel.

  • alreadybooleanoptional

    Sent 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 null

    When its countdown ends (epoch ms), while counting down.

  • messagestringoptional

    The raid card's message as you see it (Velora; subscriber message first).

  • message_everyonestringoptional

    The card's message for viewers who aren't subscribed, when it differs.

  • notestringoptionalcan be null

    Why it was cancelled or failed, or something to know.

  • phaseRaidPhase (string)always

    counting_down, sent, cancelled or failed.

    One of "counting_down" "sent" "cancelled" "failed"

  • platformstringalways

    Where it's raiding.

  • platform_namestringalways

    The platform's name as shown.

  • seconds_leftintegeroptionalcan be null

    Seconds until it goes out, while counting down.

  • send_nowbooleanalways

    "Raid now" can send it early.

  • targetRaidTargetalways

    Who it's raiding there.

    Fields of target
    • also_livearray of RaidAlsoLiveoptional

      With raid.targets' also_live: this person live on your other connected platforms, at most one per platform (left out otherwise).

    • avatarstringalways

      An avatar picture (https), or empty.

    • categorystringalways

      What they're streaming, or empty.

    • display_namestringalways

      The name as shown.

    • idstringalways

      The platform's id for the channel.

    • linkedarray of RaidLinkedChannelalways

      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.

    • loginstringalways

      The name the platform raids by (raid.start's target).

    • titlestringalways

      The stream's title.

    • viewersintegeralways

      Watching now.

  • via_chatbooleanalways

    Started with Velora's /raid chat command (an older Velora).

  • viewersintegeroptionalcan be null

    How many went along, once sent.

RaidLinkedChannel

Used by raid.targets, raid.start, raid.cancel.

  • display_namestringalways

    Its name as shown.

  • idstringalways

    That platform's id for the channel (matched on this, not the name).

  • loginstringalways

    Its name there.

  • platformstringalways

    Where it is: twitch or kick.

RaidStatus

Used by raid.start, raid.cancel.

  • activebooleanalways

    A raid is in progress (or just finished and not yet dismissed).

  • alreadybooleanoptional

    Sent because the platform says the raid already went out (the first platform's); note says so.

  • ends_at_msintegeroptionalcan be null

    When the countdown ends (epoch ms), while counting down.

  • generationintegeralways

    Changes whenever the raid does.

  • messagestringoptional

    The raid card's message as you see it (Velora; subscriber message first).

  • message_everyonestringoptional

    The card's message for viewers who aren't subscribed, when it differs.

  • notestringoptionalcan be null

    Why it was cancelled or failed, or something to know (the first platform's).

  • phaseRaidGroupPhase (string)optional

    The whole raid: counting_down while any platform is; then sent (every platform's went out), partial (some did), cancelled or failed.

    One of "counting_down" "sent" "partial" "cancelled" "failed"

  • platformstringoptional

    Where it's raiding.

  • platform_namestringoptional

    The platform's name as shown.

  • raidsarray of RaidLegStatusalways

    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 null

    Seconds until it goes out (the last platform's), while counting down.

  • send_nowbooleanoptional

    "Raid now" can send it early (on at least one platform).

  • targetRaidTargetoptional

    Who it's raiding.

    Fields of target
    • also_livearray of RaidAlsoLiveoptional

      With raid.targets' also_live: this person live on your other connected platforms, at most one per platform (left out otherwise).

    • avatarstringalways

      An avatar picture (https), or empty.

    • categorystringalways

      What they're streaming, or empty.

    • display_namestringalways

      The name as shown.

    • idstringalways

      The platform's id for the channel.

    • linkedarray of RaidLinkedChannelalways

      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.

    • loginstringalways

      The name the platform raids by (raid.start's target).

    • titlestringalways

      The stream's title.

    • viewersintegeralways

      Watching now.

  • via_chatbooleanoptional

    Started with Velora's /raid chat command (an older Velora).

  • viewersintegeroptionalcan be null

    How many went along, once sent (all platforms together).

RecordStats

Used by stats.show, stats.

  • droppedintegeralwayscan be null
  • framesintegeralwayscan 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.

Used by stats.show, stats.

  • idleintegeroptional
  • laggedintegeroptional

    Ticks the clock missed, whether or not anything was going out.

  • renderedintegeroptional

    Frames drawn for the preview (see preview.rendered).

StatsState

Used by stats.show, stats.

  • fpsnumberalwayscan be null

    The canvas's frame rate.

  • liveLiveStatsalwayscan be null
  • outputOutputStatsalways
  • previewPreviewStatsalways
  • recordRecordStatsalwayscan be null
  • renderRenderStatsalwayscan be null

    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

Used by streaminfo.apply, stream_info.

  • artstringoptional

    A link to its box art, when known.

  • gamebooleanoptional

    Known to be a game.

  • namestringalways
  • slugstringoptional

    Its Velora slug, when it has one.

UpdateState

Used by update.check, update.install, update.

  • availablebooleanalways

    On while an update is on offer (available, downloading or ready).

  • channelstringalwayscan be null

    The update channel: stable, beta or internal.

  • current_versionstringalwayscan be null

    The running Studio's version.

  • datestringalwayscan be null

    Its release date.

  • downloaded_bytesintegeralways
  • errorstringalwayscan be null

    Why the last check or download failed.

  • install_pendingbooleanalways

    Update now was pressed while live, recording or keeping a replay buffer: it starts once that ends.

  • last_checked_msintegeralwayscan be null

    When the channel was last asked (Unix ms).

  • lateststringalwayscan be null

    The newest version on the channel, once checked.

  • notesstringalwayscan be null

    Its release notes (Markdown).

  • progressnumberalwayscan be null

    0 to 1 while downloading; 1 once ready.

  • sizeintegeralwayscan be null

    Its download's size in bytes (null when the package manager updates Studio).

  • stateUpdateStatus (string)always

    idle (nothing on offer, or not checked yet), checking, available, downloading, ready (downloaded and verified: Studio restarts into it when asked) or error.

    One of "idle" "checking" "available" "downloading" "ready" "error"

  • updates_itselfbooleanalways

    This copy is updated by its package manager (Flatpak); Studio only says there's an update.

  • versionstringalwayscan be null

    The version on offer.

  • waiting_forstringalwayscan be null

    What a pending install waits for (live, recording, replay buffer).

ViewerMixerRow

Used by veloq.

  • in_vodbooleanalways

    Velora's VOD keeps it.

  • kindVeloqTrackKind (string)always

    One of "program" "source" "send" "hidden" "other" "stem"

  • labelstringalways

    What viewers read.

  • mutedbooleanalways

    It starts muted.

  • sourcesarray of string (uuid)always

    The sources it carries.

  • trackstringalways

    The track's name on the wire.

  • volumenumberalways

    Where 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"

Used by audio_groups.

AudioMix

  • "full"
  • "vod_safe"

Used by destination.audio, destinations.

Bandwidth

  • "highest"
  • "lowest"
  • "audio_only"

Blur

  • "soft"
  • "box"
  • "motion"
  • "zoom"
  • "spin"
  • "pixelate"

Used by velum.filter.blur.

CaptureChooser

  • "list"
  • "system"

Used by capture.targets.

CaptureGroup

  • "displays"
  • "front"
  • "games"
  • "windows"
  • "choose"

Used by capture.targets.

CaptureKind

  • "display"
  • "window"
  • "game"

Used by capture.targets.

Channels

  • "1-2"
  • "3-4"
  • "5-6"
  • "7-8"
  • "9-10"
  • "11-12"

ChatPlatform

  • "velora"
  • "twitch"
  • "kick"
  • "youtube"
  • "owncast"
  • "rumble"

Used by chat.message, chat.cleared, activity.follow, activity.sub, activity.resub, activity.gift_sub, activity.support, activity.redemption, activity.raid, activity.card, activity.updated, activity, ChatRow.

ChatRowKind

  • "message"
  • "action"
  • "system"
  • "bot"
  • "announcement"
  • "follow"
  • "sub"
  • "resub"
  • "gift_sub"
  • "support"
  • "redemption"
  • "raid"
  • "card"

Used by chat.message, activity.follow, activity.sub, activity.resub, activity.gift_sub, activity.support, activity.redemption, activity.raid, activity.card, activity.updated, activity, ChatRow.

DestinationKind

  • "velora"
  • "platform"
  • "whip"

Used by destinations.

Direction

  • "all"
  • "line"
  • "spin"
  • "zoom"

Used by velum.filter.blur, velum.filter.shadow.

DrawApplies

  • "now"
  • "when_off_air"
  • "at_start"

Used by gpu.draw_on.

DynamicVariable

  • "category"
  • "title"

Used by dynamic.set_variable.

EncodeApplies

  • "next_encode"

Used by gpu.encode_on.

LayerKind

  • "source"
  • "scene"

Used by layers.

Look

  • "bw"
  • "sepia"
  • "duotone"
  • "tint"
  • "invert"
  • "thermal"
  • "posterize"
  • "pixelate"
  • "fisheye"
  • "vhs"
  • "hologram"
  • "ghost"
  • "glitch"
  • "vignette"
  • "anaglyph"
  • "sketch"
  • "shine"
  • "wave"
  • "shake"
  • "flicker"
  • "pulse"
  • "rainbow"
  • "reveal"

Used by velum.filter.effect.

MediaAction

  • "play"
  • "pause"
  • "toggle"
  • "restart"
  • "stop"
  • "next"
  • "previous"

Used by media.control.

MediaPlayState

  • "idle"
  • "opening"
  • "playing"
  • "paused"
  • "stopped"
  • "ended"

Used by media.control, media.changed, media.

ModerationAction

  • "ban"
  • "unban"
  • "timeout"

Used by chat.moderate.

MonitorMode

  • "off"
  • "monitor_only"
  • "monitor_and_output"

Used by audio.monitor, audio.

MonitorWhen

  • "setting"
  • "always"
  • "on_air"

Used by audio.monitor_when, audio.

NdiSend

  • "off"
  • "video_audio"
  • "video"
  • "audio"

Used by source.ndi_send.

NetworkApplies

  • "next_connection"

Used by network.stream_on.

Placement

  • "outer"
  • "inner"

Used by velum.filter.glow, velum.filter.shadow.

Position

  • "outer"
  • "inner"
  • "both"

Used by velum.filter.outline.

Quality

  • "standard"
  • "high"

Used by velum.filter.bg_removal.

RaidGroupPhase

  • "counting_down"
  • "sent"
  • "partial"
  • "cancelled"
  • "failed"

Used by raid.start, raid.cancel, RaidStatus.

RaidMatch

  • "linked"
  • "likely"
  • "possible"

Used by raid.targets, raid.start, raid.cancel, RaidAlsoLive, RaidLegStatus, RaidStatus.

RaidPhase

  • "counting_down"
  • "sent"
  • "cancelled"
  • "failed"

Used by raid.start, raid.cancel, RaidLegStatus, RaidStatus.

ReplayRides

  • "recording"
  • "stream"
  • "own"

Used by replay.started, replay.

Shader

  • "rounded_rect"
  • "pulse"
  • "border"
  • "blink"
  • "rgb_split"
  • "scan_lines"
  • "gradient"
  • "zoom"
  • "swirl"
  • "simple_gradient"
  • "file"

Used by velum.filter.shader.

SourceSettingKind

  • "toggle"
  • "trigger"
  • "number"
  • "integer"
  • "choice"
  • "color"
  • "text"
  • "colors"
  • "sources"
  • "path"

Used by source_settings.

SourceSettingsFrom

  • "studio"
  • "plugin"

Used by source_settings.

Spread

  • "average"
  • "by_position"

Used by velum.filter.ambient.

StreamProtocol

  • "whip"
  • "veloq"
  • "rtmps"
  • "rtmp"
  • "srt"

Used by destination.health, destinations, DestinationHealth.

StreamStatus

  • "offline"
  • "delayed"
  • "connecting"
  • "live"
  • "reconnecting"
  • "stopping"
  • "refused"
  • "error"

Used by destination.health, destinations, stream, DestinationHealth.

ThemeAppearance

  • "dark"
  • "light"

Used by theme.

UpdateStatus

  • "idle"
  • "checking"
  • "available"
  • "downloading"
  • "ready"
  • "error"

Used by update.check, update.install, update, UpdateState.

VcamSource

  • "on_air"
  • "scene"

Used by vcam.source, vcam.

VeloqTrackKind

  • "program"
  • "source"
  • "send"
  • "hidden"
  • "other"
  • "stem"

Used by veloq, ViewerMixerRow.

VeloqVisibility

  • "public"
  • "public_drop_vod"
  • "hidden_keep_vod"
  • "hidden_drop_vod"
  • "not_sent"

Used by veloq.visibility, veloq.transitions, audio, audio_groups, veloq.

VeloraProtocol

  • "whip"
  • "veloq"

Used by veloq.send_with.

WebPageState

  • "idle"
  • "loading"
  • "ok"
  • "failed"

Used by web.changed, web.

to open · ↑ ↓ to move · Esc to close