Method GetSettingsAsync
- Namespace
- OBSStudioClient.Model
- Assembly
- OBSClient.dll
GetSettingsAsync(CancellationToken)
Asks OBS Studio for the settings of the output.
public Task<JsonElement> GetSettingsAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA token that ends the wait. A request that was not sent yet is not sent.
Returns
- Task<JsonElement>
The settings, as a JSON object: the fields that the kind of output has.
Remarks
The settings of the outputs of OBS Studio itself are those of its output mode (simple or advanced); what a field means is up to the output. The value is a snapshot of the moment that OBS Studio answered.
Exceptions
- 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: there is no output of this name.