Method SetDeinterlaceModeAsync
- Namespace
- OBSStudioClient.Model
- Assembly
- OBSClient.dll
SetDeinterlaceModeAsync(ObsDeinterlaceMode, CancellationToken)
Sets how the video of the input is deinterlaced, and returns when OBS Studio has answered.
public Task SetDeinterlaceModeAsync(ObsDeinterlaceMode mode, CancellationToken cancellationToken = default)Parameters
modeObsDeinterlaceModeThe mode.
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 answered.
Remarks
See GetDeinterlaceModeAsync(CancellationToken) for what to know about the deinterlacing, and SetEnabledAsync(bool, CancellationToken) for the order of changes.
Exceptions
- ArgumentOutOfRangeException
modeis not a value of ObsDeinterlaceMode.- 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 made the change.
- ObsResponseException
OBS Studio refused the change: the input is not an async input (ErrorCode is InvalidResourceState), or its obs-websocket is older than 5.6.0.