Method GetDefaultInputSettingsAsync
- Namespace
- OBSStudioClient.Model
- Assembly
- OBSClient.dll
GetDefaultInputSettingsAsync(string, CancellationToken)
Asks OBS Studio for the settings that an input of a kind has until they are changed.
public Task<JsonElement> GetDefaultInputSettingsAsync(string kind, CancellationToken cancellationToken = default)Parameters
kindstringThe kind, as GetInputKindsAsync(bool, CancellationToken) says it (with its version).
cancellationTokenCancellationTokenA token that ends the wait. A request that was not sent yet is not sent.
Returns
- Task<JsonElement>
The default settings, as a JSON object.
Remarks
Settings has the settings that were set, and not the defaults: lay the settings over the defaults for the whole picture. The request is made in its turn, after the changes that were asked for before it (see SetEnabledAsync(bool, CancellationToken)).
Exceptions
- ArgumentException
kindis empty.- ObsNotConnectedException
There is no connection to OBS Studio.
- ObsNotReadyException
OBS Studio is changing its scene collection, or did so after the call.
- TimeoutException
OBS Studio did not answer in time (WriteTimeout).
- ObsResponseException
OBS Studio refused the request: it does not have that kind (ErrorCode is InvalidInputKind).