Developer
Log in

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.

Keyscope: control

Parameters

  • filterfilterrequired

    The effect: its id, or with owner, its name. Give its id, or its name together with owner.

    Choices in filters

  • ownersourceoptional

    The source or scene the effect is on, when filter is a name. Give its id or name.

    Choices in sources

  • modechoiceoptional

    On, off, or toggle.

    One of on off toggle · Default "toggle"

Result

  • enabledbooleanalways
  • filterstring (uuid)always

    The effect's id.

Live state

filters.items[filter].enabled bool

On while the effect is on. From the filters topic. How to read it.

Request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "filter.toggle",
  "params": {
    "filter": "<effect id>"
  }
}

In the SDKs

C#
Task<FilterToggleResult> FilterToggleAsync(FilterToggleParams parameters, CancellationToken cancellationToken = default)
TypeScript
filterToggle(params: FilterToggleParams): Promise<FilterToggleResult>
Python
async def filter_toggle(self, *, filter: str, mode: FilterToggleMode | None = None, owner: str | None = None) -> FilterToggleResult
JSON Schema
JSON
{
  "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

  • filterfilterrequired

    The effect: its id, or with owner, its name. Give its id, or its name together with owner.

    Choices in filters

  • ownersourceoptional

    The source or scene the effect is on, when filter is a name. Give its id or name.

    Choices in sources

  • settingtextrequired

    The setting's key, such as opacity or key_color.

    Up to 64 characters

  • valuejsonoptional

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

  • stepnumberoptional

    Move a number setting by this much (a dial's turn), within its range.

    -10000 to 10000

  • fade_msintegeroptional

    Fade a number setting to its new value over this long; at once when left out.

    0 to 60000 ms

Result

  • fade_msintegeralwayscan be null

    How long the fade takes; null when it was set at once.

  • filterstring (uuid)always

    The effect's id.

  • settingstringalways
  • valuenumber or boolean or string or arrayalways

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

Request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "filter.set",
  "params": {
    "filter": "<effect id>",
    "setting": "<text>"
  }
}

In the SDKs

C#
Task<FilterSetResult> FilterSetAsync(FilterSetParams parameters, CancellationToken cancellationToken = default)
TypeScript
filterSet(params: FilterSetParams): Promise<FilterSetResult>
Python
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) -> FilterSetResult
JSON Schema
JSON
{
  "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"
  }
}

to open · ↑ ↓ to move · Esc to close