Method GetStatusAsync
- Namespace
- OBSStudioClient.Model
- Assembly
- OBSClient.dll
GetStatusAsync(CancellationToken)
Asks OBS Studio what the output does: whether it runs, and how long, how many bytes it has sent, how many frames it has dropped.
public Task<OutputStatusResponse> GetStatusAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA token that ends the wait. A request that was not sent yet is not sent.
Returns
- Task<OutputStatusResponse>
The status at the moment that OBS Studio answered.
Remarks
The figures change all the time, and OBS Studio sends no event for them: ask when you need them.
Exceptions
- ObsNotConnectedException
There is no connection to OBS Studio.
- ObsNotReadyException
OBS Studio is changing its scene collection, or did so after the call.
- TimeoutException
OBS Studio did not answer in time (WriteTimeout).
- ObsResponseException
OBS Studio refused the request: there is no output of this name.