Table of Contents

Method GetKindsAsync

Namespace
OBSStudioClient.Model
Assembly
OBSClient.dll

GetKindsAsync(CancellationToken)

Asks OBS Studio for the kinds of transition that it has.

public Task<IReadOnlyList<string>> GetKindsAsync(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<string>>

The kinds (cut_transition, fade_transition, ...).

Remarks

obs-websocket can not make a transition: the kinds say what the user can add in OBS Studio. The request is made in its turn, after the changes that were asked for before it.

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