OBS MCP Server
by royshil
Verified
{
"requests": [
{
"description": "Gets an array of all inputs in OBS.",
"requestType": "GetInputList",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputKind",
"valueType": "String",
"valueDescription": "Restrict the array to only inputs of the specified kind",
"valueRestrictions": null,
"valueOptional": true,
"valueOptionalBehavior": "All kinds included"
}
],
"responseFields": [
{
"valueName": "inputs",
"valueType": "Array<Object>",
"valueDescription": "Array of inputs"
}
]
},
{
"description": "Gets an array of all available input kinds in OBS.",
"requestType": "GetInputKindList",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"requestFields": [
{
"valueName": "unversioned",
"valueType": "Boolean",
"valueDescription": "True == Return all kinds as unversioned, False == Return with version suffixes (if available)",
"valueRestrictions": null,
"valueOptional": true,
"valueOptionalBehavior": "false"
}
],
"responseFields": [
{
"valueName": "inputKinds",
"valueType": "Array<String>",
"valueDescription": "Array of input kinds"
}
]
},
{
"description": "Gets the names of all special inputs.",
"requestType": "GetSpecialInputs",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"requestFields": [],
"responseFields": [
{
"valueName": "desktop1",
"valueType": "String",
"valueDescription": "Name of the Desktop Audio input"
},
{
"valueName": "desktop2",
"valueType": "String",
"valueDescription": "Name of the Desktop Audio 2 input"
},
{
"valueName": "mic1",
"valueType": "String",
"valueDescription": "Name of the Mic/Auxiliary Audio input"
},
{
"valueName": "mic2",
"valueType": "String",
"valueDescription": "Name of the Mic/Auxiliary Audio 2 input"
},
{
"valueName": "mic3",
"valueType": "String",
"valueDescription": "Name of the Mic/Auxiliary Audio 3 input"
},
{
"valueName": "mic4",
"valueType": "String",
"valueDescription": "Name of the Mic/Auxiliary Audio 4 input"
}
]
},
{
"description": "Creates a new input, adding it as a scene item to the specified scene.",
"requestType": "CreateInput",
"complexity": 3,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"requestFields": [
{
"valueName": "sceneName",
"valueType": "String",
"valueDescription": "Name of the scene to add the input to as a scene item",
"valueRestrictions": 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",
"valueType": "String",
"valueDescription": "Name of the new input to created",
"valueRestrictions": null,
"valueOptional": false,
"valueOptionalBehavior": null
},
{
"valueName": "inputKind",
"valueType": "String",
"valueDescription": "The kind of input to be created",
"valueRestrictions": null,
"valueOptional": false,
"valueOptionalBehavior": null
},
{
"valueName": "inputSettings",
"valueType": "Object",
"valueDescription": "Settings object to initialize the input with",
"valueRestrictions": null,
"valueOptional": true,
"valueOptionalBehavior": "Default settings used"
},
{
"valueName": "sceneItemEnabled",
"valueType": "Boolean",
"valueDescription": "Whether to set the created scene item to enabled or disabled",
"valueRestrictions": null,
"valueOptional": true,
"valueOptionalBehavior": "True"
}
],
"responseFields": [
{
"valueName": "inputUuid",
"valueType": "String",
"valueDescription": "UUID of the newly created input"
},
{
"valueName": "sceneItemId",
"valueType": "Number",
"valueDescription": "ID of the newly created scene item"
}
]
},
{
"description": "Removes an existing input.\n\nNote: Will immediately remove all associated scene items.",
"requestType": "RemoveInput",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input to remove",
"valueRestrictions": null,
"valueOptional": true,
"valueOptionalBehavior": "Unknown"
},
{
"valueName": "inputUuid",
"valueType": "String",
"valueDescription": "UUID of the input to remove",
"valueRestrictions": null,
"valueOptional": true,
"valueOptionalBehavior": "Unknown"
}
],
"responseFields": []
},
{
"description": "Sets the name of an input (rename).",
"requestType": "SetInputName",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Current input name",
"valueRestrictions": null,
"valueOptional": true,
"valueOptionalBehavior": "Unknown"
},
{
"valueName": "inputUuid",
"valueType": "String",
"valueDescription": "Current input UUID",
"valueRestrictions": null,
"valueOptional": true,
"valueOptionalBehavior": "Unknown"
},
{
"valueName": "newInputName",
"valueType": "String",
"valueDescription": "New name for the input",
"valueRestrictions": null,
"valueOptional": false,
"valueOptionalBehavior": null
}
],
"responseFields": []
},
{
"description": "Gets the default settings for an input kind.",
"requestType": "GetInputDefaultSettings",
"complexity": 3,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputKind",
"valueType": "String",
"valueDescription": "Input kind to get the default settings for",
"valueRestrictions": null,
"valueOptional": false,
"valueOptionalBehavior": null
}
],
"responseFields": [
{
"valueName": "defaultInputSettings",
"valueType": "Object",
"valueDescription": "Object of default settings for the input kind"
}
]
},
{
"description": "Gets the settings of an input.\n\nNote: Does not include defaults. To create the entire settings object, overlay `inputSettings` over the `defaultInputSettings` provided by `GetInputDefaultSettings`.",
"requestType": "GetInputSettings",
"complexity": 3,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input to get the settings of",
"valueRestrictions": 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": [
{
"valueName": "inputSettings",
"valueType": "Object",
"valueDescription": "Object of settings for the input"
},
{
"valueName": "inputKind",
"valueType": "String",
"valueDescription": "The kind of the input"
}
]
},
{
"description": "Sets the settings of an input.",
"requestType": "SetInputSettings",
"complexity": 3,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input to set the settings of",
"valueRestrictions": 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",
"valueType": "Object",
"valueDescription": "Object of settings to apply",
"valueRestrictions": null,
"valueOptional": false,
"valueOptionalBehavior": null
},
{
"valueName": "overlay",
"valueType": "Boolean",
"valueDescription": "True == apply the settings on top of existing ones, False == reset the input to its defaults, then apply settings.",
"valueRestrictions": null,
"valueOptional": true,
"valueOptionalBehavior": "true"
}
],
"responseFields": []
},
{
"description": "Gets the audio mute state of an input.",
"requestType": "GetInputMute",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of input to get the mute state of",
"valueRestrictions": 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": [
{
"valueName": "inputMuted",
"valueType": "Boolean",
"valueDescription": "Whether the input is muted"
}
]
},
{
"description": "Sets the audio mute state of an input.",
"requestType": "SetInputMute",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input to set the mute state of",
"valueRestrictions": 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",
"valueType": "Boolean",
"valueDescription": "Whether to mute the input or not",
"valueRestrictions": null,
"valueOptional": false,
"valueOptionalBehavior": null
}
],
"responseFields": []
},
{
"description": "Toggles the audio mute state of an input.",
"requestType": "ToggleInputMute",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input to toggle the mute state of",
"valueRestrictions": 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": [
{
"valueName": "inputMuted",
"valueType": "Boolean",
"valueDescription": "Whether the input has been muted or unmuted"
}
]
},
{
"description": "Gets the current volume setting of an input.",
"requestType": "GetInputVolume",
"complexity": 3,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input to get the volume of",
"valueRestrictions": 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": [
{
"valueName": "inputVolumeMul",
"valueType": "Number",
"valueDescription": "Volume setting in mul"
},
{
"valueName": "inputVolumeDb",
"valueType": "Number",
"valueDescription": "Volume setting in dB"
}
]
},
{
"description": "Sets the volume setting of an input.",
"requestType": "SetInputVolume",
"complexity": 3,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input to set the volume of",
"valueRestrictions": 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",
"valueType": "Number",
"valueDescription": "Volume setting in mul",
"valueRestrictions": ">= 0, <= 20",
"valueOptional": true,
"valueOptionalBehavior": "`inputVolumeDb` should be specified"
},
{
"valueName": "inputVolumeDb",
"valueType": "Number",
"valueDescription": "Volume setting in dB",
"valueRestrictions": ">= -100, <= 26",
"valueOptional": true,
"valueOptionalBehavior": "`inputVolumeMul` should be specified"
}
],
"responseFields": []
},
{
"description": "Gets the audio balance of an input.",
"requestType": "GetInputAudioBalance",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input to get the audio balance of",
"valueRestrictions": 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": [
{
"valueName": "inputAudioBalance",
"valueType": "Number",
"valueDescription": "Audio balance value from 0.0-1.0"
}
]
},
{
"description": "Sets the audio balance of an input.",
"requestType": "SetInputAudioBalance",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input to set the audio balance of",
"valueRestrictions": 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",
"valueType": "Number",
"valueDescription": "New audio balance value",
"valueRestrictions": ">= 0.0, <= 1.0",
"valueOptional": false,
"valueOptionalBehavior": null
}
],
"responseFields": []
},
{
"description": "Gets the audio sync offset of an input.\n\nNote: The audio sync offset can be negative too!",
"requestType": "GetInputAudioSyncOffset",
"complexity": 3,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input to get the audio sync offset of",
"valueRestrictions": 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": [
{
"valueName": "inputAudioSyncOffset",
"valueType": "Number",
"valueDescription": "Audio sync offset in milliseconds"
}
]
},
{
"description": "Sets the audio sync offset of an input.",
"requestType": "SetInputAudioSyncOffset",
"complexity": 3,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input to set the audio sync offset of",
"valueRestrictions": 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",
"valueType": "Number",
"valueDescription": "New audio sync offset in milliseconds",
"valueRestrictions": ">= -950, <= 20000",
"valueOptional": false,
"valueOptionalBehavior": null
}
],
"responseFields": []
},
{
"description": "Gets the audio monitor type of an input.\n\nThe available audio monitor types are:\n\n- `OBS_MONITORING_TYPE_NONE`\n- `OBS_MONITORING_TYPE_MONITOR_ONLY`\n- `OBS_MONITORING_TYPE_MONITOR_AND_OUTPUT`",
"requestType": "GetInputAudioMonitorType",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input to get the audio monitor type of",
"valueRestrictions": 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": [
{
"valueName": "monitorType",
"valueType": "String",
"valueDescription": "Audio monitor type"
}
]
},
{
"description": "Sets the audio monitor type of an input.",
"requestType": "SetInputAudioMonitorType",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input to set the audio monitor type of",
"valueRestrictions": 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",
"valueType": "String",
"valueDescription": "Audio monitor type",
"valueRestrictions": null,
"valueOptional": false,
"valueOptionalBehavior": null
}
],
"responseFields": []
},
{
"description": "Gets the enable state of all audio tracks of an input.",
"requestType": "GetInputAudioTracks",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input",
"valueRestrictions": null,
"valueOptional": true,
"valueOptionalBehavior": "Unknown"
},
{
"valueName": "inputUuid",
"valueType": "String",
"valueDescription": "UUID of the input",
"valueRestrictions": null,
"valueOptional": true,
"valueOptionalBehavior": "Unknown"
}
],
"responseFields": [
{
"valueName": "inputAudioTracks",
"valueType": "Object",
"valueDescription": "Object of audio tracks and associated enable states"
}
]
},
{
"description": "Sets the enable state of audio tracks of an input.",
"requestType": "SetInputAudioTracks",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input",
"valueRestrictions": null,
"valueOptional": true,
"valueOptionalBehavior": "Unknown"
},
{
"valueName": "inputUuid",
"valueType": "String",
"valueDescription": "UUID of the input",
"valueRestrictions": null,
"valueOptional": true,
"valueOptionalBehavior": "Unknown"
},
{
"valueName": "inputAudioTracks",
"valueType": "Object",
"valueDescription": "Track settings to apply",
"valueRestrictions": null,
"valueOptional": false,
"valueOptionalBehavior": null
}
],
"responseFields": []
},
{
"description": "Gets the deinterlace mode of an input.\n\nDeinterlace Modes:\n\n- `OBS_DEINTERLACE_MODE_DISABLE`\n- `OBS_DEINTERLACE_MODE_DISCARD`\n- `OBS_DEINTERLACE_MODE_RETRO`\n- `OBS_DEINTERLACE_MODE_BLEND`\n- `OBS_DEINTERLACE_MODE_BLEND_2X`\n- `OBS_DEINTERLACE_MODE_LINEAR`\n- `OBS_DEINTERLACE_MODE_LINEAR_2X`\n- `OBS_DEINTERLACE_MODE_YADIF`\n- `OBS_DEINTERLACE_MODE_YADIF_2X`\n\nNote: Deinterlacing functionality is restricted to async inputs only.",
"requestType": "GetInputDeinterlaceMode",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.6.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input",
"valueRestrictions": null,
"valueOptional": true,
"valueOptionalBehavior": "Unknown"
},
{
"valueName": "inputUuid",
"valueType": "String",
"valueDescription": "UUID of the input",
"valueRestrictions": null,
"valueOptional": true,
"valueOptionalBehavior": "Unknown"
}
],
"responseFields": [
{
"valueName": "inputDeinterlaceMode",
"valueType": "String",
"valueDescription": "Deinterlace mode of the input"
}
]
},
{
"description": "Sets the deinterlace mode of an input.\n\nNote: Deinterlacing functionality is restricted to async inputs only.",
"requestType": "SetInputDeinterlaceMode",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.6.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input",
"valueRestrictions": null,
"valueOptional": true,
"valueOptionalBehavior": "Unknown"
},
{
"valueName": "inputUuid",
"valueType": "String",
"valueDescription": "UUID of the input",
"valueRestrictions": null,
"valueOptional": true,
"valueOptionalBehavior": "Unknown"
},
{
"valueName": "inputDeinterlaceMode",
"valueType": "String",
"valueDescription": "Deinterlace mode for the input",
"valueRestrictions": null,
"valueOptional": false,
"valueOptionalBehavior": null
}
],
"responseFields": []
},
{
"description": "Gets the deinterlace field order of an input.\n\nDeinterlace Field Orders:\n\n- `OBS_DEINTERLACE_FIELD_ORDER_TOP`\n- `OBS_DEINTERLACE_FIELD_ORDER_BOTTOM`\n\nNote: Deinterlacing functionality is restricted to async inputs only.",
"requestType": "GetInputDeinterlaceFieldOrder",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.6.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input",
"valueRestrictions": null,
"valueOptional": true,
"valueOptionalBehavior": "Unknown"
},
{
"valueName": "inputUuid",
"valueType": "String",
"valueDescription": "UUID of the input",
"valueRestrictions": null,
"valueOptional": true,
"valueOptionalBehavior": "Unknown"
}
],
"responseFields": [
{
"valueName": "inputDeinterlaceFieldOrder",
"valueType": "String",
"valueDescription": "Deinterlace field order of the input"
}
]
},
{
"description": "Sets the deinterlace field order of an input.\n\nNote: Deinterlacing functionality is restricted to async inputs only.",
"requestType": "SetInputDeinterlaceFieldOrder",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.6.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input",
"valueRestrictions": null,
"valueOptional": true,
"valueOptionalBehavior": "Unknown"
},
{
"valueName": "inputUuid",
"valueType": "String",
"valueDescription": "UUID of the input",
"valueRestrictions": null,
"valueOptional": true,
"valueOptionalBehavior": "Unknown"
},
{
"valueName": "inputDeinterlaceFieldOrder",
"valueType": "String",
"valueDescription": "Deinterlace field order for the input",
"valueRestrictions": null,
"valueOptional": false,
"valueOptionalBehavior": null
}
],
"responseFields": []
},
{
"description": "Gets the items of a list property from an input's properties.\n\nNote: Use this in cases where an input provides a dynamic, selectable list of items. For example, display capture, where it provides a list of available displays.",
"requestType": "GetInputPropertiesListPropertyItems",
"complexity": 4,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input",
"valueRestrictions": null,
"valueOptional": true,
"valueOptionalBehavior": "Unknown"
},
{
"valueName": "inputUuid",
"valueType": "String",
"valueDescription": "UUID of the input",
"valueRestrictions": null,
"valueOptional": true,
"valueOptionalBehavior": "Unknown"
},
{
"valueName": "propertyName",
"valueType": "String",
"valueDescription": "Name of the list property to get the items of",
"valueRestrictions": null,
"valueOptional": false,
"valueOptionalBehavior": null
}
],
"responseFields": [
{
"valueName": "propertyItems",
"valueType": "Array<Object>",
"valueDescription": "Array of items in the list property"
}
]
},
{
"description": "Presses a button in the properties of an input.\n\nSome known `propertyName` values are:\n\n- `refreshnocache` - Browser source reload button\n\nNote: Use this in cases where there is a button in the properties of an input that cannot be accessed in any other way. For example, browser sources, where there is a refresh button.",
"requestType": "PressInputPropertiesButton",
"complexity": 4,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input",
"valueRestrictions": null,
"valueOptional": true,
"valueOptionalBehavior": "Unknown"
},
{
"valueName": "inputUuid",
"valueType": "String",
"valueDescription": "UUID of the input",
"valueRestrictions": null,
"valueOptional": true,
"valueOptionalBehavior": "Unknown"
},
{
"valueName": "propertyName",
"valueType": "String",
"valueDescription": "Name of the button property to press",
"valueRestrictions": null,
"valueOptional": false,
"valueOptionalBehavior": null
}
],
"responseFields": []
}
]
}