Method GetSceneItemLocked

Namespace

OBSStudioClient

Assembly

OBSClient.dll

GetSceneItemLocked(SceneRef, int, Guid?, CancellationToken)

Gets the lock state of a scene item.

public Task<bool> GetSceneItemLocked(SceneRef scene, int sceneItemId, Guid? canvasUuid = null, CancellationToken cancellationToken = default)

Parameters

scene SceneRef

The scene the item is in, by name or by UUID.

sceneItemId int

Numeric ID of the scene item. Restrictions: >= 0.

canvasUuid Guid?

UUID of the canvas the scene is in, if the scene is given by name.

cancellationToken CancellationToken

A token that ends the wait for the response, which makes the method throw an OperationCanceledException. A request that was already sent is not undone: OBS Studio may still carry it out.

Returns

Task<bool>

Whether the scene item is locked. true for locked, false for unlocked.

Remarks

Scenes and Groups.