Method GetDefaultFilterSettingsAsync
- Namespace
- OBSStudioClient.Model
- Assembly
- OBSClient.dll
GetDefaultFilterSettingsAsync(string, CancellationToken)
Asks OBS Studio for the settings that a filter of a kind has until they are changed.
public Task<JsonElement> GetDefaultFilterSettingsAsync(string kind, CancellationToken cancellationToken = default)Parameters
kindstringThe kind, as GetFilterKindsAsync(CancellationToken) says it.
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
OBS Studio says the settings of a filter that were set, and leaves out the defaults: lay them over these for the whole picture (GetSettingsAsync(CancellationToken) asks for the settings that a filter has). See GetDefaultInputSettingsAsync(string, CancellationToken) for the same for inputs.
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 InvalidFilterKind).