Class ObsNamedCollection<T>

Namespace

OBSStudioClient.Model

Assembly

OBSClient.dll

The scenes or the inputs of OBS Studio, which can be found by name.

public sealed class ObsNamedCollection<T> : IReadOnlyList<T>, IReadOnlyCollection<T>, IEnumerable<T>, IEnumerable where T : ObsSource

Type Parameters

T

The type of the objects: ObsScene or ObsInput.

Inheritance

object

ObsNamedCollection<T>

Implements

IReadOnlyList<T>

IReadOnlyCollection<T>

IEnumerable<T>

IEnumerable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

A collection is a snapshot of which objects there are, and in which order: it does not change while you look at it, and it is safe to use from any thread. Ask the ObsModel for the collection again to see what changed (or react to Changed).

A name is looked up exactly, and case-sensitively, as OBS Studio does, against the names that the objects have now. With IgnoreCase a name that differs only by case also matches, when there is no exact match and that leaves one object.

Properties

Count

Gets the number of objects.

this[Guid]

Gets the object with a UUID.

this[int]

Gets the object at a position. For scenes, that is their position in the list of scenes of OBS Studio.

this[string]

Gets the object with a name.

Methods

Contains(string)

Gets whether there is an object with a name.

Find(string)

Gets the object with a name, or null.

FindAll(string)

Gets all objects with a name. Without IgnoreCase that is none or one.

GetEnumerator()

Returns an enumerator that iterates through the collection.

TryGet(Guid, out T)

Gets the object with a UUID, if there is one.

TryGet(string, out T)

Gets the object with a name, if there is one.