Developer
Log in

Actions

Stream info

1 action in the Stream info group. Each is its own JSON-RPC method, and also runs through action.run.

streaminfo.applySet title and category

Applies a title, category and tags (any of them) to Studio's stream info and sends it to every platform lit in the Stream manager, or to the platforms given.

Keyscope: broadcast

Parameters

  • titletextoptional

    The stream's title.

    Up to 140 characters

  • categorytextoptional

    The category's name (or its Velora slug).

    Up to 200 characters

  • tagstext_listoptional

    The tags (replacing the current ones).

    Up to 10 items

  • platformschoice_listoptional

    Where to send it; every lit platform when left out.

    Any of velora twitch kick youtube owncast

Result

  • recordStreamInfoalways

    Studio's stream info now.

    Fields of record
    • categoryStreamCategoryalways
    • tagsarray of stringalways
    • titlestringalways
  • resultsmap of id → PlatformResultalways

    Each platform's result, by platform.

    Fields of results
    • errorstringoptional
    • notesarray of stringoptional
    • okbooleanoptional

Live state

stream_info.title string

The title in Studio's stream info. From the stream_info topic. How to read it.

Request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "streaminfo.apply"
}

In the SDKs

C#
Task<StreaminfoApplyResult> StreaminfoApplyAsync(CancellationToken cancellationToken = default)
Python
async def streaminfo_apply(self, *, category: str | None = None, platforms: list[StreaminfoApplyPlatform] | None = None, tags: list[str] | None = None, title: str | None = None) -> StreaminfoApplyResult
JSON Schema
JSON
{
  "params_schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "additionalProperties": false,
    "properties": {
      "category": {
        "description": "The category's name (or its Velora slug).",
        "maxLength": 200,
        "type": "string"
      },
      "platforms": {
        "description": "Where to send it; every lit platform when left out.",
        "items": {
          "enum": [
            "velora",
            "twitch",
            "kick",
            "youtube",
            "owncast"
          ],
          "type": "string"
        },
        "type": "array",
        "uniqueItems": true
      },
      "tags": {
        "description": "The tags (replacing the current ones).",
        "items": {
          "type": "string"
        },
        "maxItems": 10,
        "type": "array"
      },
      "title": {
        "description": "The stream's title.",
        "maxLength": 140,
        "type": "string"
      }
    },
    "required": [],
    "type": "object"
  },
  "result_schema": {
    "additionalProperties": false,
    "properties": {
      "record": {
        "additionalProperties": false,
        "description": "Studio's stream info now.",
        "properties": {
          "category": {
            "additionalProperties": false,
            "properties": {
              "art": {
                "description": "A link to its box art, when known.",
                "type": "string"
              },
              "game": {
                "description": "Known to be a game.",
                "type": "boolean"
              },
              "name": {
                "type": "string"
              },
              "slug": {
                "description": "Its Velora slug, when it has one.",
                "type": "string"
              }
            },
            "required": [
              "name"
            ],
            "title": "StreamCategory",
            "type": "object"
          },
          "tags": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "title": {
            "type": "string"
          }
        },
        "required": [
          "title",
          "category",
          "tags"
        ],
        "title": "StreamInfo",
        "type": "object"
      },
      "results": {
        "additionalProperties": {
          "additionalProperties": true,
          "description": "ok when the platform took it, or error with why; notes say what the platform changed or left out (a tag it doesn't allow). A platform may add what it stored, as it describes it.",
          "properties": {
            "error": {
              "type": "string"
            },
            "notes": {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "ok": {
              "type": "boolean"
            }
          },
          "title": "PlatformResult",
          "type": "object"
        },
        "description": "Each platform's result, by platform.",
        "type": "object"
      }
    },
    "required": [
      "record",
      "results"
    ],
    "type": "object"
  }
}

to open · ↑ ↓ to move · Esc to close