Actions
Effects
2 actions in the Effects group. Each is its own JSON-RPC method, and also runs through action.run.
filter.toggleTurn an effect on or off
Turns one effect (filter) on a source or scene on, off, or the other way.
Parameters
The effect: its id, or with owner, its name. Give its id, or its name together with owner.
The source or scene the effect is on, when filter is a name. Give its id or name.
On, off, or toggle.
Result
enabledbooleanalwaysfilterstring (uuid)alwaysThe effect's id.
Live state
filters.items[filter].enabled bool
On while the effect is on. From the filters topic. How to read it.
{
"jsonrpc": "2.0",
"id": 1,
"method": "filter.toggle",
"params": {
"filter": "<effect id>"
}
}In the SDKs
Task<FilterToggleResult> FilterToggleAsync(FilterToggleParams parameters, CancellationToken cancellationToken = default)filterToggle(params: FilterToggleParams): Promise<FilterToggleResult>async def filter_toggle(self, *, filter: str, mode: FilterToggleMode | None = None, owner: str | None = None) -> FilterToggleResultJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"filter": {
"description": "The effect: its id, or with owner, its name. Give its id, or its name together with owner.",
"minLength": 1,
"type": "string"
},
"mode": {
"default": "toggle",
"description": "On, off, or toggle.",
"enum": [
"on",
"off",
"toggle"
],
"type": "string"
},
"owner": {
"description": "The source or scene the effect is on, when filter is a name. Give its id or name.",
"minLength": 1,
"type": "string"
}
},
"required": [
"filter"
],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"filter": {
"description": "The effect's id.",
"format": "uuid",
"type": "string"
}
},
"required": [
"filter",
"enabled"
],
"type": "object"
}
}filter.setSet an effect's setting
Sets one setting of an effect (filter): a number, on or off, a color, a choice or a file, checked against that effect's own settings (catalog.list has them under filter_settings). A number can also move by a step (for dials) or fade to its new value. Give value or step.
KeyDialscope: manage
Parameters
The effect: its id, or with owner, its name. Give its id, or its name together with owner.
The source or scene the effect is on, when filter is a name. Give its id or name.
The setting's key, such as opacity or key_color.
The new value: a number, true or false, a color as "#rrggbb" or "#rrggbbaa", a choice's word, a file's full path, or sources (a list, by name or id).
Move a number setting by this much (a dial's turn), within its range.
Fade a number setting to its new value over this long; at once when left out.
Result
fade_msintegeralwayscan be nullHow long the fade takes; null when it was set at once.
filterstring (uuid)alwaysThe effect's id.
settingstringalwaysvaluenumber or boolean or string or arrayalwaysThe value it was set to (a fade's end); sources as a list of ids.
Live state
filters.items[filter].settings[setting] any
The setting's value now. From the filters topic. How to read it.
{
"jsonrpc": "2.0",
"id": 1,
"method": "filter.set",
"params": {
"filter": "<effect id>",
"setting": "<text>"
}
}In the SDKs
Task<FilterSetResult> FilterSetAsync(FilterSetParams parameters, CancellationToken cancellationToken = default)filterSet(params: FilterSetParams): Promise<FilterSetResult>async def filter_set(self, *, filter: str, setting: str, fade_ms: int | None = None, owner: str | None = None, step: float | None = None, value: Any | None = None) -> FilterSetResultJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"fade_ms": {
"description": "Fade a number setting to its new value over this long; at once when left out.",
"maximum": 60000,
"minimum": 0,
"type": "integer"
},
"filter": {
"description": "The effect: its id, or with owner, its name. Give its id, or its name together with owner.",
"minLength": 1,
"type": "string"
},
"owner": {
"description": "The source or scene the effect is on, when filter is a name. Give its id or name.",
"minLength": 1,
"type": "string"
},
"setting": {
"description": "The setting's key, such as opacity or key_color.",
"maxLength": 64,
"type": "string"
},
"step": {
"description": "Move a number setting by this much (a dial's turn), within its range.",
"maximum": 10000.0,
"minimum": -10000.0,
"type": "number"
},
"value": {
"description": "The new value: a number, true or false, a color as \"#rrggbb\" or \"#rrggbbaa\", a choice's word, a file's full path, or sources (a list, by name or id).",
"items": {
"type": "string"
},
"type": [
"number",
"boolean",
"string",
"array"
]
}
},
"required": [
"filter",
"setting"
],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"fade_ms": {
"description": "How long the fade takes; null when it was set at once.",
"type": [
"integer",
"null"
]
},
"filter": {
"description": "The effect's id.",
"format": "uuid",
"type": "string"
},
"setting": {
"type": "string"
},
"value": {
"description": "The value it was set to (a fade's end); sources as a list of ids.",
"items": {
"type": "string"
},
"type": [
"number",
"boolean",
"string",
"array"
]
}
},
"required": [
"filter",
"setting",
"value",
"fade_ms"
],
"type": "object"
}
}
