Table of Contents

Method SetVolumeDbAsync

Namespace
OBSStudioClient.Model
Assembly
OBSClient.dll

SetVolumeDbAsync(double, CancellationToken)

Sets the volume of the input in decibels, and returns when the model shows it.

public Task SetVolumeDbAsync(double decibels, CancellationToken cancellationToken = default)

Parameters

decibels double

The volume: from -100 dB (silent) to 26 dB. 0 dB is the volume of the source.

cancellationToken CancellationToken

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

Returns

Task

A task that completes when VolumeDb is decibels (within the precision of OBS Studio).

Remarks

See SetEnabledAsync(bool, CancellationToken) for the order of changes and the wait.

Exceptions

ArgumentOutOfRangeException

decibels is not from -100 to 26.

InvalidOperationException

The input has no audio (HasAudio).

ObsRemovedException

The input was removed.

ObsNotConnectedException

There is no connection to OBS Studio. Nothing was changed.

ObsNotReadyException

OBS Studio is changing its scene collection, or did so after the call. Nothing was changed.

ObsUnknownOutcomeException

OBS Studio did not answer in time, or the connection ended: it is not known whether it made the change.

ObsNotConfirmedException

OBS Studio made the change, and the model does not show it: the events did not show it in time, and the model could not be read again in time. Do not send the change again.

ObsResponseException

OBS Studio refused the change.