Method StopAsync
- Namespace
- OBSStudioClient.Model
- Assembly
- OBSClient.dll
StopAsync(CancellationToken)
Stops the output, and returns when OBS Studio has begun to stop it.
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 the model has seen the output stop (Status is Stopping or Stopped), or when the model has been read again after the events did not show it.
Remarks
Stopping an output can take a moment too (a stream sends what is buffered): the call returns when OBS Studio has begun, and Status is Stopped when it is done. See SetEnabledAsync(bool, CancellationToken) for the order of changes and the wait.
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.
- ObsNotConfirmedException
OBS Studio made the change, and the model does not show it. Do not send the change again.
- ObsResponseException
OBS Studio refused the change: the output is not running.