Table of Contents

Method GetProgressAsync

Namespace
OBSStudioClient.Model
Assembly
OBSClient.dll

GetProgressAsync(CancellationToken)

Asks OBS Studio how far the transition that runs has come.

public Task<double> GetProgressAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token that ends the wait. A request that was not sent yet is not sent.

Returns

Task<double>

The position of the transition, from 0.0 to 1.0: 1.0 when none runs.

Remarks

The position moves all the time, and OBS Studio sends no event for it, so it is not kept in the model; IsRunning is.

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).