Actions
Collections
1 action in the Collections group. Each is its own JSON-RPC method, and also runs through action.run.
collection.switchSwitch scene collection
Opens another scene collection, as Studio's collection menu does: its scenes, sources and automations take the place of the open one's.
Parameters
The collection. Give its id or name.
Result
changedbooleanalwaysFalse when it was already open.
collectionstringalwaysThe collection's id.
Live state
collections.current == collection bool
On while this collection is open. From the collections topic. How to read it.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "collection.switch",
"params": {
"collection": "<collection id or name>"
}
}In the SDKs
C#
Task<CollectionSwitchResult> CollectionSwitchAsync(CollectionSwitchParams parameters, CancellationToken cancellationToken = default)TypeScript
collectionSwitch(params: CollectionSwitchParams): Promise<CollectionSwitchResult>Python
async def collection_switch(self, *, collection: str) -> CollectionSwitchResultJSON Schema
JSON
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"collection": {
"description": "The collection. Give its id or name.",
"minLength": 1,
"type": "string"
}
},
"required": [
"collection"
],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"changed": {
"description": "False when it was already open.",
"type": "boolean"
},
"collection": {
"description": "The collection's id.",
"type": "string"
}
},
"required": [
"collection",
"changed"
],
"type": "object"
}
}
