Developer
Log in

Actions

Dynamic Sources

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

dynamic.set_variableSet a Dynamic Sources variable

Sets a variable Dynamic Sources choose by: the category or the title (the date and time is the computer's clock). This changes what Dynamic Sources show without changing the stream's category or title on any platform.

Keyscope: manage

Parameters

  • variablechoicerequired

    Which variable.

    One of category title

  • valuetextrequired

    Its value: a category's name or Velora slug, or a title; empty clears it.

    Up to 200 characters

Result

  • valuestringalwayscan be null

    Its value now; null when cleared.

  • variableDynamicVariable (string)always

    One of "category" "title"

Live state

dynamic.category string

The category Dynamic Sources match against. From the dynamic topic. How to read it.

Request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "dynamic.set_variable",
  "params": {
    "variable": "category",
    "value": "<text>"
  }
}

In the SDKs

C#
Task<DynamicSetVariableResult> DynamicSetVariableAsync(DynamicSetVariableParams parameters, CancellationToken cancellationToken = default)
TypeScript
dynamicSetVariable(params: DynamicSetVariableParams): Promise<DynamicSetVariableResult>
Python
async def dynamic_set_variable(self, *, value: str, variable: DynamicVariable) -> DynamicSetVariableResult
JSON Schema
JSON
{
  "params_schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "additionalProperties": false,
    "properties": {
      "value": {
        "description": "Its value: a category's name or Velora slug, or a title; empty clears it.",
        "maxLength": 200,
        "type": "string"
      },
      "variable": {
        "description": "Which variable.",
        "enum": [
          "category",
          "title"
        ],
        "type": "string"
      }
    },
    "required": [
      "variable",
      "value"
    ],
    "type": "object"
  },
  "result_schema": {
    "additionalProperties": false,
    "properties": {
      "value": {
        "description": "Its value now; null when cleared.",
        "type": [
          "string",
          "null"
        ]
      },
      "variable": {
        "enum": [
          "category",
          "title"
        ],
        "title": "DynamicVariable",
        "type": "string"
      }
    },
    "required": [
      "variable",
      "value"
    ],
    "type": "object"
  }
}

to open · ↑ ↓ to move · Esc to close