Method GetCanvasList

Namespace

OBSStudioClient

Assembly

OBSClient.dll

GetCanvasList(CancellationToken)

Gets an array of canvases in OBS.

public Task<Canvas[]> GetCanvasList(CancellationToken cancellationToken = default)

Parameters

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

Array of canvases.

Remarks

Introduced in obs-websocket 5.7.0.