Table of Contents

Method GetInputKindsAsync

Namespace
OBSStudioClient.Model
Assembly
OBSClient.dll

GetInputKindsAsync(bool, CancellationToken)

Asks OBS Studio for the kinds of inputs that it can make (and that its plugins add): color_source_v3, wasapi_input_capture, browser_source, and so on.

public Task<IReadOnlyList<string>> GetInputKindsAsync(bool unversioned = false, CancellationToken cancellationToken = default)

Parameters

unversioned bool

True for the kinds without their version (color_source), false for the kinds with it (color_source_v3), as Kind says them.

cancellationToken CancellationToken

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

Returns

Task<IReadOnlyList<string>>

The kinds.

Remarks

The kinds that a computer has depend on its operating system and on what is installed: a kind that is not in the list can not be made there (CreateInputAsync(string, string, object?, bool, CancellationToken) ends with a refusal). 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).