Method CreateSourceFilter

Namespace

OBSStudioClient

Assembly

OBSClient.dll

CreateSourceFilter(SourceRef, string, string, Dictionary<string, object>?, Guid?, CancellationToken)

Creates a new filter, adding it to the specified source.

public Task CreateSourceFilter(SourceRef source, string filterName, string filterKind, Dictionary<string, object>? filterSettings = null, Guid? canvasUuid = null, CancellationToken cancellationToken = default)

Parameters

source SourceRef

The source to add the filter to, by name or by UUID.

filterName string

Name of the new filter to be created.

filterKind string

The kind of filter to be created.

filterSettings Dictionary<string, object>

Settings object to initialize the filter with. If omitted: Default settings used.

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