Method ToggleMuteAsync
- Namespace
- OBSStudioClient.Model
- Assembly
- OBSClient.dll
ToggleMuteAsync(CancellationToken)
Mutes the input when it is not muted, and unmutes it when it is, and returns when the model shows it.
public Task<bool> ToggleMuteAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA token that ends the wait. A change that was not sent yet is not sent.
Returns
Remarks
OBS Studio toggles the state by itself, so two toggles that are asked for one after the other make two toggles, whatever the model shows meanwhile. See SetEnabledAsync(bool, CancellationToken) for the order of changes and the wait.
Exceptions
- 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.