Enum ObsCanvasFlags

Namespace

OBSStudioClient.Model

Assembly

OBSClient.dll

What a canvas of OBS Studio is, and does (Flags). They are set when the canvas is made and do not change.

[Flags]
public enum ObsCanvasFlags

Fields

None = 0

No flag.

Main = 1

The main canvas, which libobs makes itself: it can not be renamed, reset or removed. There is one, and it holds the scenes that Scenes lists.

Activate = 2

The sources of the canvas become active when they are visible.

MixAudio = 4

The audio of the sources of the canvas is mixed into the audio output of OBS Studio.

SceneRef = 8

The canvas holds a reference to each of its scenes, so that they live as long as it does.

Ephemeral = 16

The canvas is not saved with the scene collection.

Remarks

obs-websocket says them as five booleans (MAIN, ACTIVATE, MIX_AUDIO, SCENE_REF, EPHEMERAL) that are the flags of libobs; the values here are the bits of libobs, and are not part of the protocol: test for a flag with HasFlag(Enum).