Table of Contents

Method GetBlendModeAsync

Namespace
OBSStudioClient.Model
Assembly
OBSClient.dll

GetBlendModeAsync(CancellationToken)

Asks OBS Studio how the scene item is blended with what is behind it.

public Task<BlendMode> GetBlendModeAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token that ends the wait. A request that was not sent yet is not sent.

Returns

Task<BlendMode>

The blend mode at the moment that OBS Studio answered.

Remarks

OBS Studio does not announce a change of the blend mode, so the model does not keep it: ask when you need it. (A change of it makes OBS Studio send the transform of the item again, which is no change of the transform: Transform does not change.) See SetEnabledAsync(bool, CancellationToken) for the order of changes.

Exceptions

ObsRemovedException

The scene item, or its scene, was removed.

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.