Class ObsCanvas
- Namespace
- OBSStudioClient.Model
- Assembly
- OBSClient.dll
A canvas of OBS Studio: a surface that scenes are drawn on, with a video of its own. OBS Studio has a main canvas, and a plugin (or a scene collection that a plugin saved) can make more.
public sealed class ObsCanvas- Inheritance
-
ObsCanvas
- Inherited Members
Remarks
An ObsCanvas is a snapshot, like ObsTransition: it does not change, and All holds another object for a canvas that was renamed (the one from before is of the same canvas still). A snapshot is of the scene collection that was loaded when the model made it: once OBS Studio has loaded another collection (or loaded the same one again) the canvas that it is of is gone, also when the collection that is loaded now has a canvas with the same Uuid (the main canvas has the same in every collection), and GetVideoSettingsAsync(CancellationToken) says so. What the model keeps of a canvas is what OBS Studio announces: its name, its UUID (which never changes) and its flags (which are set when it is made). Its video settings are not announced, so they are asked for when you need them (GetVideoSettingsAsync(CancellationToken)).
The model holds the scenes of the main canvas (Scenes). The scenes of the other canvases are not in the model yet: ask for them with the plain client
(obs.Client.GetSceneList(canvas.Uuid)).
Properties
- Flags
Gets what the canvas is, and does.
- IsMain
Gets whether this is the main canvas.
- Name
Gets the name of the canvas. The main canvas is called
Main(it can not be renamed).
- Uuid
Gets the UUID of the canvas, which stays the same for as long as the canvas lives. The UUID of the main canvas is the same in every OBS Studio.
Methods
- GetVideoSettingsAsync(CancellationToken)
Asks OBS Studio for the video settings of the canvas: its base resolution, its output resolution and its frame rate.
- ToString()
Returns a string that represents the current object.