Table of Contents

Method GetSettingsAsync

Namespace
OBSStudioClient.Model
Assembly
OBSClient.dll

GetSettingsAsync(CancellationToken)

Asks OBS Studio for the settings of the current transition.

public Task<JsonElement> GetSettingsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token that ends the wait. A request that was not sent yet is not sent.

Returns

Task<JsonElement>

The settings, as a JSON object: empty for a transition that has none (see IsConfigurable).

Remarks

OBS Studio does not announce a change of the settings, so they are not kept in the model: this asks. What the fields are called depends on the kind of the transition.

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).