Table of Contents

Method GetSourceFilter

Namespace
OBSStudioClient
Assembly
OBSClient.dll

GetSourceFilter(SourceRef, string, Guid?, CancellationToken)

Gets the info for a specific source filter.

public Task<SourceFilterResponse> GetSourceFilter(SourceRef source, string filterName, Guid? canvasUuid = null, CancellationToken cancellationToken = default)

Parameters

source SourceRef

The source, by name or by UUID.

filterName string

Name of the filter.

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<SourceFilterResponse>

A SourceFilterResponse with the response data.