Method OpenFiltersDialogAsync
- Namespace
- OBSStudioClient.Model
- Assembly
- OBSClient.dll
OpenFiltersDialogAsync(CancellationToken)
Opens the window with the filters of the input in OBS Studio, and returns when OBS Studio has answered.
public Task OpenFiltersDialogAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA token that ends the wait. A change that was not sent yet is not sent.
Returns
- Task
A task that completes when OBS Studio has opened the window. It does not wait for the window to be closed again.
Remarks
obs-websocket opens this window for inputs only, so a scene has no such method. See OpenPropertiesDialogAsync(CancellationToken) for what to know about the windows of OBS Studio.
Exceptions
- ObsRemovedException
The input was destroyed.
- ObsNotConnectedException
There is no connection to OBS Studio. Nothing was changed.
- ObsNotReadyException
OBS Studio is changing its scene collection, or did so after the call. Nothing was changed.
- ObsUnknownOutcomeException
OBS Studio did not answer in time, or the connection ended: it is not known whether it opened the window.
- ObsResponseException
OBS Studio refused the request.