Method GetFilterKindsAsync
- Namespace
- OBSStudioClient.Model
- Assembly
- OBSClient.dll
GetFilterKindsAsync(CancellationToken)
Asks OBS Studio for the kinds of filters that it can make (and that its plugins add): color_filter_v2, noise_gate_filter, chroma_key_filter_v2, and so on.
public Task<IReadOnlyList<string>> GetFilterKindsAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA token that ends the wait. A request that was not sent yet is not sent.
Returns
- Task<IReadOnlyList<string>>
The kinds, as Kind says them.
Remarks
A kind of filter works on video, on audio, or on both: a kind that is not for the source that you give it is refused (CreateFilterAsync(string, string, object?, CancellationToken)). 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).
- ObsResponseException
OBS Studio refused the request: its obs-websocket is older than 5.4.0.