Toggle a source effect
set_effect_enabledEnable, disable, or toggle a configured shader-style effect on a streaming source. Returns the new state, and lists configured effects if none specified.
Instructions
Enable, disable, or toggle an effect already configured on a source (shader-style filters like a black-and-white look). Omit 'enabled' to toggle. Only effects the streamer already applied can be toggled; the error lists what is configured. Returns the new state.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"source_id": "<source_id>",
"effect": "<effect>"
},
"name": "set_effect_enabled"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| effect | Yes | Effect name as configured on the source. | |
| format | No | Canvas to affect (default both). | |
| enabled | No | Omit to toggle. | |
| scene_id | No | Scene (default: active scene). | |
| source_id | Yes | From list_sources. |