Method ToggleAsync
- Namespace
- OBSStudioClient.Model
- Assembly
- OBSClient.dll
ToggleAsync(CancellationToken)
Starts the output when it is not running, and stops it when it is, and returns when OBS Studio has answered.
public Task<bool> ToggleAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA token that ends the wait. A change that was not sent yet is not sent.
Returns
- Task<bool>
A task that completes with true when the output was started, and with false when it was stopped.
Remarks
OBS Studio decides by itself what to do, so two toggles that are asked for one after the other make two toggles. See SetEnabledAsync(bool, CancellationToken) for the order of changes.
Exceptions
- 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.
- ObsResponseException
OBS Studio refused the change: there is no output of this name, or it cannot be started.