Method OpenInteractDialogAsync
- Namespace
- OBSStudioClient.Model
- Assembly
- OBSClient.dll
OpenInteractDialogAsync(CancellationToken)
Opens the window in which a person can use the input as if it was on the screen (a browser source: click, type, scroll), and returns when OBS Studio has answered.
public Task OpenInteractDialogAsync(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
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: the input does not support interaction (ErrorCode is InvalidResourceState).