Method SetSourceFilterIndex

Namespace

OBSStudioClient

Assembly

OBSClient.dll

SetSourceFilterIndex(SourceRef, string, int, Guid?, CancellationToken)

Sets the index position of a filter on a source.

public Task SetSourceFilterIndex(SourceRef source, string filterName, int filterIndex, 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.

filterIndex int

New index position of the filter. Restrictions: >= 0.

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