Method SetSourceFilterEnabled

Namespace

OBSStudioClient

Assembly

OBSClient.dll

SetSourceFilterEnabled(SourceRef, string, bool, Guid?, CancellationToken)

Sets the enable state of a source filter.

public Task SetSourceFilterEnabled(SourceRef source, string filterName, bool filterEnabled, Guid? canvasUuid = null, CancellationToken cancellationToken = default)

Parameters

source SourceRef

The source the filter is on, by name or by UUID.

filterName string

Name of the filter.

filterEnabled bool

New enable state 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