Method SetSourceFilterName

Namespace

OBSStudioClient

Assembly

OBSClient.dll

SetSourceFilterName(SourceRef, string, string, Guid?, CancellationToken)

Sets the name of a source filter (rename).

public Task SetSourceFilterName(SourceRef source, string filterName, string newFilterName, Guid? canvasUuid = null, CancellationToken cancellationToken = default)

Parameters

source SourceRef

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

filterName string

Current name of the filter.

newFilterName string

New name for 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