Method GetCurrentPreviewScene

Namespace

OBSStudioClient

Assembly

OBSClient.dll

GetCurrentPreviewScene(CancellationToken)

Gets the current preview scene.

public Task<CurrentPreviewSceneNameResponse> GetCurrentPreviewScene(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<CurrentPreviewSceneNameResponse>

A CurrentPreviewSceneNameResponse with the response data.

Remarks

Only available when studio mode is enabled.

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