Table of Contents

Method GetSceneItemList

Namespace
OBSStudioClient
Assembly
OBSClient.dll

GetSceneItemList(SceneRef, Guid?, CancellationToken)

Gets a list of all scene items in a scene.

public Task<SceneItem[]> GetSceneItemList(SceneRef scene, Guid? canvasUuid = null, CancellationToken cancellationToken = default)

Parameters

scene SceneRef

The scene to get the items of, by name or by UUID.

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<SceneItem[]>

Array of scene items in the scene.

Remarks

Scenes only.