Table of Contents

Class ObsFilters

Namespace
OBSStudioClient.Model
Assembly
OBSClient.dll

The filters of a scene or an input, from the first (index 0) to the last, which can be found by name.

public sealed class ObsFilters : IReadOnlyList<ObsFilter>, IReadOnlyCollection<ObsFilter>, IEnumerable<ObsFilter>, IEnumerable
Inheritance
ObsFilters
Implements
Inherited Members

Remarks

The name of a filter is unique within its source, so a name finds one filter. With IgnoreCase a name that differs only by case matches too, when there is no exact match: two filters that match then are an ObsAmbiguousNameException.

The collection is a snapshot of which filters there are, and in which order: it is safe to use from any thread; ask the source for its filters again to see what changed. The names are looked up as the filters have them now.

Properties

Count

Gets the number of filters.

this[int]

Gets the filter at a position in this collection, which is its Index once the model is up to date: 0 is the first.

this[string]

Gets the filter with a name.

Methods

Contains(string)

Gets whether there is a filter with a name.

Find(string)

Gets the filter with a name, or null when there is none.

GetEnumerator()

Returns an enumerator that iterates through the collection.

TryGet(string, out ObsFilter)

Gets the filter with a name, if there is exactly one.