Method StopAsync
- Namespace
- OBSStudioClient.Model
- Assembly
- OBSClient.dll
StopAsync(CancellationToken)
Stops the output, and returns when OBS Studio has answered.
public Task StopAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA token that ends the wait. A change that was not sent yet is not sent.
Returns
- Task
A task that completes when OBS Studio has answered: the output is stopping, which can take a moment.
Remarks
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 does not run.