Table of Contents

Method GetSourceActive

Namespace
OBSStudioClient
Assembly
OBSClient.dll

GetSourceActive(SourceRef, Guid?, CancellationToken)

Gets the active and show state of a source.

public Task<SourceActiveResponse> GetSourceActive(SourceRef source, Guid? canvasUuid = null, CancellationToken cancellationToken = default)

Parameters

source SourceRef

The source to get the active state of, by name or by UUID.

canvasUuid Guid?

UUID of the canvas the source is in, if the source 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<SourceActiveResponse>

A SourceActiveResponse with the response data.

Remarks

**Compatible with inputs and scenes.**.