Method SetAudioBalanceAsync
- Namespace
- OBSStudioClient.Model
- Assembly
- OBSClient.dll
SetAudioBalanceAsync(float, CancellationToken)
Sets the balance of the audio of the input between the left and the right, and returns when the model shows it.
public Task SetAudioBalanceAsync(float balance, CancellationToken cancellationToken = default)Parameters
balancefloatThe balance: from 0 (all on the left) to 1 (all on the right). 0.5 is the middle.
cancellationTokenCancellationTokenA token that ends the wait. A change that was not sent yet is not sent.
Returns
- Task
A task that completes when AudioBalance is
balance.
Remarks
See SetEnabledAsync(bool, CancellationToken) for the order of changes and the wait.
Exceptions
- ArgumentOutOfRangeException
balanceis not from 0 to 1.- 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.