Method PauseAsync
- Namespace
- OBSStudioClient.Model
- Assembly
- OBSClient.dll
PauseAsync(CancellationToken)
Pauses the media, and returns when the model shows that it is paused.
public Task PauseAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA token that ends the wait. A change that was not sent yet is not sent.
Returns
Remarks
OBS Studio pauses a media that was stopped as well: it opens it and holds it at the beginning.
Exceptions
- 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.