Method SetSourceFilterSettings

Namespace

OBSStudioClient

Assembly

OBSClient.dll

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

Sets the settings of a source filter.

public Task SetSourceFilterSettings(SourceRef source, string filterName, Dictionary<string, object> filterSettings, bool? overlay = null, 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 to set the settings of.

filterSettings Dictionary<string, object>

Object of settings to apply.

overlay bool?

True == apply the settings on top of existing ones, False == reset the input to its defaults, then apply settings. If omitted: true.

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