Table of Contents

Method GetTransitionOverrideAsync

Namespace
OBSStudioClient.Model
Assembly
OBSClient.dll

GetTransitionOverrideAsync(CancellationToken)

Asks OBS Studio which transition, and how long, the scene brings with it.

public Task<ObsTransitionOverride> GetTransitionOverrideAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

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

Returns

Task<ObsTransitionOverride>

The override of the scene: IsSet is false when the scene has none.

Remarks

When OBS Studio switches to a scene that has an override it uses that transition and duration instead of the current ones (Current, which does not change for it). OBS Studio does not announce a change of an override, so it is not kept in the model: this asks. The request is made in its turn, after the changes that were asked for before it.

Exceptions

ObsRemovedException

The scene was destroyed.

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