Method OpenPropertiesDialogAsync
- Namespace
- OBSStudioClient.Model
- Assembly
- OBSClient.dll
OpenPropertiesDialogAsync(CancellationToken)
Opens the window with the properties of the input in OBS Studio, and returns when OBS Studio has answered.
public Task OpenPropertiesDialogAsync(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
The window opens on the computer that OBS Studio runs on, for the person at that computer. What is changed in it reaches the model through the events, like any other change. The call changes nothing in the model, so it does not wait for it. See SetEnabledAsync(bool, CancellationToken) for the order of changes.
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.