Method GetCurrentProgramScene

Namespace

OBSStudioClient

Assembly

OBSClient.dll

GetCurrentProgramScene(CancellationToken)

Gets the current program scene.

public Task<CurrentProgramSceneNameResponse> GetCurrentProgramScene(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<CurrentProgramSceneNameResponse>

A CurrentProgramSceneNameResponse with the response data.

Remarks

Note 1: This request is slated to have the currentProgram-prefixed fields removed from in an upcoming RPC version.

Note 2: Canvases do not have any concept of a program or preview scene, so this request does not support canvases.