OBS MCP Server

{ "requests": [ { "description": "Gets an array of all available transition kinds.\n\nSimilar to `GetInputKindList`", "requestType": "GetTransitionKindList", "complexity": 2, "rpcVersion": "1", "deprecated": false, "initialVersion": "5.0.0", "category": "transitions", "requestFields": [], "responseFields": [ { "valueName": "transitionKinds", "valueType": "Array<String>", "valueDescription": "Array of transition kinds" } ] }, { "description": "Gets an array of all scene transitions in OBS.", "requestType": "GetSceneTransitionList", "complexity": 3, "rpcVersion": "1", "deprecated": false, "initialVersion": "5.0.0", "category": "transitions", "requestFields": [], "responseFields": [ { "valueName": "currentSceneTransitionName", "valueType": "String", "valueDescription": "Name of the current scene transition. Can be null" }, { "valueName": "currentSceneTransitionUuid", "valueType": "String", "valueDescription": "UUID of the current scene transition. Can be null" }, { "valueName": "currentSceneTransitionKind", "valueType": "String", "valueDescription": "Kind of the current scene transition. Can be null" }, { "valueName": "transitions", "valueType": "Array<Object>", "valueDescription": "Array of transitions" } ] }, { "description": "Gets information about the current scene transition.", "requestType": "GetCurrentSceneTransition", "complexity": 2, "rpcVersion": "1", "deprecated": false, "initialVersion": "5.0.0", "category": "transitions", "requestFields": [], "responseFields": [ { "valueName": "transitionName", "valueType": "String", "valueDescription": "Name of the transition" }, { "valueName": "transitionUuid", "valueType": "String", "valueDescription": "UUID of the transition" }, { "valueName": "transitionKind", "valueType": "String", "valueDescription": "Kind of the transition" }, { "valueName": "transitionFixed", "valueType": "Boolean", "valueDescription": "Whether the transition uses a fixed (unconfigurable) duration" }, { "valueName": "transitionDuration", "valueType": "Number", "valueDescription": "Configured transition duration in milliseconds. `null` if transition is fixed" }, { "valueName": "transitionConfigurable", "valueType": "Boolean", "valueDescription": "Whether the transition supports being configured" }, { "valueName": "transitionSettings", "valueType": "Object", "valueDescription": "Object of settings for the transition. `null` if transition is not configurable" } ] }, { "description": "Sets the current scene transition.\n\nSmall note: While the namespace of scene transitions is generally unique, that uniqueness is not a guarantee as it is with other resources like inputs.", "requestType": "SetCurrentSceneTransition", "complexity": 2, "rpcVersion": "1", "deprecated": false, "initialVersion": "5.0.0", "category": "transitions", "requestFields": [ { "valueName": "transitionName", "valueType": "String", "valueDescription": "Name of the transition to make active", "valueRestrictions": null, "valueOptional": false, "valueOptionalBehavior": null } ], "responseFields": [] }, { "description": "Sets the duration of the current scene transition, if it is not fixed.", "requestType": "SetCurrentSceneTransitionDuration", "complexity": 2, "rpcVersion": "1", "deprecated": false, "initialVersion": "5.0.0", "category": "transitions", "requestFields": [ { "valueName": "transitionDuration", "valueType": "Number", "valueDescription": "Duration in milliseconds", "valueRestrictions": ">= 50, <= 20000", "valueOptional": false, "valueOptionalBehavior": null } ], "responseFields": [] }, { "description": "Sets the settings of the current scene transition.", "requestType": "SetCurrentSceneTransitionSettings", "complexity": 3, "rpcVersion": "1", "deprecated": false, "initialVersion": "5.0.0", "category": "transitions", "requestFields": [ { "valueName": "transitionSettings", "valueType": "Object", "valueDescription": "Settings object to apply to the transition. Can be `{}`", "valueRestrictions": null, "valueOptional": false, "valueOptionalBehavior": null }, { "valueName": "overlay", "valueType": "Boolean", "valueDescription": "Whether to overlay over the current settings or replace them", "valueRestrictions": null, "valueOptional": true, "valueOptionalBehavior": "true" } ], "responseFields": [] }, { "description": "Gets the cursor position of the current scene transition.\n\nNote: `transitionCursor` will return 1.0 when the transition is inactive.", "requestType": "GetCurrentSceneTransitionCursor", "complexity": 2, "rpcVersion": "1", "deprecated": false, "initialVersion": "5.0.0", "category": "transitions", "requestFields": [], "responseFields": [ { "valueName": "transitionCursor", "valueType": "Number", "valueDescription": "Cursor position, between 0.0 and 1.0" } ] }, { "description": "Triggers the current scene transition. Same functionality as the `Transition` button in studio mode.", "requestType": "TriggerStudioModeTransition", "complexity": 1, "rpcVersion": "1", "deprecated": false, "initialVersion": "5.0.0", "category": "transitions", "requestFields": [], "responseFields": [] }, { "description": "Sets the position of the TBar.\n\n**Very important note**: This will be deprecated and replaced in a future version of obs-websocket.", "requestType": "SetTBarPosition", "complexity": 3, "rpcVersion": "1", "deprecated": false, "initialVersion": "5.0.0", "category": "transitions", "requestFields": [ { "valueName": "position", "valueType": "Number", "valueDescription": "New position", "valueRestrictions": ">= 0.0, <= 1.0", "valueOptional": false, "valueOptionalBehavior": null }, { "valueName": "release", "valueType": "Boolean", "valueDescription": "Whether to release the TBar. Only set `false` if you know that you will be sending another position update", "valueRestrictions": null, "valueOptional": true, "valueOptionalBehavior": "`true`" } ], "responseFields": [] } ] }