Class ObsCanvases
- Namespace
- OBSStudioClient.Model
- Assembly
- OBSClient.dll
The canvases of OBS Studio: the main canvas, and the ones that plugins made (or that a scene collection saved).
public sealed class ObsCanvases : INotifyPropertyChanged- Inheritance
-
ObsCanvases
- Implements
- Inherited Members
Remarks
It is the same object for as long as the ObsModel lives (Canvases), and says with INotifyPropertyChanged when All and Main change: when a canvas is made or removed, or renamed (OBS Studio says so with an event for each), and when OBS Studio changes its scene collection (a scene collection saves its canvases, so the list is read again with the rest). The canvases are ObsCanvas snapshots: the list is another one when anything about the canvases changed, and a canvas that was renamed is a new object with the same Uuid.
The list is empty until OBS Studio has said, and for an OBS Studio whose obs-websocket does not know canvases (before 5.7.0, see WebSocketVersion).
Properties
- All
Gets the canvases, in the order in which OBS Studio lists them. It is another list when the canvases change, and it is empty until OBS Studio has said.
- this[Guid]
Gets the canvas with a UUID.
- this[string]
Gets the canvas with a name.
- Main
Gets the main canvas, or null until OBS Studio has said (and for an OBS Studio that does not know canvases).
Methods
- TryGet(Guid, out ObsCanvas)
Gets the canvas with a UUID, if there is one.
- TryGet(string, out ObsCanvas)
Gets the canvas with a name, if there is one.
Events
- PropertyChanged
Occurs when a property value changes.