OBS MCP Server
by royshil
Verified
{
"events": [
{
"description": "The current scene collection has begun changing.\n\nNote: We recommend using this event to trigger a pause of all polling requests, as performing any requests during a\nscene collection change is considered undefined behavior and can cause crashes!",
"eventType": "CurrentSceneCollectionChanging",
"eventSubscription": "Config",
"complexity": 1,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "config",
"dataFields": [
{
"valueName": "sceneCollectionName",
"valueType": "String",
"valueDescription": "Name of the current scene collection"
}
]
},
{
"description": "The current scene collection has changed.\n\nNote: If polling has been paused during `CurrentSceneCollectionChanging`, this is the que to restart polling.",
"eventType": "CurrentSceneCollectionChanged",
"eventSubscription": "Config",
"complexity": 1,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "config",
"dataFields": [
{
"valueName": "sceneCollectionName",
"valueType": "String",
"valueDescription": "Name of the new scene collection"
}
]
},
{
"description": "The scene collection list has changed.",
"eventType": "SceneCollectionListChanged",
"eventSubscription": "Config",
"complexity": 1,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "config",
"dataFields": [
{
"valueName": "sceneCollections",
"valueType": "Array<String>",
"valueDescription": "Updated list of scene collections"
}
]
},
{
"description": "The current profile has begun changing.",
"eventType": "CurrentProfileChanging",
"eventSubscription": "Config",
"complexity": 1,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "config",
"dataFields": [
{
"valueName": "profileName",
"valueType": "String",
"valueDescription": "Name of the current profile"
}
]
},
{
"description": "The current profile has changed.",
"eventType": "CurrentProfileChanged",
"eventSubscription": "Config",
"complexity": 1,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "config",
"dataFields": [
{
"valueName": "profileName",
"valueType": "String",
"valueDescription": "Name of the new profile"
}
]
},
{
"description": "The profile list has changed.",
"eventType": "ProfileListChanged",
"eventSubscription": "Config",
"complexity": 1,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "config",
"dataFields": [
{
"valueName": "profiles",
"valueType": "Array<String>",
"valueDescription": "Updated list of profiles"
}
]
},
{
"description": "A source's filter list has been reindexed.",
"eventType": "SourceFilterListReindexed",
"eventSubscription": "Filters",
"complexity": 3,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "filters",
"dataFields": [
{
"valueName": "sourceName",
"valueType": "String",
"valueDescription": "Name of the source"
},
{
"valueName": "filters",
"valueType": "Array<Object>",
"valueDescription": "Array of filter objects"
}
]
},
{
"description": "A filter has been added to a source.",
"eventType": "SourceFilterCreated",
"eventSubscription": "Filters",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "filters",
"dataFields": [
{
"valueName": "sourceName",
"valueType": "String",
"valueDescription": "Name of the source the filter was added to"
},
{
"valueName": "filterName",
"valueType": "String",
"valueDescription": "Name of the filter"
},
{
"valueName": "filterKind",
"valueType": "String",
"valueDescription": "The kind of the filter"
},
{
"valueName": "filterIndex",
"valueType": "Number",
"valueDescription": "Index position of the filter"
},
{
"valueName": "filterSettings",
"valueType": "Object",
"valueDescription": "The settings configured to the filter when it was created"
},
{
"valueName": "defaultFilterSettings",
"valueType": "Object",
"valueDescription": "The default settings for the filter"
}
]
},
{
"description": "A filter has been removed from a source.",
"eventType": "SourceFilterRemoved",
"eventSubscription": "Filters",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "filters",
"dataFields": [
{
"valueName": "sourceName",
"valueType": "String",
"valueDescription": "Name of the source the filter was on"
},
{
"valueName": "filterName",
"valueType": "String",
"valueDescription": "Name of the filter"
}
]
},
{
"description": "The name of a source filter has changed.",
"eventType": "SourceFilterNameChanged",
"eventSubscription": "Filters",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "filters",
"dataFields": [
{
"valueName": "sourceName",
"valueType": "String",
"valueDescription": "The source the filter is on"
},
{
"valueName": "oldFilterName",
"valueType": "String",
"valueDescription": "Old name of the filter"
},
{
"valueName": "filterName",
"valueType": "String",
"valueDescription": "New name of the filter"
}
]
},
{
"description": "An source filter's settings have changed (been updated).",
"eventType": "SourceFilterSettingsChanged",
"eventSubscription": "Filters",
"complexity": 3,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.4.0",
"category": "filters",
"dataFields": [
{
"valueName": "sourceName",
"valueType": "String",
"valueDescription": "Name of the source the filter is on"
},
{
"valueName": "filterName",
"valueType": "String",
"valueDescription": "Name of the filter"
},
{
"valueName": "filterSettings",
"valueType": "Object",
"valueDescription": "New settings object of the filter"
}
]
},
{
"description": "A source filter's enable state has changed.",
"eventType": "SourceFilterEnableStateChanged",
"eventSubscription": "Filters",
"complexity": 3,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "filters",
"dataFields": [
{
"valueName": "sourceName",
"valueType": "String",
"valueDescription": "Name of the source the filter is on"
},
{
"valueName": "filterName",
"valueType": "String",
"valueDescription": "Name of the filter"
},
{
"valueName": "filterEnabled",
"valueType": "Boolean",
"valueDescription": "Whether the filter is enabled"
}
]
},
{
"description": "OBS has begun the shutdown process.",
"eventType": "ExitStarted",
"eventSubscription": "General",
"complexity": 1,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "general",
"dataFields": []
},
{
"description": "An input has been created.",
"eventType": "InputCreated",
"eventSubscription": "Inputs",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"dataFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input"
},
{
"valueName": "inputUuid",
"valueType": "String",
"valueDescription": "UUID of the input"
},
{
"valueName": "inputKind",
"valueType": "String",
"valueDescription": "The kind of the input"
},
{
"valueName": "unversionedInputKind",
"valueType": "String",
"valueDescription": "The unversioned kind of input (aka no `_v2` stuff)"
},
{
"valueName": "inputKindCaps",
"valueType": "Number",
"valueDescription": "Bitflag value for the caps that an input supports. See obs_source_info.output_flags in the libobs docs"
},
{
"valueName": "inputSettings",
"valueType": "Object",
"valueDescription": "The settings configured to the input when it was created"
},
{
"valueName": "defaultInputSettings",
"valueType": "Object",
"valueDescription": "The default settings for the input"
}
]
},
{
"description": "An input has been removed.",
"eventType": "InputRemoved",
"eventSubscription": "Inputs",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"dataFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input"
},
{
"valueName": "inputUuid",
"valueType": "String",
"valueDescription": "UUID of the input"
}
]
},
{
"description": "The name of an input has changed.",
"eventType": "InputNameChanged",
"eventSubscription": "Inputs",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"dataFields": [
{
"valueName": "inputUuid",
"valueType": "String",
"valueDescription": "UUID of the input"
},
{
"valueName": "oldInputName",
"valueType": "String",
"valueDescription": "Old name of the input"
},
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "New name of the input"
}
]
},
{
"description": "An input's settings have changed (been updated).\n\nNote: On some inputs, changing values in the properties dialog will cause an immediate update. Pressing the \"Cancel\" button will revert the settings, resulting in another event being fired.",
"eventType": "InputSettingsChanged",
"eventSubscription": "Inputs",
"complexity": 3,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.4.0",
"category": "inputs",
"dataFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input"
},
{
"valueName": "inputUuid",
"valueType": "String",
"valueDescription": "UUID of the input"
},
{
"valueName": "inputSettings",
"valueType": "Object",
"valueDescription": "New settings object of the input"
}
]
},
{
"description": "An input's active state has changed.\n\nWhen an input is active, it means it's being shown by the program feed.",
"eventType": "InputActiveStateChanged",
"eventSubscription": "InputActiveStateChanged",
"complexity": 3,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"dataFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input"
},
{
"valueName": "inputUuid",
"valueType": "String",
"valueDescription": "UUID of the input"
},
{
"valueName": "videoActive",
"valueType": "Boolean",
"valueDescription": "Whether the input is active"
}
]
},
{
"description": "An input's show state has changed.\n\nWhen an input is showing, it means it's being shown by the preview or a dialog.",
"eventType": "InputShowStateChanged",
"eventSubscription": "InputShowStateChanged",
"complexity": 3,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"dataFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input"
},
{
"valueName": "inputUuid",
"valueType": "String",
"valueDescription": "UUID of the input"
},
{
"valueName": "videoShowing",
"valueType": "Boolean",
"valueDescription": "Whether the input is showing"
}
]
},
{
"description": "An input's mute state has changed.",
"eventType": "InputMuteStateChanged",
"eventSubscription": "Inputs",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"dataFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input"
},
{
"valueName": "inputUuid",
"valueType": "String",
"valueDescription": "UUID of the input"
},
{
"valueName": "inputMuted",
"valueType": "Boolean",
"valueDescription": "Whether the input is muted"
}
]
},
{
"description": "An input's volume level has changed.",
"eventType": "InputVolumeChanged",
"eventSubscription": "Inputs",
"complexity": 3,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"dataFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input"
},
{
"valueName": "inputUuid",
"valueType": "String",
"valueDescription": "UUID of the input"
},
{
"valueName": "inputVolumeMul",
"valueType": "Number",
"valueDescription": "New volume level multiplier"
},
{
"valueName": "inputVolumeDb",
"valueType": "Number",
"valueDescription": "New volume level in dB"
}
]
},
{
"description": "The audio balance value of an input has changed.",
"eventType": "InputAudioBalanceChanged",
"eventSubscription": "Inputs",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"dataFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input"
},
{
"valueName": "inputUuid",
"valueType": "String",
"valueDescription": "UUID of the input"
},
{
"valueName": "inputAudioBalance",
"valueType": "Number",
"valueDescription": "New audio balance value of the input"
}
]
},
{
"description": "The sync offset of an input has changed.",
"eventType": "InputAudioSyncOffsetChanged",
"eventSubscription": "Inputs",
"complexity": 3,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"dataFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input"
},
{
"valueName": "inputUuid",
"valueType": "String",
"valueDescription": "UUID of the input"
},
{
"valueName": "inputAudioSyncOffset",
"valueType": "Number",
"valueDescription": "New sync offset in milliseconds"
}
]
},
{
"description": "The audio tracks of an input have changed.",
"eventType": "InputAudioTracksChanged",
"eventSubscription": "Inputs",
"complexity": 3,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"dataFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input"
},
{
"valueName": "inputUuid",
"valueType": "String",
"valueDescription": "UUID of the input"
},
{
"valueName": "inputAudioTracks",
"valueType": "Object",
"valueDescription": "Object of audio tracks along with their associated enable states"
}
]
},
{
"description": "The monitor type of an input has changed.\n\nAvailable types are:\n\n- `OBS_MONITORING_TYPE_NONE`\n- `OBS_MONITORING_TYPE_MONITOR_ONLY`\n- `OBS_MONITORING_TYPE_MONITOR_AND_OUTPUT`",
"eventType": "InputAudioMonitorTypeChanged",
"eventSubscription": "Inputs",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"dataFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input"
},
{
"valueName": "inputUuid",
"valueType": "String",
"valueDescription": "UUID of the input"
},
{
"valueName": "monitorType",
"valueType": "String",
"valueDescription": "New monitor type of the input"
}
]
},
{
"description": "A high-volume event providing volume levels of all active inputs every 50 milliseconds.",
"eventType": "InputVolumeMeters",
"eventSubscription": "InputVolumeMeters",
"complexity": 4,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"dataFields": [
{
"valueName": "inputs",
"valueType": "Array<Object>",
"valueDescription": "Array of active inputs with their associated volume levels"
}
]
},
{
"description": "A media input has started playing.",
"eventType": "MediaInputPlaybackStarted",
"eventSubscription": "MediaInputs",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "media inputs",
"dataFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input"
},
{
"valueName": "inputUuid",
"valueType": "String",
"valueDescription": "UUID of the input"
}
]
},
{
"description": "A media input has finished playing.",
"eventType": "MediaInputPlaybackEnded",
"eventSubscription": "MediaInputs",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "media inputs",
"dataFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input"
},
{
"valueName": "inputUuid",
"valueType": "String",
"valueDescription": "UUID of the input"
}
]
},
{
"description": "An action has been performed on an input.",
"eventType": "MediaInputActionTriggered",
"eventSubscription": "MediaInputs",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "media inputs",
"dataFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input"
},
{
"valueName": "inputUuid",
"valueType": "String",
"valueDescription": "UUID of the input"
},
{
"valueName": "mediaAction",
"valueType": "String",
"valueDescription": "Action performed on the input. See `ObsMediaInputAction` enum"
}
]
},
{
"description": "The state of the stream output has changed.",
"eventType": "StreamStateChanged",
"eventSubscription": "Outputs",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "outputs",
"dataFields": [
{
"valueName": "outputActive",
"valueType": "Boolean",
"valueDescription": "Whether the output is active"
},
{
"valueName": "outputState",
"valueType": "String",
"valueDescription": "The specific state of the output"
}
]
},
{
"description": "The state of the record output has changed.",
"eventType": "RecordStateChanged",
"eventSubscription": "Outputs",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "outputs",
"dataFields": [
{
"valueName": "outputActive",
"valueType": "Boolean",
"valueDescription": "Whether the output is active"
},
{
"valueName": "outputState",
"valueType": "String",
"valueDescription": "The specific state of the output"
},
{
"valueName": "outputPath",
"valueType": "String",
"valueDescription": "File name for the saved recording, if record stopped. `null` otherwise"
}
]
},
{
"description": "The record output has started writing to a new file. For example, when a file split happens.",
"eventType": "RecordFileChanged",
"eventSubscription": "Outputs",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.5.0",
"category": "outputs",
"dataFields": [
{
"valueName": "newOutputPath",
"valueType": "String",
"valueDescription": "File name that the output has begun writing to"
}
]
},
{
"description": "The state of the replay buffer output has changed.",
"eventType": "ReplayBufferStateChanged",
"eventSubscription": "Outputs",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "outputs",
"dataFields": [
{
"valueName": "outputActive",
"valueType": "Boolean",
"valueDescription": "Whether the output is active"
},
{
"valueName": "outputState",
"valueType": "String",
"valueDescription": "The specific state of the output"
}
]
},
{
"description": "The state of the virtualcam output has changed.",
"eventType": "VirtualcamStateChanged",
"eventSubscription": "Outputs",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "outputs",
"dataFields": [
{
"valueName": "outputActive",
"valueType": "Boolean",
"valueDescription": "Whether the output is active"
},
{
"valueName": "outputState",
"valueType": "String",
"valueDescription": "The specific state of the output"
}
]
},
{
"description": "The replay buffer has been saved.",
"eventType": "ReplayBufferSaved",
"eventSubscription": "Outputs",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "outputs",
"dataFields": [
{
"valueName": "savedReplayPath",
"valueType": "String",
"valueDescription": "Path of the saved replay file"
}
]
},
{
"description": "A scene item has been created.",
"eventType": "SceneItemCreated",
"eventSubscription": "SceneItems",
"complexity": 3,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "scene items",
"dataFields": [
{
"valueName": "sceneName",
"valueType": "String",
"valueDescription": "Name of the scene the item was added to"
},
{
"valueName": "sceneUuid",
"valueType": "String",
"valueDescription": "UUID of the scene the item was added to"
},
{
"valueName": "sourceName",
"valueType": "String",
"valueDescription": "Name of the underlying source (input/scene)"
},
{
"valueName": "sourceUuid",
"valueType": "String",
"valueDescription": "UUID of the underlying source (input/scene)"
},
{
"valueName": "sceneItemId",
"valueType": "Number",
"valueDescription": "Numeric ID of the scene item"
},
{
"valueName": "sceneItemIndex",
"valueType": "Number",
"valueDescription": "Index position of the item"
}
]
},
{
"description": "A scene item has been removed.\n\nThis event is not emitted when the scene the item is in is removed.",
"eventType": "SceneItemRemoved",
"eventSubscription": "SceneItems",
"complexity": 3,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "scene items",
"dataFields": [
{
"valueName": "sceneName",
"valueType": "String",
"valueDescription": "Name of the scene the item was removed from"
},
{
"valueName": "sceneUuid",
"valueType": "String",
"valueDescription": "UUID of the scene the item was removed from"
},
{
"valueName": "sourceName",
"valueType": "String",
"valueDescription": "Name of the underlying source (input/scene)"
},
{
"valueName": "sourceUuid",
"valueType": "String",
"valueDescription": "UUID of the underlying source (input/scene)"
},
{
"valueName": "sceneItemId",
"valueType": "Number",
"valueDescription": "Numeric ID of the scene item"
}
]
},
{
"description": "A scene's item list has been reindexed.",
"eventType": "SceneItemListReindexed",
"eventSubscription": "SceneItems",
"complexity": 3,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "scene items",
"dataFields": [
{
"valueName": "sceneName",
"valueType": "String",
"valueDescription": "Name of the scene"
},
{
"valueName": "sceneUuid",
"valueType": "String",
"valueDescription": "UUID of the scene"
},
{
"valueName": "sceneItems",
"valueType": "Array<Object>",
"valueDescription": "Array of scene item objects"
}
]
},
{
"description": "A scene item's enable state has changed.",
"eventType": "SceneItemEnableStateChanged",
"eventSubscription": "SceneItems",
"complexity": 3,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "scene items",
"dataFields": [
{
"valueName": "sceneName",
"valueType": "String",
"valueDescription": "Name of the scene the item is in"
},
{
"valueName": "sceneUuid",
"valueType": "String",
"valueDescription": "UUID of the scene the item is in"
},
{
"valueName": "sceneItemId",
"valueType": "Number",
"valueDescription": "Numeric ID of the scene item"
},
{
"valueName": "sceneItemEnabled",
"valueType": "Boolean",
"valueDescription": "Whether the scene item is enabled (visible)"
}
]
},
{
"description": "A scene item's lock state has changed.",
"eventType": "SceneItemLockStateChanged",
"eventSubscription": "SceneItems",
"complexity": 3,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "scene items",
"dataFields": [
{
"valueName": "sceneName",
"valueType": "String",
"valueDescription": "Name of the scene the item is in"
},
{
"valueName": "sceneUuid",
"valueType": "String",
"valueDescription": "UUID of the scene the item is in"
},
{
"valueName": "sceneItemId",
"valueType": "Number",
"valueDescription": "Numeric ID of the scene item"
},
{
"valueName": "sceneItemLocked",
"valueType": "Boolean",
"valueDescription": "Whether the scene item is locked"
}
]
},
{
"description": "A scene item has been selected in the Ui.",
"eventType": "SceneItemSelected",
"eventSubscription": "SceneItems",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "scene items",
"dataFields": [
{
"valueName": "sceneName",
"valueType": "String",
"valueDescription": "Name of the scene the item is in"
},
{
"valueName": "sceneUuid",
"valueType": "String",
"valueDescription": "UUID of the scene the item is in"
},
{
"valueName": "sceneItemId",
"valueType": "Number",
"valueDescription": "Numeric ID of the scene item"
}
]
},
{
"description": "The transform/crop of a scene item has changed.",
"eventType": "SceneItemTransformChanged",
"eventSubscription": "SceneItemTransformChanged",
"complexity": 4,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "scene items",
"dataFields": [
{
"valueName": "sceneName",
"valueType": "String",
"valueDescription": "The name of the scene the item is in"
},
{
"valueName": "sceneUuid",
"valueType": "String",
"valueDescription": "The UUID of the scene the item is in"
},
{
"valueName": "sceneItemId",
"valueType": "Number",
"valueDescription": "Numeric ID of the scene item"
},
{
"valueName": "sceneItemTransform",
"valueType": "Object",
"valueDescription": "New transform/crop info of the scene item"
}
]
},
{
"description": "A new scene has been created.",
"eventType": "SceneCreated",
"eventSubscription": "Scenes",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "scenes",
"dataFields": [
{
"valueName": "sceneName",
"valueType": "String",
"valueDescription": "Name of the new scene"
},
{
"valueName": "sceneUuid",
"valueType": "String",
"valueDescription": "UUID of the new scene"
},
{
"valueName": "isGroup",
"valueType": "Boolean",
"valueDescription": "Whether the new scene is a group"
}
]
},
{
"description": "A scene has been removed.",
"eventType": "SceneRemoved",
"eventSubscription": "Scenes",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "scenes",
"dataFields": [
{
"valueName": "sceneName",
"valueType": "String",
"valueDescription": "Name of the removed scene"
},
{
"valueName": "sceneUuid",
"valueType": "String",
"valueDescription": "UUID of the removed scene"
},
{
"valueName": "isGroup",
"valueType": "Boolean",
"valueDescription": "Whether the scene was a group"
}
]
},
{
"description": "The name of a scene has changed.",
"eventType": "SceneNameChanged",
"eventSubscription": "Scenes",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "scenes",
"dataFields": [
{
"valueName": "sceneUuid",
"valueType": "String",
"valueDescription": "UUID of the scene"
},
{
"valueName": "oldSceneName",
"valueType": "String",
"valueDescription": "Old name of the scene"
},
{
"valueName": "sceneName",
"valueType": "String",
"valueDescription": "New name of the scene"
}
]
},
{
"description": "The current program scene has changed.",
"eventType": "CurrentProgramSceneChanged",
"eventSubscription": "Scenes",
"complexity": 1,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "scenes",
"dataFields": [
{
"valueName": "sceneName",
"valueType": "String",
"valueDescription": "Name of the scene that was switched to"
},
{
"valueName": "sceneUuid",
"valueType": "String",
"valueDescription": "UUID of the scene that was switched to"
}
]
},
{
"description": "The current preview scene has changed.",
"eventType": "CurrentPreviewSceneChanged",
"eventSubscription": "Scenes",
"complexity": 1,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "scenes",
"dataFields": [
{
"valueName": "sceneName",
"valueType": "String",
"valueDescription": "Name of the scene that was switched to"
},
{
"valueName": "sceneUuid",
"valueType": "String",
"valueDescription": "UUID of the scene that was switched to"
}
]
},
{
"description": "The list of scenes has changed.\n\nTODO: Make OBS fire this event when scenes are reordered.",
"eventType": "SceneListChanged",
"eventSubscription": "Scenes",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "scenes",
"dataFields": [
{
"valueName": "scenes",
"valueType": "Array<Object>",
"valueDescription": "Updated array of scenes"
}
]
},
{
"description": "The current scene transition has changed.",
"eventType": "CurrentSceneTransitionChanged",
"eventSubscription": "Transitions",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "transitions",
"dataFields": [
{
"valueName": "transitionName",
"valueType": "String",
"valueDescription": "Name of the new transition"
},
{
"valueName": "transitionUuid",
"valueType": "String",
"valueDescription": "UUID of the new transition"
}
]
},
{
"description": "The current scene transition duration has changed.",
"eventType": "CurrentSceneTransitionDurationChanged",
"eventSubscription": "Transitions",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "transitions",
"dataFields": [
{
"valueName": "transitionDuration",
"valueType": "Number",
"valueDescription": "Transition duration in milliseconds"
}
]
},
{
"description": "A scene transition has started.",
"eventType": "SceneTransitionStarted",
"eventSubscription": "Transitions",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "transitions",
"dataFields": [
{
"valueName": "transitionName",
"valueType": "String",
"valueDescription": "Scene transition name"
},
{
"valueName": "transitionUuid",
"valueType": "String",
"valueDescription": "Scene transition UUID"
}
]
},
{
"description": "A scene transition has completed fully.\n\nNote: Does not appear to trigger when the transition is interrupted by the user.",
"eventType": "SceneTransitionEnded",
"eventSubscription": "Transitions",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "transitions",
"dataFields": [
{
"valueName": "transitionName",
"valueType": "String",
"valueDescription": "Scene transition name"
},
{
"valueName": "transitionUuid",
"valueType": "String",
"valueDescription": "Scene transition UUID"
}
]
},
{
"description": "A scene transition's video has completed fully.\n\nUseful for stinger transitions to tell when the video *actually* ends.\n`SceneTransitionEnded` only signifies the cut point, not the completion of transition playback.\n\nNote: Appears to be called by every transition, regardless of relevance.",
"eventType": "SceneTransitionVideoEnded",
"eventSubscription": "Transitions",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "transitions",
"dataFields": [
{
"valueName": "transitionName",
"valueType": "String",
"valueDescription": "Scene transition name"
},
{
"valueName": "transitionUuid",
"valueType": "String",
"valueDescription": "Scene transition UUID"
}
]
},
{
"description": "Studio mode has been enabled or disabled.",
"eventType": "StudioModeStateChanged",
"eventSubscription": "Ui",
"complexity": 1,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "ui",
"dataFields": [
{
"valueName": "studioModeEnabled",
"valueType": "Boolean",
"valueDescription": "True == Enabled, False == Disabled"
}
]
},
{
"description": "A screenshot has been saved.\n\nNote: Triggered for the screenshot feature available in `Settings -> Hotkeys -> Screenshot Output` ONLY.\nApplications using `Get/SaveSourceScreenshot` should implement a `CustomEvent` if this kind of inter-client\ncommunication is desired.",
"eventType": "ScreenshotSaved",
"eventSubscription": "Ui",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.1.0",
"category": "ui",
"dataFields": [
{
"valueName": "savedScreenshotPath",
"valueType": "String",
"valueDescription": "Path of the saved image file"
}
]
},
{
"description": "An event has been emitted from a vendor.\n\nA vendor is a unique name registered by a third-party plugin or script, which allows for custom requests and events to be added to obs-websocket.\nIf a plugin or script implements vendor requests or events, documentation is expected to be provided with them.",
"eventType": "VendorEvent",
"eventSubscription": "Vendors",
"complexity": 3,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "general",
"dataFields": [
{
"valueName": "vendorName",
"valueType": "String",
"valueDescription": "Name of the vendor emitting the event"
},
{
"valueName": "eventType",
"valueType": "String",
"valueDescription": "Vendor-provided event typedef"
},
{
"valueName": "eventData",
"valueType": "Object",
"valueDescription": "Vendor-provided event data. {} if event does not provide any data"
}
]
},
{
"description": "Custom event emitted by `BroadcastCustomEvent`.",
"eventType": "CustomEvent",
"eventSubscription": "General",
"complexity": 1,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "general",
"dataFields": [
{
"valueName": "eventData",
"valueType": "Object",
"valueDescription": "Custom event data"
}
]
}
]
}