Method SetLockedAsync

Namespace

OBSStudioClient.Model

Assembly

OBSClient.dll

SetLockedAsync(bool, CancellationToken)

Locks or unlocks the scene item, and returns when the model shows it.

public Task SetLockedAsync(bool value, CancellationToken cancellationToken = default)

Parameters

value bool

True to lock the item, false to unlock it.

cancellationToken CancellationToken

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

Returns

Task

A task that completes when IsLocked is value.

Remarks

See SetEnabledAsync(bool, CancellationToken) for the order of changes and the wait.

Exceptions

ObsRemovedException

The scene item, or its scene, was removed.

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.

ObsNotConfirmedException

OBS Studio made the change, and the model does not show it: the events did not show it in time, and the model could not be read again in time. Do not send the change again.

ObsResponseException

OBS Studio refused the change.