Class ObsSceneItems
- Namespace
- OBSStudioClient.Model
- Assembly
- OBSClient.dll
The scene items of a scene, from the bottom (index 0) to the top, which can be found by the name of their source.
public sealed class ObsSceneItems : IReadOnlyList<ObsSceneItem>, IReadOnlyCollection<ObsSceneItem>, IEnumerable<ObsSceneItem>, IEnumerable- Inheritance
-
ObsSceneItems
- Implements
- Inherited Members
Remarks
A scene item is looked up by the name of the source that it shows. The same source can be in a scene more than once, so a name can match more than one scene item: the indexer then throws an ObsAmbiguousNameException that lists them, and FindAll(string) returns all of them. Use ById(int) to find one scene item by its id.
The collection is a snapshot of which scene items there are, and in which order: it is safe to use from any thread; ask the scene for its items again to see what changed. The names are looked up as the sources have them now.
Properties
- Count
Gets the number of scene items.
- this[int]
Gets the scene item at a position in this collection, which is its Index once the model is up to date: 0 is the bottom.
- this[string]
Gets the scene item whose source has a name.
Methods
- ById(int)
Gets the scene item with an id.
- FindAll(string)
Gets all scene items whose source has a name, from the bottom to the top.
- GetEnumerator()
Returns an enumerator that iterates through the collection.
- TryGet(string, out ObsSceneItem)
Gets the scene item whose source has a name, if there is exactly one.