Table of Contents

Method GetAllAsync

Namespace
OBSStudioClient.Model
Assembly
OBSClient.dll

GetAllAsync(CancellationToken)

Asks OBS Studio for its scene transitions.

public Task<IReadOnlyList<ObsTransition>> GetAllAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

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

Returns

Task<IReadOnlyList<ObsTransition>>

The transitions, as OBS Studio lists them, at the moment that it answered.

Remarks

OBS Studio has a cut and a fade to begin with, and the user can add more in its window (a swipe, a slide, a stinger, a fade to a color, a luma wipe). The list is not kept in the model, because OBS Studio does not announce a change of it; Current is. The request is made in its turn, after the changes that were asked for before it (see SetEnabledAsync(bool, CancellationToken)).

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