diff --git a/docs/generated/protocol.json b/docs/generated/protocol.json index 87148a00..3c0cca30 100644 --- a/docs/generated/protocol.json +++ b/docs/generated/protocol.json @@ -1290,8 +1290,16 @@ "valueType": "String", "valueDescription": "Name of the source", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sourceUuid", + "valueType": "String", + "valueDescription": "UUID of the source", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" } ], "responseFields": [ @@ -1342,8 +1350,16 @@ "valueType": "String", "valueDescription": "Name of the source to add the filter to", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sourceUuid", + "valueType": "String", + "valueDescription": "UUID of the source to add the filter to", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "filterName", @@ -1386,8 +1402,16 @@ "valueType": "String", "valueDescription": "Name of the source the filter is on", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sourceUuid", + "valueType": "String", + "valueDescription": "UUID of the source the filter is on", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "filterName", @@ -1414,8 +1438,16 @@ "valueType": "String", "valueDescription": "Name of the source the filter is on", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sourceUuid", + "valueType": "String", + "valueDescription": "UUID of the source the filter is on", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "filterName", @@ -1450,8 +1482,16 @@ "valueType": "String", "valueDescription": "Name of the source", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sourceUuid", + "valueType": "String", + "valueDescription": "UUID of the source", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "filterName", @@ -1499,8 +1539,16 @@ "valueType": "String", "valueDescription": "Name of the source the filter is on", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sourceUuid", + "valueType": "String", + "valueDescription": "UUID of the source the filter is on", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "filterName", @@ -1535,8 +1583,16 @@ "valueType": "String", "valueDescription": "Name of the source the filter is on", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sourceUuid", + "valueType": "String", + "valueDescription": "UUID of the source the filter is on", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "filterName", @@ -1579,8 +1635,16 @@ "valueType": "String", "valueDescription": "Name of the source the filter is on", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sourceUuid", + "valueType": "String", + "valueDescription": "UUID of the source the filter is on", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "filterName", @@ -2028,8 +2092,16 @@ "valueType": "String", "valueDescription": "Name of the scene to add the input to as a scene item", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the scene to add the input to as a scene item", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "inputName", @@ -2065,6 +2137,11 @@ } ], "responseFields": [ + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the newly created input" + }, { "valueName": "sceneItemId", "valueType": "Number", @@ -2086,8 +2163,16 @@ "valueType": "String", "valueDescription": "Name of the input to remove", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input to remove", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" } ], "responseFields": [] @@ -2106,8 +2191,16 @@ "valueType": "String", "valueDescription": "Current input name", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "Current input UUID", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "newInputName", @@ -2160,8 +2253,16 @@ "valueType": "String", "valueDescription": "Name of the input to get the settings of", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input to get the settings of", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" } ], "responseFields": [ @@ -2191,8 +2292,16 @@ "valueType": "String", "valueDescription": "Name of the input to set the settings of", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input to set the settings of", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "inputSettings", @@ -2227,8 +2336,16 @@ "valueType": "String", "valueDescription": "Name of input to get the mute state of", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of input to get the mute state of", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" } ], "responseFields": [ @@ -2253,8 +2370,16 @@ "valueType": "String", "valueDescription": "Name of the input to set the mute state of", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input to set the mute state of", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "inputMuted", @@ -2281,8 +2406,16 @@ "valueType": "String", "valueDescription": "Name of the input to toggle the mute state of", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input to toggle the mute state of", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" } ], "responseFields": [ @@ -2307,8 +2440,16 @@ "valueType": "String", "valueDescription": "Name of the input to get the volume of", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input to get the volume of", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" } ], "responseFields": [ @@ -2338,8 +2479,16 @@ "valueType": "String", "valueDescription": "Name of the input to set the volume of", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input to set the volume of", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "inputVolumeMul", @@ -2374,8 +2523,16 @@ "valueType": "String", "valueDescription": "Name of the input to get the audio balance of", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input to get the audio balance of", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" } ], "responseFields": [ @@ -2400,8 +2557,16 @@ "valueType": "String", "valueDescription": "Name of the input to set the audio balance of", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input to set the audio balance of", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "inputAudioBalance", @@ -2428,8 +2593,16 @@ "valueType": "String", "valueDescription": "Name of the input to get the audio sync offset of", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input to get the audio sync offset of", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" } ], "responseFields": [ @@ -2454,8 +2627,16 @@ "valueType": "String", "valueDescription": "Name of the input to set the audio sync offset of", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input to set the audio sync offset of", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "inputAudioSyncOffset", @@ -2482,8 +2663,16 @@ "valueType": "String", "valueDescription": "Name of the input to get the audio monitor type of", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input to get the audio monitor type of", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" } ], "responseFields": [ @@ -2508,8 +2697,16 @@ "valueType": "String", "valueDescription": "Name of the input to set the audio monitor type of", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input to set the audio monitor type of", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "monitorType", @@ -2536,8 +2733,16 @@ "valueType": "String", "valueDescription": "Name of the input", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" } ], "responseFields": [ @@ -2562,9 +2767,17 @@ "valueType": "String", "valueDescription": "Name of the input", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null - }, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, { "valueName": "inputAudioTracks", "valueType": "Object", @@ -2590,8 +2803,16 @@ "valueType": "String", "valueDescription": "Name of the input", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "propertyName", @@ -2624,8 +2845,16 @@ "valueType": "String", "valueDescription": "Name of the input", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "propertyName", @@ -2652,8 +2881,16 @@ "valueType": "String", "valueDescription": "Name of the media input", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the media input", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" } ], "responseFields": [ @@ -2688,8 +2925,16 @@ "valueType": "String", "valueDescription": "Name of the media input", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the media input", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "mediaCursor", @@ -2716,8 +2961,16 @@ "valueType": "String", "valueDescription": "Name of the media input", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the media input", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "mediaCursorOffset", @@ -2744,8 +2997,16 @@ "valueType": "String", "valueDescription": "Name of the media input", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the media input", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "mediaAction", @@ -3225,8 +3486,16 @@ "valueType": "String", "valueDescription": "Name of the scene to get the items of", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the scene to get the items of", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" } ], "responseFields": [ @@ -3251,8 +3520,16 @@ "valueType": "String", "valueDescription": "Name of the group to get the items of", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the group to get the items of", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" } ], "responseFields": [ @@ -3277,8 +3554,16 @@ "valueType": "String", "valueDescription": "Name of the scene or group to search in", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the scene or group to search in", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "sourceName", @@ -3319,8 +3604,16 @@ "valueType": "String", "valueDescription": "Name of the scene the item is in", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the scene the item is in", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "sceneItemId", @@ -3336,6 +3629,11 @@ "valueName": "sourceName", "valueType": "String", "valueDescription": "Name of the source associated with the scene item" + }, + { + "valueName": "sourceUuid", + "valueType": "String", + "valueDescription": "UUID of the source associated with the scene item" } ] }, @@ -3353,16 +3651,32 @@ "valueType": "String", "valueDescription": "Name of the scene to create the new item in", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the scene to create the new item in", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "sourceName", "valueType": "String", "valueDescription": "Name of the source to add to the scene", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sourceUuid", + "valueType": "String", + "valueDescription": "UUID of the source to add to the scene", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "sceneItemEnabled", @@ -3395,8 +3709,16 @@ "valueType": "String", "valueDescription": "Name of the scene the item is in", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the scene the item is in", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "sceneItemId", @@ -3423,8 +3745,16 @@ "valueType": "String", "valueDescription": "Name of the scene the item is in", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the scene the item is in", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "sceneItemId", @@ -3440,7 +3770,15 @@ "valueDescription": "Name of the scene to create the duplicated item in", "valueRestrictions": null, "valueOptional": true, - "valueOptionalBehavior": "`sceneName` is assumed" + "valueOptionalBehavior": "From scene is assumed" + }, + { + "valueName": "destinationSceneUuid", + "valueType": "String", + "valueDescription": "UUID of the scene to create the duplicated item in", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "From scene is assumed" } ], "responseFields": [ @@ -3465,8 +3803,16 @@ "valueType": "String", "valueDescription": "Name of the scene the item is in", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the scene the item is in", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "sceneItemId", @@ -3499,8 +3845,16 @@ "valueType": "String", "valueDescription": "Name of the scene the item is in", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the scene the item is in", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "sceneItemId", @@ -3535,8 +3889,16 @@ "valueType": "String", "valueDescription": "Name of the scene the item is in", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the scene the item is in", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "sceneItemId", @@ -3569,8 +3931,16 @@ "valueType": "String", "valueDescription": "Name of the scene the item is in", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the scene the item is in", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "sceneItemId", @@ -3605,8 +3975,16 @@ "valueType": "String", "valueDescription": "Name of the scene the item is in", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the scene the item is in", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "sceneItemId", @@ -3639,8 +4017,16 @@ "valueType": "String", "valueDescription": "Name of the scene the item is in", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the scene the item is in", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "sceneItemId", @@ -3675,8 +4061,16 @@ "valueType": "String", "valueDescription": "Name of the scene the item is in", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the scene the item is in", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "sceneItemId", @@ -3709,8 +4103,16 @@ "valueType": "String", "valueDescription": "Name of the scene the item is in", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the scene the item is in", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "sceneItemId", @@ -3745,8 +4147,16 @@ "valueType": "String", "valueDescription": "Name of the scene the item is in", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the scene the item is in", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "sceneItemId", @@ -3779,8 +4189,16 @@ "valueType": "String", "valueDescription": "Name of the scene the item is in", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the scene the item is in", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "sceneItemId", @@ -3814,12 +4232,22 @@ { "valueName": "currentProgramSceneName", "valueType": "String", - "valueDescription": "Current program scene" + "valueDescription": "Current program scene name. Can be `null` if internal state desync" + }, + { + "valueName": "currentProgramSceneUuid", + "valueType": "String", + "valueDescription": "Current program scene UUID. Can be `null` if internal state desync" }, { "valueName": "currentPreviewSceneName", "valueType": "String", - "valueDescription": "Current preview scene. `null` if not in studio mode" + "valueDescription": "Current preview scene name. `null` if not in studio mode" + }, + { + "valueName": "currentPreviewSceneUuid", + "valueType": "String", + "valueDescription": "Current preview scene UUID. `null` if not in studio mode" }, { "valueName": "scenes", @@ -3846,7 +4274,7 @@ ] }, { - "description": "Gets the current program scene.", + "description": "Gets the current program scene.\n\nNote: This request is slated to have the `currentProgram`-prefixed fields removed from in an upcoming RPC version.", "requestType": "GetCurrentProgramScene", "complexity": 1, "rpcVersion": "1", @@ -3855,10 +4283,25 @@ "category": "scenes", "requestFields": [], "responseFields": [ + { + "valueName": "sceneName", + "valueType": "String", + "valueDescription": "Current program scene name" + }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "Current program scene UUID" + }, { "valueName": "currentProgramSceneName", "valueType": "String", - "valueDescription": "Current program scene" + "valueDescription": "Current program scene name (Deprecated)" + }, + { + "valueName": "currentProgramSceneUuid", + "valueType": "String", + "valueDescription": "Current program scene UUID (Deprecated)" } ] }, @@ -3874,16 +4317,24 @@ { "valueName": "sceneName", "valueType": "String", - "valueDescription": "Scene to set as the current program scene", + "valueDescription": "Scene name to set as the current program scene", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "Scene UUID to set as the current program scene", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" } ], "responseFields": [] }, { - "description": "Gets the current preview scene.\n\nOnly available when studio mode is enabled.", + "description": "Gets the current preview scene.\n\nOnly available when studio mode is enabled.\n\nNote: This request is slated to have the `currentPreview`-prefixed fields removed from in an upcoming RPC version.", "requestType": "GetCurrentPreviewScene", "complexity": 1, "rpcVersion": "1", @@ -3892,10 +4343,25 @@ "category": "scenes", "requestFields": [], "responseFields": [ + { + "valueName": "sceneName", + "valueType": "String", + "valueDescription": "Current preview scene name" + }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "Current preview scene UUID" + }, { "valueName": "currentPreviewSceneName", "valueType": "String", - "valueDescription": "Current preview scene" + "valueDescription": "Current preview scene name" + }, + { + "valueName": "currentPreviewSceneUuid", + "valueType": "String", + "valueDescription": "Current preview scene UUID" } ] }, @@ -3911,10 +4377,18 @@ { "valueName": "sceneName", "valueType": "String", - "valueDescription": "Scene to set as the current preview scene", + "valueDescription": "Scene name to set as the current preview scene", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "Scene UUID to set as the current preview scene", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" } ], "responseFields": [] @@ -3937,7 +4411,13 @@ "valueOptionalBehavior": null } ], - "responseFields": [] + "responseFields": [ + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the created scene" + } + ] }, { "description": "Removes a scene from OBS.", @@ -3953,8 +4433,16 @@ "valueType": "String", "valueDescription": "Name of the scene to remove", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the scene to remove", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" } ], "responseFields": [] @@ -3973,8 +4461,16 @@ "valueType": "String", "valueDescription": "Name of the scene to be renamed", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the scene to be renamed", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "newSceneName", @@ -3988,7 +4484,7 @@ "responseFields": [] }, { - "description": "Gets the scene transition overridden for a scene.", + "description": "Gets the scene transition overridden for a scene.\n\nNote: A transition UUID response field is not currently able to be implemented as of 2024-1-18.", "requestType": "GetSceneSceneTransitionOverride", "complexity": 2, "rpcVersion": "1", @@ -4001,8 +4497,16 @@ "valueType": "String", "valueDescription": "Name of the scene", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the scene", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" } ], "responseFields": [ @@ -4032,8 +4536,16 @@ "valueType": "String", "valueDescription": "Name of the scene", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the scene", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "transitionName", @@ -4068,8 +4580,16 @@ "valueType": "String", "valueDescription": "Name of the source to get the active state of", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sourceUuid", + "valueType": "String", + "valueDescription": "UUID of the source to get the active state of", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" } ], "responseFields": [ @@ -4099,8 +4619,16 @@ "valueType": "String", "valueDescription": "Name of the source to take a screenshot of", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sourceUuid", + "valueType": "String", + "valueDescription": "UUID of the source to take a screenshot of", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "imageFormat", @@ -4157,8 +4685,16 @@ "valueType": "String", "valueDescription": "Name of the source to take a screenshot of", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sourceUuid", + "valueType": "String", + "valueDescription": "UUID of the source to take a screenshot of", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "imageFormat", @@ -4346,6 +4882,11 @@ "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", @@ -4373,6 +4914,11 @@ "valueType": "String", "valueDescription": "Name of the transition" }, + { + "valueName": "transitionUuid", + "valueType": "String", + "valueDescription": "UUID of the transition" + }, { "valueName": "transitionKind", "valueType": "String", @@ -4575,8 +5121,16 @@ "valueType": "String", "valueDescription": "Name of the input to open the dialog of", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input to open the dialog of", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" } ], "responseFields": [] @@ -4595,8 +5149,16 @@ "valueType": "String", "valueDescription": "Name of the input to open the dialog of", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input to open the dialog of", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" } ], "responseFields": [] @@ -4615,8 +5177,16 @@ "valueType": "String", "valueDescription": "Name of the input to open the dialog of", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input to open the dialog of", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" } ], "responseFields": [] @@ -4688,8 +5258,16 @@ "valueType": "String", "valueDescription": "Name of the source to open a projector for", "valueRestrictions": null, - "valueOptional": false, - "valueOptionalBehavior": null + "valueOptional": true, + "valueOptionalBehavior": "Unknown" + }, + { + "valueName": "sourceUuid", + "valueType": "String", + "valueDescription": "UUID of the source to open a projector for", + "valueRestrictions": null, + "valueOptional": true, + "valueOptionalBehavior": "Unknown" }, { "valueName": "monitorIndex", @@ -5007,6 +5585,11 @@ "valueType": "String", "valueDescription": "Name of the input" }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input" + }, { "valueName": "inputKind", "valueType": "String", @@ -5043,6 +5626,11 @@ "valueName": "inputName", "valueType": "String", "valueDescription": "Name of the input" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input" } ] }, @@ -5056,6 +5644,11 @@ "initialVersion": "5.0.0", "category": "inputs", "dataFields": [ + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input" + }, { "valueName": "oldInputName", "valueType": "String", @@ -5083,6 +5676,11 @@ "valueType": "String", "valueDescription": "Name of the input" }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input" + }, { "valueName": "inputSettings", "valueType": "Object", @@ -5105,6 +5703,11 @@ "valueType": "String", "valueDescription": "Name of the input" }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input" + }, { "valueName": "videoActive", "valueType": "Boolean", @@ -5127,6 +5730,11 @@ "valueType": "String", "valueDescription": "Name of the input" }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input" + }, { "valueName": "videoShowing", "valueType": "Boolean", @@ -5149,6 +5757,11 @@ "valueType": "String", "valueDescription": "Name of the input" }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input" + }, { "valueName": "inputMuted", "valueType": "Boolean", @@ -5171,6 +5784,11 @@ "valueType": "String", "valueDescription": "Name of the input" }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input" + }, { "valueName": "inputVolumeMul", "valueType": "Number", @@ -5196,7 +5814,12 @@ { "valueName": "inputName", "valueType": "String", - "valueDescription": "Name of the affected input" + "valueDescription": "Name of the input" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input" }, { "valueName": "inputAudioBalance", @@ -5220,6 +5843,11 @@ "valueType": "String", "valueDescription": "Name of the input" }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input" + }, { "valueName": "inputAudioSyncOffset", "valueType": "Number", @@ -5242,6 +5870,11 @@ "valueType": "String", "valueDescription": "Name of the input" }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input" + }, { "valueName": "inputAudioTracks", "valueType": "Object", @@ -5264,6 +5897,11 @@ "valueType": "String", "valueDescription": "Name of the input" }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input" + }, { "valueName": "monitorType", "valueType": "String", @@ -5302,6 +5940,11 @@ "valueName": "inputName", "valueType": "String", "valueDescription": "Name of the input" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input" } ] }, @@ -5319,6 +5962,11 @@ "valueName": "inputName", "valueType": "String", "valueDescription": "Name of the input" + }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input" } ] }, @@ -5337,6 +5985,11 @@ "valueType": "String", "valueDescription": "Name of the input" }, + { + "valueName": "inputUuid", + "valueType": "String", + "valueDescription": "UUID of the input" + }, { "valueName": "mediaAction", "valueType": "String", @@ -5469,11 +6122,21 @@ "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", @@ -5501,11 +6164,21 @@ "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", @@ -5528,6 +6201,11 @@ "valueType": "String", "valueDescription": "Name of the scene" }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the scene" + }, { "valueName": "sceneItems", "valueType": "Array", @@ -5550,6 +6228,11 @@ "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", @@ -5577,6 +6260,11 @@ "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", @@ -5604,6 +6292,11 @@ "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", @@ -5626,6 +6319,11 @@ "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", @@ -5653,6 +6351,11 @@ "valueType": "String", "valueDescription": "Name of the new scene" }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the new scene" + }, { "valueName": "isGroup", "valueType": "Boolean", @@ -5675,6 +6378,11 @@ "valueType": "String", "valueDescription": "Name of the removed scene" }, + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the removed scene" + }, { "valueName": "isGroup", "valueType": "Boolean", @@ -5692,6 +6400,11 @@ "initialVersion": "5.0.0", "category": "scenes", "dataFields": [ + { + "valueName": "sceneUuid", + "valueType": "String", + "valueDescription": "UUID of the scene" + }, { "valueName": "oldSceneName", "valueType": "String", @@ -5718,6 +6431,11 @@ "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" } ] }, @@ -5735,6 +6453,11 @@ "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" } ] }, @@ -5769,6 +6492,11 @@ "valueName": "transitionName", "valueType": "String", "valueDescription": "Name of the new transition" + }, + { + "valueName": "transitionUuid", + "valueType": "String", + "valueDescription": "UUID of the new transition" } ] }, @@ -5803,6 +6531,11 @@ "valueName": "transitionName", "valueType": "String", "valueDescription": "Scene transition name" + }, + { + "valueName": "transitionUuid", + "valueType": "String", + "valueDescription": "Scene transition UUID" } ] }, @@ -5820,6 +6553,11 @@ "valueName": "transitionName", "valueType": "String", "valueDescription": "Scene transition name" + }, + { + "valueName": "transitionUuid", + "valueType": "String", + "valueDescription": "Scene transition UUID" } ] }, @@ -5837,6 +6575,11 @@ "valueName": "transitionName", "valueType": "String", "valueDescription": "Scene transition name" + }, + { + "valueName": "transitionUuid", + "valueType": "String", + "valueDescription": "Scene transition UUID" } ] }, diff --git a/docs/generated/protocol.md b/docs/generated/protocol.md index 6e370d02..cd8e86e2 100644 --- a/docs/generated/protocol.md +++ b/docs/generated/protocol.md @@ -1738,6 +1738,7 @@ A new scene has been created. | Name | Type | Description | | ---- | :---: | ----------- | | sceneName | String | Name of the new scene | +| sceneUuid | String | UUID of the new scene | | isGroup | Boolean | Whether the new scene is a group | --- @@ -1755,6 +1756,7 @@ A scene has been removed. | Name | Type | Description | | ---- | :---: | ----------- | | sceneName | String | Name of the removed scene | +| sceneUuid | String | UUID of the removed scene | | isGroup | Boolean | Whether the scene was a group | --- @@ -1771,6 +1773,7 @@ The name of a scene has changed. | Name | Type | Description | | ---- | :---: | ----------- | +| sceneUuid | String | UUID of the scene | | oldSceneName | String | Old name of the scene | | sceneName | String | New name of the scene | @@ -1789,6 +1792,7 @@ The current program scene has changed. | Name | Type | Description | | ---- | :---: | ----------- | | sceneName | String | Name of the scene that was switched to | +| sceneUuid | String | UUID of the scene that was switched to | --- @@ -1805,6 +1809,7 @@ The current preview scene has changed. | Name | Type | Description | | ---- | :---: | ----------- | | sceneName | String | Name of the scene that was switched to | +| sceneUuid | String | UUID of the scene that was switched to | --- @@ -1839,6 +1844,7 @@ An input has been created. | Name | Type | Description | | ---- | :---: | ----------- | | inputName | String | Name of the input | +| inputUuid | String | UUID of the input | | inputKind | String | The kind of the input | | unversionedInputKind | String | The unversioned kind of input (aka no `_v2` stuff) | | inputSettings | Object | The settings configured to the input when it was created | @@ -1859,6 +1865,7 @@ An input has been removed. | Name | Type | Description | | ---- | :---: | ----------- | | inputName | String | Name of the input | +| inputUuid | String | UUID of the input | --- @@ -1874,6 +1881,7 @@ The name of an input has changed. | Name | Type | Description | | ---- | :---: | ----------- | +| inputUuid | String | UUID of the input | | oldInputName | String | Old name of the input | | inputName | String | New name of the input | @@ -1894,6 +1902,7 @@ Note: On some inputs, changing values in the properties dialog will cause an imm | Name | Type | Description | | ---- | :---: | ----------- | | inputName | String | Name of the input | +| inputUuid | String | UUID of the input | | inputSettings | Object | New settings object of the input | --- @@ -1913,6 +1922,7 @@ When an input is active, it means it's being shown by the program feed. | Name | Type | Description | | ---- | :---: | ----------- | | inputName | String | Name of the input | +| inputUuid | String | UUID of the input | | videoActive | Boolean | Whether the input is active | --- @@ -1932,6 +1942,7 @@ When an input is showing, it means it's being shown by the preview or a dialog. | Name | Type | Description | | ---- | :---: | ----------- | | inputName | String | Name of the input | +| inputUuid | String | UUID of the input | | videoShowing | Boolean | Whether the input is showing | --- @@ -1949,6 +1960,7 @@ An input's mute state has changed. | Name | Type | Description | | ---- | :---: | ----------- | | inputName | String | Name of the input | +| inputUuid | String | UUID of the input | | inputMuted | Boolean | Whether the input is muted | --- @@ -1966,6 +1978,7 @@ An input's volume level has changed. | Name | Type | Description | | ---- | :---: | ----------- | | inputName | String | Name of the input | +| inputUuid | String | UUID of the input | | inputVolumeMul | Number | New volume level multiplier | | inputVolumeDb | Number | New volume level in dB | @@ -1983,7 +1996,8 @@ The audio balance value of an input has changed. | Name | Type | Description | | ---- | :---: | ----------- | -| inputName | String | Name of the affected input | +| inputName | String | Name of the input | +| inputUuid | String | UUID of the input | | inputAudioBalance | Number | New audio balance value of the input | --- @@ -2001,6 +2015,7 @@ The sync offset of an input has changed. | Name | Type | Description | | ---- | :---: | ----------- | | inputName | String | Name of the input | +| inputUuid | String | UUID of the input | | inputAudioSyncOffset | Number | New sync offset in milliseconds | --- @@ -2018,6 +2033,7 @@ The audio tracks of an input have changed. | Name | Type | Description | | ---- | :---: | ----------- | | inputName | String | Name of the input | +| inputUuid | String | UUID of the input | | inputAudioTracks | Object | Object of audio tracks along with their associated enable states | --- @@ -2041,6 +2057,7 @@ Available types are: | Name | Type | Description | | ---- | :---: | ----------- | | inputName | String | Name of the input | +| inputUuid | String | UUID of the input | | monitorType | String | New monitor type of the input | --- @@ -2074,6 +2091,7 @@ The current scene transition has changed. | Name | Type | Description | | ---- | :---: | ----------- | | transitionName | String | Name of the new transition | +| transitionUuid | String | UUID of the new transition | --- @@ -2106,6 +2124,7 @@ A scene transition has started. | Name | Type | Description | | ---- | :---: | ----------- | | transitionName | String | Scene transition name | +| transitionUuid | String | Scene transition UUID | --- @@ -2124,6 +2143,7 @@ Note: Does not appear to trigger when the transition is interrupted by the user. | Name | Type | Description | | ---- | :---: | ----------- | | transitionName | String | Scene transition name | +| transitionUuid | String | Scene transition UUID | --- @@ -2145,6 +2165,7 @@ Note: Appears to be called by every transition, regardless of relevance. | Name | Type | Description | | ---- | :---: | ----------- | | transitionName | String | Scene transition name | +| transitionUuid | String | Scene transition UUID | ## Filters Events @@ -2270,7 +2291,9 @@ A scene item has been created. | Name | Type | Description | | ---- | :---: | ----------- | | sceneName | String | Name of the scene the item was added to | +| sceneUuid | String | UUID of the scene the item was added to | | sourceName | String | Name of the underlying source (input/scene) | +| sourceUuid | String | UUID of the underlying source (input/scene) | | sceneItemId | Number | Numeric ID of the scene item | | sceneItemIndex | Number | Index position of the item | @@ -2291,7 +2314,9 @@ This event is not emitted when the scene the item is in is removed. | Name | Type | Description | | ---- | :---: | ----------- | | sceneName | String | Name of the scene the item was removed from | +| sceneUuid | String | UUID of the scene the item was removed from | | sourceName | String | Name of the underlying source (input/scene) | +| sourceUuid | String | UUID of the underlying source (input/scene) | | sceneItemId | Number | Numeric ID of the scene item | --- @@ -2309,6 +2334,7 @@ A scene's item list has been reindexed. | Name | Type | Description | | ---- | :---: | ----------- | | sceneName | String | Name of the scene | +| sceneUuid | String | UUID of the scene | | sceneItems | Array<Object> | Array of scene item objects | --- @@ -2326,6 +2352,7 @@ A scene item's enable state has changed. | Name | Type | Description | | ---- | :---: | ----------- | | sceneName | String | Name of the scene the item is in | +| sceneUuid | String | UUID of the scene the item is in | | sceneItemId | Number | Numeric ID of the scene item | | sceneItemEnabled | Boolean | Whether the scene item is enabled (visible) | @@ -2344,6 +2371,7 @@ A scene item's lock state has changed. | Name | Type | Description | | ---- | :---: | ----------- | | sceneName | String | Name of the scene the item is in | +| sceneUuid | String | UUID of the scene the item is in | | sceneItemId | Number | Numeric ID of the scene item | | sceneItemLocked | Boolean | Whether the scene item is locked | @@ -2362,6 +2390,7 @@ A scene item has been selected in the Ui. | Name | Type | Description | | ---- | :---: | ----------- | | sceneName | String | Name of the scene the item is in | +| sceneUuid | String | UUID of the scene the item is in | | sceneItemId | Number | Numeric ID of the scene item | --- @@ -2379,6 +2408,7 @@ The transform/crop of a scene item has changed. | Name | Type | Description | | ---- | :---: | ----------- | | sceneName | String | The name of the scene the item is in | +| sceneUuid | String | The UUID of the scene the item is in | | sceneItemId | Number | Numeric ID of the scene item | | sceneItemTransform | Object | New transform/crop info of the scene item | @@ -2482,6 +2512,7 @@ A media input has started playing. | Name | Type | Description | | ---- | :---: | ----------- | | inputName | String | Name of the input | +| inputUuid | String | UUID of the input | --- @@ -2498,6 +2529,7 @@ A media input has finished playing. | Name | Type | Description | | ---- | :---: | ----------- | | inputName | String | Name of the input | +| inputUuid | String | UUID of the input | --- @@ -2514,6 +2546,7 @@ An action has been performed on an input. | Name | Type | Description | | ---- | :---: | ----------- | | inputName | String | Name of the input | +| inputUuid | String | UUID of the input | | mediaAction | String | Action performed on the input. See `ObsMediaInputAction` enum | ## Ui Events @@ -3211,7 +3244,8 @@ Gets the active and show state of a source. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sourceName | String | Name of the source to get the active state of | None | N/A | +| ?sourceName | String | Name of the source to get the active state of | None | Unknown | +| ?sourceUuid | String | UUID of the source to get the active state of | None | Unknown | **Response Fields:** @@ -3239,7 +3273,8 @@ If `imageWidth` and `imageHeight` are not specified, the compressed image will u | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sourceName | String | Name of the source to take a screenshot of | None | N/A | +| ?sourceName | String | Name of the source to take a screenshot of | None | Unknown | +| ?sourceUuid | String | UUID of the source to take a screenshot of | None | Unknown | | imageFormat | String | Image compression format to use. Use `GetVersion` to get compatible image formats | None | N/A | | ?imageWidth | Number | Width to scale the screenshot to | >= 8, <= 4096 | Source value is used | | ?imageHeight | Number | Height to scale the screenshot to | >= 8, <= 4096 | Source value is used | @@ -3270,7 +3305,8 @@ If `imageWidth` and `imageHeight` are not specified, the compressed image will u | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sourceName | String | Name of the source to take a screenshot of | None | N/A | +| ?sourceName | String | Name of the source to take a screenshot of | None | Unknown | +| ?sourceUuid | String | UUID of the source to take a screenshot of | None | Unknown | | imageFormat | String | Image compression format to use. Use `GetVersion` to get compatible image formats | None | N/A | | imageFilePath | String | Path to save the screenshot file to. Eg. `C:\Users\user\Desktop\screenshot.png` | None | N/A | | ?imageWidth | Number | Width to scale the screenshot to | >= 8, <= 4096 | Source value is used | @@ -3291,8 +3327,10 @@ Gets an array of all scenes in OBS. | Name | Type | Description | | ---- | :---: | ----------- | -| currentProgramSceneName | String | Current program scene | -| currentPreviewSceneName | String | Current preview scene. `null` if not in studio mode | +| currentProgramSceneName | String | Current program scene name. Can be `null` if internal state desync | +| currentProgramSceneUuid | String | Current program scene UUID. Can be `null` if internal state desync | +| currentPreviewSceneName | String | Current preview scene name. `null` if not in studio mode | +| currentPreviewSceneUuid | String | Current preview scene UUID. `null` if not in studio mode | | scenes | Array<Object> | Array of scenes | --- @@ -3319,6 +3357,8 @@ Groups in OBS are actually scenes, but renamed and modified. In obs-websocket, w Gets the current program scene. +Note: This request is slated to have the `currentProgram`-prefixed fields removed from in an upcoming RPC version. + - Complexity Rating: `1/5` - Latest Supported RPC Version: `1` - Added in v5.0.0 @@ -3327,7 +3367,10 @@ Gets the current program scene. | Name | Type | Description | | ---- | :---: | ----------- | -| currentProgramSceneName | String | Current program scene | +| sceneName | String | Current program scene name | +| sceneUuid | String | Current program scene UUID | +| currentProgramSceneName | String | Current program scene name (Deprecated) | +| currentProgramSceneUuid | String | Current program scene UUID (Deprecated) | --- @@ -3343,7 +3386,8 @@ Sets the current program scene. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sceneName | String | Scene to set as the current program scene | None | N/A | +| ?sceneName | String | Scene name to set as the current program scene | None | Unknown | +| ?sceneUuid | String | Scene UUID to set as the current program scene | None | Unknown | --- @@ -3353,6 +3397,8 @@ Gets the current preview scene. Only available when studio mode is enabled. +Note: This request is slated to have the `currentPreview`-prefixed fields removed from in an upcoming RPC version. + - Complexity Rating: `1/5` - Latest Supported RPC Version: `1` - Added in v5.0.0 @@ -3361,7 +3407,10 @@ Only available when studio mode is enabled. | Name | Type | Description | | ---- | :---: | ----------- | -| currentPreviewSceneName | String | Current preview scene | +| sceneName | String | Current preview scene name | +| sceneUuid | String | Current preview scene UUID | +| currentPreviewSceneName | String | Current preview scene name | +| currentPreviewSceneUuid | String | Current preview scene UUID | --- @@ -3379,7 +3428,8 @@ Only available when studio mode is enabled. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sceneName | String | Scene to set as the current preview scene | None | N/A | +| ?sceneName | String | Scene name to set as the current preview scene | None | Unknown | +| ?sceneUuid | String | Scene UUID to set as the current preview scene | None | Unknown | --- @@ -3397,6 +3447,12 @@ Creates a new scene in OBS. | ---- | :---: | ----------- | :----------------: | ----------------- | | sceneName | String | Name for the new scene | None | N/A | +**Response Fields:** + +| Name | Type | Description | +| ---- | :---: | ----------- | +| sceneUuid | String | UUID of the created scene | + --- ### RemoveScene @@ -3411,7 +3467,8 @@ Removes a scene from OBS. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sceneName | String | Name of the scene to remove | None | N/A | +| ?sceneName | String | Name of the scene to remove | None | Unknown | +| ?sceneUuid | String | UUID of the scene to remove | None | Unknown | --- @@ -3427,7 +3484,8 @@ Sets the name of a scene (rename). | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sceneName | String | Name of the scene to be renamed | None | N/A | +| ?sceneName | String | Name of the scene to be renamed | None | Unknown | +| ?sceneUuid | String | UUID of the scene to be renamed | None | Unknown | | newSceneName | String | New name for the scene | None | N/A | --- @@ -3436,6 +3494,8 @@ Sets the name of a scene (rename). Gets the scene transition overridden for a scene. +Note: A transition UUID response field is not currently able to be implemented as of 2024-1-18. + - Complexity Rating: `2/5` - Latest Supported RPC Version: `1` - Added in v5.0.0 @@ -3444,7 +3504,8 @@ Gets the scene transition overridden for a scene. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sceneName | String | Name of the scene | None | N/A | +| ?sceneName | String | Name of the scene | None | Unknown | +| ?sceneUuid | String | UUID of the scene | None | Unknown | **Response Fields:** @@ -3467,7 +3528,8 @@ Sets the scene transition overridden for a scene. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sceneName | String | Name of the scene | None | N/A | +| ?sceneName | String | Name of the scene | None | Unknown | +| ?sceneUuid | String | UUID of the scene | None | Unknown | | ?transitionName | String | Name of the scene transition to use as override. Specify `null` to remove | None | Unchanged | | ?transitionDuration | Number | Duration to use for any overridden transition. Specify `null` to remove | >= 50, <= 20000 | Unchanged | @@ -3550,7 +3612,8 @@ Creates a new input, adding it as a scene item to the specified scene. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sceneName | String | Name of the scene to add the input to as a scene item | None | N/A | +| ?sceneName | String | Name of the scene to add the input to as a scene item | None | Unknown | +| ?sceneUuid | String | UUID of the scene to add the input to as a scene item | None | Unknown | | inputName | String | Name of the new input to created | None | N/A | | inputKind | String | The kind of input to be created | None | N/A | | ?inputSettings | Object | Settings object to initialize the input with | None | Default settings used | @@ -3560,6 +3623,7 @@ Creates a new input, adding it as a scene item to the specified scene. | Name | Type | Description | | ---- | :---: | ----------- | +| inputUuid | String | UUID of the newly created input | | sceneItemId | Number | ID of the newly created scene item | --- @@ -3578,7 +3642,8 @@ Note: Will immediately remove all associated scene items. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| inputName | String | Name of the input to remove | None | N/A | +| ?inputName | String | Name of the input to remove | None | Unknown | +| ?inputUuid | String | UUID of the input to remove | None | Unknown | --- @@ -3594,7 +3659,8 @@ Sets the name of an input (rename). | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| inputName | String | Current input name | None | N/A | +| ?inputName | String | Current input name | None | Unknown | +| ?inputUuid | String | Current input UUID | None | Unknown | | newInputName | String | New name for the input | None | N/A | --- @@ -3635,7 +3701,8 @@ Note: Does not include defaults. To create the entire settings object, overlay ` | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| inputName | String | Name of the input to get the settings of | None | N/A | +| ?inputName | String | Name of the input to get the settings of | None | Unknown | +| ?inputUuid | String | UUID of the input to get the settings of | None | Unknown | **Response Fields:** @@ -3658,7 +3725,8 @@ Sets the settings of an input. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| inputName | String | Name of the input to set the settings of | None | N/A | +| ?inputName | String | Name of the input to set the settings of | None | Unknown | +| ?inputUuid | String | UUID of the input to set the settings of | None | Unknown | | inputSettings | Object | Object of settings to apply | None | N/A | | ?overlay | Boolean | True == apply the settings on top of existing ones, False == reset the input to its defaults, then apply settings. | None | true | @@ -3676,7 +3744,8 @@ Gets the audio mute state of an input. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| inputName | String | Name of input to get the mute state of | None | N/A | +| ?inputName | String | Name of input to get the mute state of | None | Unknown | +| ?inputUuid | String | UUID of input to get the mute state of | None | Unknown | **Response Fields:** @@ -3698,7 +3767,8 @@ Sets the audio mute state of an input. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| inputName | String | Name of the input to set the mute state of | None | N/A | +| ?inputName | String | Name of the input to set the mute state of | None | Unknown | +| ?inputUuid | String | UUID of the input to set the mute state of | None | Unknown | | inputMuted | Boolean | Whether to mute the input or not | None | N/A | --- @@ -3715,7 +3785,8 @@ Toggles the audio mute state of an input. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| inputName | String | Name of the input to toggle the mute state of | None | N/A | +| ?inputName | String | Name of the input to toggle the mute state of | None | Unknown | +| ?inputUuid | String | UUID of the input to toggle the mute state of | None | Unknown | **Response Fields:** @@ -3737,7 +3808,8 @@ Gets the current volume setting of an input. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| inputName | String | Name of the input to get the volume of | None | N/A | +| ?inputName | String | Name of the input to get the volume of | None | Unknown | +| ?inputUuid | String | UUID of the input to get the volume of | None | Unknown | **Response Fields:** @@ -3760,7 +3832,8 @@ Sets the volume setting of an input. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| inputName | String | Name of the input to set the volume of | None | N/A | +| ?inputName | String | Name of the input to set the volume of | None | Unknown | +| ?inputUuid | String | UUID of the input to set the volume of | None | Unknown | | ?inputVolumeMul | Number | Volume setting in mul | >= 0, <= 20 | `inputVolumeDb` should be specified | | ?inputVolumeDb | Number | Volume setting in dB | >= -100, <= 26 | `inputVolumeMul` should be specified | @@ -3778,7 +3851,8 @@ Gets the audio balance of an input. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| inputName | String | Name of the input to get the audio balance of | None | N/A | +| ?inputName | String | Name of the input to get the audio balance of | None | Unknown | +| ?inputUuid | String | UUID of the input to get the audio balance of | None | Unknown | **Response Fields:** @@ -3800,7 +3874,8 @@ Sets the audio balance of an input. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| inputName | String | Name of the input to set the audio balance of | None | N/A | +| ?inputName | String | Name of the input to set the audio balance of | None | Unknown | +| ?inputUuid | String | UUID of the input to set the audio balance of | None | Unknown | | inputAudioBalance | Number | New audio balance value | >= 0.0, <= 1.0 | N/A | --- @@ -3819,7 +3894,8 @@ Note: The audio sync offset can be negative too! | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| inputName | String | Name of the input to get the audio sync offset of | None | N/A | +| ?inputName | String | Name of the input to get the audio sync offset of | None | Unknown | +| ?inputUuid | String | UUID of the input to get the audio sync offset of | None | Unknown | **Response Fields:** @@ -3841,7 +3917,8 @@ Sets the audio sync offset of an input. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| inputName | String | Name of the input to set the audio sync offset of | None | N/A | +| ?inputName | String | Name of the input to set the audio sync offset of | None | Unknown | +| ?inputUuid | String | UUID of the input to set the audio sync offset of | None | Unknown | | inputAudioSyncOffset | Number | New audio sync offset in milliseconds | >= -950, <= 20000 | N/A | --- @@ -3864,7 +3941,8 @@ The available audio monitor types are: | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| inputName | String | Name of the input to get the audio monitor type of | None | N/A | +| ?inputName | String | Name of the input to get the audio monitor type of | None | Unknown | +| ?inputUuid | String | UUID of the input to get the audio monitor type of | None | Unknown | **Response Fields:** @@ -3886,7 +3964,8 @@ Sets the audio monitor type of an input. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| inputName | String | Name of the input to set the audio monitor type of | None | N/A | +| ?inputName | String | Name of the input to set the audio monitor type of | None | Unknown | +| ?inputUuid | String | UUID of the input to set the audio monitor type of | None | Unknown | | monitorType | String | Audio monitor type | None | N/A | --- @@ -3903,7 +3982,8 @@ Gets the enable state of all audio tracks of an input. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| inputName | String | Name of the input | None | N/A | +| ?inputName | String | Name of the input | None | Unknown | +| ?inputUuid | String | UUID of the input | None | Unknown | **Response Fields:** @@ -3925,7 +4005,8 @@ Sets the enable state of audio tracks of an input. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| inputName | String | Name of the input | None | N/A | +| ?inputName | String | Name of the input | None | Unknown | +| ?inputUuid | String | UUID of the input | None | Unknown | | inputAudioTracks | Object | Track settings to apply | None | N/A | --- @@ -3944,7 +4025,8 @@ Note: Use this in cases where an input provides a dynamic, selectable list of it | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| inputName | String | Name of the input | None | N/A | +| ?inputName | String | Name of the input | None | Unknown | +| ?inputUuid | String | UUID of the input | None | Unknown | | propertyName | String | Name of the list property to get the items of | None | N/A | **Response Fields:** @@ -3973,7 +4055,8 @@ Note: Use this in cases where there is a button in the properties of an input th | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| inputName | String | Name of the input | None | N/A | +| ?inputName | String | Name of the input | None | Unknown | +| ?inputUuid | String | UUID of the input | None | Unknown | | propertyName | String | Name of the button property to press | None | N/A | ## Transitions Requests @@ -4009,6 +4092,7 @@ Gets an array of all scene transitions in OBS. | Name | Type | Description | | ---- | :---: | ----------- | | currentSceneTransitionName | String | Name of the current scene transition. Can be null | +| currentSceneTransitionUuid | String | UUID of the current scene transition. Can be null | | currentSceneTransitionKind | String | Kind of the current scene transition. Can be null | | transitions | Array<Object> | Array of transitions | @@ -4027,6 +4111,7 @@ Gets information about the current scene transition. | Name | Type | Description | | ---- | :---: | ----------- | | transitionName | String | Name of the transition | +| transitionUuid | String | UUID of the transition | | transitionKind | String | Kind of the transition | | transitionFixed | Boolean | Whether the transition uses a fixed (unconfigurable) duration | | transitionDuration | Number | Configured transition duration in milliseconds. `null` if transition is fixed | @@ -4163,7 +4248,8 @@ Gets an array of all of a source's filters. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sourceName | String | Name of the source | None | N/A | +| ?sourceName | String | Name of the source | None | Unknown | +| ?sourceUuid | String | UUID of the source | None | Unknown | **Response Fields:** @@ -4207,7 +4293,8 @@ Creates a new filter, adding it to the specified source. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sourceName | String | Name of the source to add the filter to | None | N/A | +| ?sourceName | String | Name of the source to add the filter to | None | Unknown | +| ?sourceUuid | String | UUID of the source to add the filter to | None | Unknown | | filterName | String | Name of the new filter to be created | None | N/A | | filterKind | String | The kind of filter to be created | None | N/A | | ?filterSettings | Object | Settings object to initialize the filter with | None | Default settings used | @@ -4226,7 +4313,8 @@ Removes a filter from a source. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sourceName | String | Name of the source the filter is on | None | N/A | +| ?sourceName | String | Name of the source the filter is on | None | Unknown | +| ?sourceUuid | String | UUID of the source the filter is on | None | Unknown | | filterName | String | Name of the filter to remove | None | N/A | --- @@ -4243,7 +4331,8 @@ Sets the name of a source filter (rename). | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sourceName | String | Name of the source the filter is on | None | N/A | +| ?sourceName | String | Name of the source the filter is on | None | Unknown | +| ?sourceUuid | String | UUID of the source the filter is on | None | Unknown | | filterName | String | Current name of the filter | None | N/A | | newFilterName | String | New name for the filter | None | N/A | @@ -4261,7 +4350,8 @@ Gets the info for a specific source filter. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sourceName | String | Name of the source | None | N/A | +| ?sourceName | String | Name of the source | None | Unknown | +| ?sourceUuid | String | UUID of the source | None | Unknown | | filterName | String | Name of the filter | None | N/A | **Response Fields:** @@ -4287,7 +4377,8 @@ Sets the index position of a filter on a source. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sourceName | String | Name of the source the filter is on | None | N/A | +| ?sourceName | String | Name of the source the filter is on | None | Unknown | +| ?sourceUuid | String | UUID of the source the filter is on | None | Unknown | | filterName | String | Name of the filter | None | N/A | | filterIndex | Number | New index position of the filter | >= 0 | N/A | @@ -4305,7 +4396,8 @@ Sets the settings of a source filter. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sourceName | String | Name of the source the filter is on | None | N/A | +| ?sourceName | String | Name of the source the filter is on | None | Unknown | +| ?sourceUuid | String | UUID of the source the filter is on | None | Unknown | | filterName | String | Name of the filter to set the settings of | None | N/A | | filterSettings | Object | Object of settings to apply | None | N/A | | ?overlay | Boolean | True == apply the settings on top of existing ones, False == reset the input to its defaults, then apply settings. | None | true | @@ -4324,7 +4416,8 @@ Sets the enable state of a source filter. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sourceName | String | Name of the source the filter is on | None | N/A | +| ?sourceName | String | Name of the source the filter is on | None | Unknown | +| ?sourceUuid | String | UUID of the source the filter is on | None | Unknown | | filterName | String | Name of the filter | None | N/A | | filterEnabled | Boolean | New enable state of the filter | None | N/A | @@ -4344,7 +4437,8 @@ Scenes only | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sceneName | String | Name of the scene to get the items of | None | N/A | +| ?sceneName | String | Name of the scene to get the items of | None | Unknown | +| ?sceneUuid | String | UUID of the scene to get the items of | None | Unknown | **Response Fields:** @@ -4370,7 +4464,8 @@ Groups only | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sceneName | String | Name of the group to get the items of | None | N/A | +| ?sceneName | String | Name of the group to get the items of | None | Unknown | +| ?sceneUuid | String | UUID of the group to get the items of | None | Unknown | **Response Fields:** @@ -4394,7 +4489,8 @@ Scenes and Groups | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sceneName | String | Name of the scene or group to search in | None | N/A | +| ?sceneName | String | Name of the scene or group to search in | None | Unknown | +| ?sceneUuid | String | UUID of the scene or group to search in | None | Unknown | | sourceName | String | Name of the source to find | None | N/A | | ?searchOffset | Number | Number of matches to skip during search. >= 0 means first forward. -1 means last (top) item | >= -1 | 0 | @@ -4418,7 +4514,8 @@ Gets the source name of a scene item. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sceneName | String | Name of the scene the item is in | None | N/A | +| ?sceneName | String | Name of the scene the item is in | None | Unknown | +| ?sceneUuid | String | UUID of the scene the item is in | None | Unknown | | sceneItemId | Number | Numeric ID of the scene item | >= 0 | N/A | **Response Fields:** @@ -4426,6 +4523,7 @@ Gets the source name of a scene item. | Name | Type | Description | | ---- | :---: | ----------- | | sourceName | String | Name of the source associated with the scene item | +| sourceUuid | String | UUID of the source associated with the scene item | --- @@ -4443,8 +4541,10 @@ Scenes only | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sceneName | String | Name of the scene to create the new item in | None | N/A | -| sourceName | String | Name of the source to add to the scene | None | N/A | +| ?sceneName | String | Name of the scene to create the new item in | None | Unknown | +| ?sceneUuid | String | UUID of the scene to create the new item in | None | Unknown | +| ?sourceName | String | Name of the source to add to the scene | None | Unknown | +| ?sourceUuid | String | UUID of the source to add to the scene | None | Unknown | | ?sceneItemEnabled | Boolean | Enable state to apply to the scene item on creation | None | True | **Response Fields:** @@ -4469,7 +4569,8 @@ Scenes only | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sceneName | String | Name of the scene the item is in | None | N/A | +| ?sceneName | String | Name of the scene the item is in | None | Unknown | +| ?sceneUuid | String | UUID of the scene the item is in | None | Unknown | | sceneItemId | Number | Numeric ID of the scene item | >= 0 | N/A | --- @@ -4488,9 +4589,11 @@ Scenes only | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sceneName | String | Name of the scene the item is in | None | N/A | +| ?sceneName | String | Name of the scene the item is in | None | Unknown | +| ?sceneUuid | String | UUID of the scene the item is in | None | Unknown | | sceneItemId | Number | Numeric ID of the scene item | >= 0 | N/A | -| ?destinationSceneName | String | Name of the scene to create the duplicated item in | None | `sceneName` is assumed | +| ?destinationSceneName | String | Name of the scene to create the duplicated item in | None | From scene is assumed | +| ?destinationSceneUuid | String | UUID of the scene to create the duplicated item in | None | From scene is assumed | **Response Fields:** @@ -4514,7 +4617,8 @@ Scenes and Groups | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sceneName | String | Name of the scene the item is in | None | N/A | +| ?sceneName | String | Name of the scene the item is in | None | Unknown | +| ?sceneUuid | String | UUID of the scene the item is in | None | Unknown | | sceneItemId | Number | Numeric ID of the scene item | >= 0 | N/A | **Response Fields:** @@ -4537,7 +4641,8 @@ Sets the transform and crop info of a scene item. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sceneName | String | Name of the scene the item is in | None | N/A | +| ?sceneName | String | Name of the scene the item is in | None | Unknown | +| ?sceneUuid | String | UUID of the scene the item is in | None | Unknown | | sceneItemId | Number | Numeric ID of the scene item | >= 0 | N/A | | sceneItemTransform | Object | Object containing scene item transform info to update | None | N/A | @@ -4557,7 +4662,8 @@ Scenes and Groups | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sceneName | String | Name of the scene the item is in | None | N/A | +| ?sceneName | String | Name of the scene the item is in | None | Unknown | +| ?sceneUuid | String | UUID of the scene the item is in | None | Unknown | | sceneItemId | Number | Numeric ID of the scene item | >= 0 | N/A | **Response Fields:** @@ -4582,7 +4688,8 @@ Scenes and Groups | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sceneName | String | Name of the scene the item is in | None | N/A | +| ?sceneName | String | Name of the scene the item is in | None | Unknown | +| ?sceneUuid | String | UUID of the scene the item is in | None | Unknown | | sceneItemId | Number | Numeric ID of the scene item | >= 0 | N/A | | sceneItemEnabled | Boolean | New enable state of the scene item | None | N/A | @@ -4602,7 +4709,8 @@ Scenes and Groups | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sceneName | String | Name of the scene the item is in | None | N/A | +| ?sceneName | String | Name of the scene the item is in | None | Unknown | +| ?sceneUuid | String | UUID of the scene the item is in | None | Unknown | | sceneItemId | Number | Numeric ID of the scene item | >= 0 | N/A | **Response Fields:** @@ -4627,7 +4735,8 @@ Scenes and Group | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sceneName | String | Name of the scene the item is in | None | N/A | +| ?sceneName | String | Name of the scene the item is in | None | Unknown | +| ?sceneUuid | String | UUID of the scene the item is in | None | Unknown | | sceneItemId | Number | Numeric ID of the scene item | >= 0 | N/A | | sceneItemLocked | Boolean | New lock state of the scene item | None | N/A | @@ -4649,7 +4758,8 @@ Scenes and Groups | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sceneName | String | Name of the scene the item is in | None | N/A | +| ?sceneName | String | Name of the scene the item is in | None | Unknown | +| ?sceneUuid | String | UUID of the scene the item is in | None | Unknown | | sceneItemId | Number | Numeric ID of the scene item | >= 0 | N/A | **Response Fields:** @@ -4674,7 +4784,8 @@ Scenes and Groups | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sceneName | String | Name of the scene the item is in | None | N/A | +| ?sceneName | String | Name of the scene the item is in | None | Unknown | +| ?sceneUuid | String | UUID of the scene the item is in | None | Unknown | | sceneItemId | Number | Numeric ID of the scene item | >= 0 | N/A | | sceneItemIndex | Number | New index position of the scene item | >= 0 | N/A | @@ -4704,7 +4815,8 @@ Scenes and Groups | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sceneName | String | Name of the scene the item is in | None | N/A | +| ?sceneName | String | Name of the scene the item is in | None | Unknown | +| ?sceneUuid | String | UUID of the scene the item is in | None | Unknown | | sceneItemId | Number | Numeric ID of the scene item | >= 0 | N/A | **Response Fields:** @@ -4729,7 +4841,8 @@ Scenes and Groups | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sceneName | String | Name of the scene the item is in | None | N/A | +| ?sceneName | String | Name of the scene the item is in | None | Unknown | +| ?sceneUuid | String | UUID of the scene the item is in | None | Unknown | | sceneItemId | Number | Numeric ID of the scene item | >= 0 | N/A | | sceneItemBlendMode | String | New blend mode | None | N/A | @@ -5193,7 +5306,8 @@ Media States: | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| inputName | String | Name of the media input | None | N/A | +| ?inputName | String | Name of the media input | None | Unknown | +| ?inputUuid | String | UUID of the media input | None | Unknown | **Response Fields:** @@ -5219,7 +5333,8 @@ This request does not perform bounds checking of the cursor position. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| inputName | String | Name of the media input | None | N/A | +| ?inputName | String | Name of the media input | None | Unknown | +| ?inputUuid | String | UUID of the media input | None | Unknown | | mediaCursor | Number | New cursor position to set | >= 0 | N/A | --- @@ -5238,7 +5353,8 @@ This request does not perform bounds checking of the cursor position. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| inputName | String | Name of the media input | None | N/A | +| ?inputName | String | Name of the media input | None | Unknown | +| ?inputUuid | String | UUID of the media input | None | Unknown | | mediaCursorOffset | Number | Value to offset the current cursor position by | None | N/A | --- @@ -5255,7 +5371,8 @@ Triggers an action on a media input. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| inputName | String | Name of the media input | None | N/A | +| ?inputName | String | Name of the media input | None | Unknown | +| ?inputUuid | String | UUID of the media input | None | Unknown | | mediaAction | String | Identifier of the `ObsMediaInputAction` enum | None | N/A | ## Ui Requests @@ -5304,7 +5421,8 @@ Opens the properties dialog of an input. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| inputName | String | Name of the input to open the dialog of | None | N/A | +| ?inputName | String | Name of the input to open the dialog of | None | Unknown | +| ?inputUuid | String | UUID of the input to open the dialog of | None | Unknown | --- @@ -5320,7 +5438,8 @@ Opens the filters dialog of an input. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| inputName | String | Name of the input to open the dialog of | None | N/A | +| ?inputName | String | Name of the input to open the dialog of | None | Unknown | +| ?inputUuid | String | UUID of the input to open the dialog of | None | Unknown | --- @@ -5336,7 +5455,8 @@ Opens the interact dialog of an input. | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| inputName | String | Name of the input to open the dialog of | None | N/A | +| ?inputName | String | Name of the input to open the dialog of | None | Unknown | +| ?inputUuid | String | UUID of the input to open the dialog of | None | Unknown | --- @@ -5396,6 +5516,7 @@ Note: This request serves to provide feature parity with 4.x. It is very likely | Name | Type | Description | Value Restrictions | ?Default Behavior | | ---- | :---: | ----------- | :----------------: | ----------------- | -| sourceName | String | Name of the source to open a projector for | None | N/A | +| ?sourceName | String | Name of the source to open a projector for | None | Unknown | +| ?sourceUuid | String | UUID of the source to open a projector for | None | Unknown | | ?monitorIndex | Number | Monitor index, use `GetMonitorList` to obtain index | None | -1: Opens projector in windowed mode | | ?projectorGeometry | String | Size/Position data for a windowed projector, in Qt Base64 encoded format. Mutually exclusive with `monitorIndex` | None | N/A |