Class ObsSceneCollections
- Namespace
- OBSStudioClient.Model
- Assembly
- OBSClient.dll
The scene collections of OBS Studio: which one is loaded, the names of all, and the calls that load one and make one.
public sealed class ObsSceneCollections : INotifyPropertyChanged- Inheritance
-
ObsSceneCollections
- Implements
- Inherited Members
Remarks
It is the same object for as long as the ObsModel lives (SceneCollections), and says with INotifyPropertyChanged when Current and Names change, also when the user (or another program) changes them in OBS Studio. A scene collection holds the scenes, the inputs and the scene transitions: what Scenes and Inputs show is the collection that is loaded. When OBS Studio loads another one the model reads everything again (State is Synchronizing meanwhile), and the scenes, inputs and scene items that the application holds are those of the collection that is gone: they say so (State). OBS Studio has no request that removes or renames a scene collection.
What OBS Studio does (measured with OBS Studio 33.0.0): it answers a request to load a collection when the collection is loaded, and sends the events that say so at about the same moment, which can be a little after the answer. A collection that is made is loaded at once, and has one scene, named "Scene". Nothing happens when the collection that is asked for is the loaded one already.
Properties
- Current
Gets the name of the scene collection that is loaded. It is null until OBS Studio has said.
- Names
Gets the names of the scene collections, in the order in which OBS Studio lists them. The list is empty until OBS Studio has said, and it is another list when the collections change.
Methods
- CreateAsync(string, CancellationToken)
Makes a scene collection, which OBS Studio loads at once, and returns when the model shows it completely.
- SetCurrentAsync(string, CancellationToken)
Makes OBS Studio load a scene collection, and returns when the model shows it completely.
Events
- PropertyChanged
Occurs when a property value changes.