OBS MCP Server
by royshil
Verified
{
"enums": [
{
"enumType": "EventSubscription",
"enumIdentifiers": [
{
"description": "Subcription value used to disable all events.",
"enumIdentifier": "None",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 0
},
{
"description": "Subscription value to receive events in the `General` category.",
"enumIdentifier": "General",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 0)"
},
{
"description": "Subscription value to receive events in the `Config` category.",
"enumIdentifier": "Config",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 1)"
},
{
"description": "Subscription value to receive events in the `Scenes` category.",
"enumIdentifier": "Scenes",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 2)"
},
{
"description": "Subscription value to receive events in the `Inputs` category.",
"enumIdentifier": "Inputs",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 3)"
},
{
"description": "Subscription value to receive events in the `Transitions` category.",
"enumIdentifier": "Transitions",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 4)"
},
{
"description": "Subscription value to receive events in the `Filters` category.",
"enumIdentifier": "Filters",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 5)"
},
{
"description": "Subscription value to receive events in the `Outputs` category.",
"enumIdentifier": "Outputs",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 6)"
},
{
"description": "Subscription value to receive events in the `SceneItems` category.",
"enumIdentifier": "SceneItems",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 7)"
},
{
"description": "Subscription value to receive events in the `MediaInputs` category.",
"enumIdentifier": "MediaInputs",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 8)"
},
{
"description": "Subscription value to receive the `VendorEvent` event.",
"enumIdentifier": "Vendors",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 9)"
},
{
"description": "Subscription value to receive events in the `Ui` category.",
"enumIdentifier": "Ui",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 10)"
},
{
"description": "Helper to receive all non-high-volume events.",
"enumIdentifier": "All",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(General | Config | Scenes | Inputs | Transitions | Filters | Outputs | SceneItems | MediaInputs | Vendors | Ui)"
},
{
"description": "Subscription value to receive the `InputVolumeMeters` high-volume event.",
"enumIdentifier": "InputVolumeMeters",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 16)"
},
{
"description": "Subscription value to receive the `InputActiveStateChanged` high-volume event.",
"enumIdentifier": "InputActiveStateChanged",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 17)"
},
{
"description": "Subscription value to receive the `InputShowStateChanged` high-volume event.",
"enumIdentifier": "InputShowStateChanged",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 18)"
},
{
"description": "Subscription value to receive the `SceneItemTransformChanged` high-volume event.",
"enumIdentifier": "SceneItemTransformChanged",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 19)"
}
]
},
{
"enumType": "RequestBatchExecutionType",
"enumIdentifiers": [
{
"description": "Not a request batch.",
"enumIdentifier": "None",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "-1"
},
{
"description": "A request batch which processes all requests serially, as fast as possible.\n\nNote: To introduce artificial delay, use the `Sleep` request and the `sleepMillis` request field.",
"enumIdentifier": "SerialRealtime",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 0
},
{
"description": "A request batch type which processes all requests serially, in sync with the graphics thread. Designed to provide high accuracy for animations.\n\nNote: To introduce artificial delay, use the `Sleep` request and the `sleepFrames` request field.",
"enumIdentifier": "SerialFrame",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 1
},
{
"description": "A request batch type which processes all requests using all available threads in the thread pool.\n\nNote: This is mainly experimental, and only really shows its colors during requests which require lots of\nactive processing, like `GetSourceScreenshot`.",
"enumIdentifier": "Parallel",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 2
}
]
},
{
"enumType": "RequestStatus",
"enumIdentifiers": [
{
"description": "Unknown status, should never be used.",
"enumIdentifier": "Unknown",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 0
},
{
"description": "For internal use to signify a successful field check.",
"enumIdentifier": "NoError",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 10
},
{
"description": "The request has succeeded.",
"enumIdentifier": "Success",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 100
},
{
"description": "The `requestType` field is missing from the request data.",
"enumIdentifier": "MissingRequestType",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 203
},
{
"description": "The request type is invalid or does not exist.",
"enumIdentifier": "UnknownRequestType",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 204
},
{
"description": "Generic error code.\n\nNote: A comment is required to be provided by obs-websocket.",
"enumIdentifier": "GenericError",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 205
},
{
"description": "The request batch execution type is not supported.",
"enumIdentifier": "UnsupportedRequestBatchExecutionType",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 206
},
{
"description": "The server is not ready to handle the request.\n\nNote: This usually occurs during OBS scene collection change or exit. Requests may be tried again after a delay if this code is given.",
"enumIdentifier": "NotReady",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.3.0",
"enumValue": 207
},
{
"description": "A required request field is missing.",
"enumIdentifier": "MissingRequestField",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 300
},
{
"description": "The request does not have a valid requestData object.",
"enumIdentifier": "MissingRequestData",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 301
},
{
"description": "Generic invalid request field message.\n\nNote: A comment is required to be provided by obs-websocket.",
"enumIdentifier": "InvalidRequestField",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 400
},
{
"description": "A request field has the wrong data type.",
"enumIdentifier": "InvalidRequestFieldType",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 401
},
{
"description": "A request field (number) is outside of the allowed range.",
"enumIdentifier": "RequestFieldOutOfRange",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 402
},
{
"description": "A request field (string or array) is empty and cannot be.",
"enumIdentifier": "RequestFieldEmpty",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 403
},
{
"description": "There are too many request fields (eg. a request takes two optionals, where only one is allowed at a time).",
"enumIdentifier": "TooManyRequestFields",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 404
},
{
"description": "An output is running and cannot be in order to perform the request.",
"enumIdentifier": "OutputRunning",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 500
},
{
"description": "An output is not running and should be.",
"enumIdentifier": "OutputNotRunning",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 501
},
{
"description": "An output is paused and should not be.",
"enumIdentifier": "OutputPaused",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 502
},
{
"description": "An output is not paused and should be.",
"enumIdentifier": "OutputNotPaused",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 503
},
{
"description": "An output is disabled and should not be.",
"enumIdentifier": "OutputDisabled",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 504
},
{
"description": "Studio mode is active and cannot be.",
"enumIdentifier": "StudioModeActive",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 505
},
{
"description": "Studio mode is not active and should be.",
"enumIdentifier": "StudioModeNotActive",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 506
},
{
"description": "The resource was not found.\n\nNote: Resources are any kind of object in obs-websocket, like inputs, profiles, outputs, etc.",
"enumIdentifier": "ResourceNotFound",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 600
},
{
"description": "The resource already exists.",
"enumIdentifier": "ResourceAlreadyExists",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 601
},
{
"description": "The type of resource found is invalid.",
"enumIdentifier": "InvalidResourceType",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 602
},
{
"description": "There are not enough instances of the resource in order to perform the request.",
"enumIdentifier": "NotEnoughResources",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 603
},
{
"description": "The state of the resource is invalid. For example, if the resource is blocked from being accessed.",
"enumIdentifier": "InvalidResourceState",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 604
},
{
"description": "The specified input (obs_source_t-OBS_SOURCE_TYPE_INPUT) had the wrong kind.",
"enumIdentifier": "InvalidInputKind",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 605
},
{
"description": "The resource does not support being configured.\n\nThis is particularly relevant to transitions, where they do not always have changeable settings.",
"enumIdentifier": "ResourceNotConfigurable",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 606
},
{
"description": "The specified filter (obs_source_t-OBS_SOURCE_TYPE_FILTER) had the wrong kind.",
"enumIdentifier": "InvalidFilterKind",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 607
},
{
"description": "Creating the resource failed.",
"enumIdentifier": "ResourceCreationFailed",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 700
},
{
"description": "Performing an action on the resource failed.",
"enumIdentifier": "ResourceActionFailed",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 701
},
{
"description": "Processing the request failed unexpectedly.\n\nNote: A comment is required to be provided by obs-websocket.",
"enumIdentifier": "RequestProcessingFailed",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 702
},
{
"description": "The combination of request fields cannot be used to perform an action.",
"enumIdentifier": "CannotAct",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 703
}
]
},
{
"enumType": "ObsOutputState",
"enumIdentifiers": [
{
"description": "Unknown state.",
"enumIdentifier": "OBS_WEBSOCKET_OUTPUT_UNKNOWN",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_OUTPUT_UNKNOWN"
},
{
"description": "The output is starting.",
"enumIdentifier": "OBS_WEBSOCKET_OUTPUT_STARTING",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_OUTPUT_STARTING"
},
{
"description": "The input has started.",
"enumIdentifier": "OBS_WEBSOCKET_OUTPUT_STARTED",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_OUTPUT_STARTED"
},
{
"description": "The output is stopping.",
"enumIdentifier": "OBS_WEBSOCKET_OUTPUT_STOPPING",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_OUTPUT_STOPPING"
},
{
"description": "The output has stopped.",
"enumIdentifier": "OBS_WEBSOCKET_OUTPUT_STOPPED",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_OUTPUT_STOPPED"
},
{
"description": "The output has disconnected and is reconnecting.",
"enumIdentifier": "OBS_WEBSOCKET_OUTPUT_RECONNECTING",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_OUTPUT_RECONNECTING"
},
{
"description": "The output has reconnected successfully.",
"enumIdentifier": "OBS_WEBSOCKET_OUTPUT_RECONNECTED",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.1.0",
"enumValue": "OBS_WEBSOCKET_OUTPUT_RECONNECTED"
},
{
"description": "The output is now paused.",
"enumIdentifier": "OBS_WEBSOCKET_OUTPUT_PAUSED",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.1.0",
"enumValue": "OBS_WEBSOCKET_OUTPUT_PAUSED"
},
{
"description": "The output has been resumed (unpaused).",
"enumIdentifier": "OBS_WEBSOCKET_OUTPUT_RESUMED",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_OUTPUT_RESUMED"
}
]
},
{
"enumType": "ObsMediaInputAction",
"enumIdentifiers": [
{
"description": "No action.",
"enumIdentifier": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_NONE",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_NONE"
},
{
"description": "Play the media input.",
"enumIdentifier": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PLAY",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PLAY"
},
{
"description": "Pause the media input.",
"enumIdentifier": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PAUSE",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PAUSE"
},
{
"description": "Stop the media input.",
"enumIdentifier": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_STOP",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_STOP"
},
{
"description": "Restart the media input.",
"enumIdentifier": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_RESTART",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_RESTART"
},
{
"description": "Go to the next playlist item.",
"enumIdentifier": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_NEXT",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_NEXT"
},
{
"description": "Go to the previous playlist item.",
"enumIdentifier": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PREVIOUS",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PREVIOUS"
}
]
},
{
"enumType": "WebSocketCloseCode",
"enumIdentifiers": [
{
"description": "For internal use only to tell the request handler not to perform any close action.",
"enumIdentifier": "DontClose",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 0
},
{
"description": "Unknown reason, should never be used.",
"enumIdentifier": "UnknownReason",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 4000
},
{
"description": "The server was unable to decode the incoming websocket message.",
"enumIdentifier": "MessageDecodeError",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 4002
},
{
"description": "A data field is required but missing from the payload.",
"enumIdentifier": "MissingDataField",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 4003
},
{
"description": "A data field's value type is invalid.",
"enumIdentifier": "InvalidDataFieldType",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 4004
},
{
"description": "A data field's value is invalid.",
"enumIdentifier": "InvalidDataFieldValue",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 4005
},
{
"description": "The specified `op` was invalid or missing.",
"enumIdentifier": "UnknownOpCode",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 4006
},
{
"description": "The client sent a websocket message without first sending `Identify` message.",
"enumIdentifier": "NotIdentified",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 4007
},
{
"description": "The client sent an `Identify` message while already identified.\n\nNote: Once a client has identified, only `Reidentify` may be used to change session parameters.",
"enumIdentifier": "AlreadyIdentified",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 4008
},
{
"description": "The authentication attempt (via `Identify`) failed.",
"enumIdentifier": "AuthenticationFailed",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 4009
},
{
"description": "The server detected the usage of an old version of the obs-websocket RPC protocol.",
"enumIdentifier": "UnsupportedRpcVersion",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 4010
},
{
"description": "The websocket session has been invalidated by the obs-websocket server.\n\nNote: This is the code used by the `Kick` button in the UI Session List. If you receive this code, you must not automatically reconnect.",
"enumIdentifier": "SessionInvalidated",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 4011
},
{
"description": "A requested feature is not supported due to hardware/software limitations.",
"enumIdentifier": "UnsupportedFeature",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 4012
}
]
},
{
"enumType": "WebSocketOpCode",
"enumIdentifiers": [
{
"description": "The initial message sent by obs-websocket to newly connected clients.",
"enumIdentifier": "Hello",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 0
},
{
"description": "The message sent by a newly connected client to obs-websocket in response to a `Hello`.",
"enumIdentifier": "Identify",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 1
},
{
"description": "The response sent by obs-websocket to a client after it has successfully identified with obs-websocket.",
"enumIdentifier": "Identified",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 2
},
{
"description": "The message sent by an already-identified client to update identification parameters.",
"enumIdentifier": "Reidentify",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 3
},
{
"description": "The message sent by obs-websocket containing an event payload.",
"enumIdentifier": "Event",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 5
},
{
"description": "The message sent by a client to obs-websocket to perform a request.",
"enumIdentifier": "Request",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 6
},
{
"description": "The message sent by obs-websocket in response to a particular request from a client.",
"enumIdentifier": "RequestResponse",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 7
},
{
"description": "The message sent by a client to obs-websocket to perform a batch of requests.",
"enumIdentifier": "RequestBatch",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 8
},
{
"description": "The message sent by obs-websocket in response to a particular batch of requests from a client.",
"enumIdentifier": "RequestBatchResponse",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 9
}
]
}
]
}