Property Settings
- Namespace
- OBSStudioClient.Model
- Assembly
- OBSClient.dll
Settings
Gets the settings of the input: a JSON object with the values that were set, as OBS Studio says them ({"text":"Hello","font":{"face":"Arial","size":48}} for a text input).
public JsonElement Settings { get; }Property Value
Remarks
OBS Studio says the settings that were set, and leaves out the ones that still have the default of the input kind: ask GetDefaultInputSettingsAsync(string, CancellationToken) for the defaults of a kind, and lay the settings over them for the whole picture. What a setting is called, and what it means, depends on the kind of the input, and is not written down anywhere but in the source of OBS Studio and its plugins: the properties window of the input is the place to look (or GetPropertyItemsAsync(string, CancellationToken) for the choices of a list).
The value is current: OBS Studio announces every change of the settings (the property changes when a person changes the input, or a request, a script or the input itself does). It is a snapshot: a change makes a new element, and an element that you hold does not change. An input that has no settings set has an empty object. Change the settings with SetSettingsAsync(object, bool, CancellationToken).