Skip to content

SceneInfo

Property Type Description
id string Scene Id.
This is set by the API and is ignored when specified by the caller.
The value is not globally unique and may change between OBS sessions.
videoCompositionId string Optional. Specifies which video composition the scene belongs to.
API 6.0+
name string Scene name, as seen in the “Scenes” OBS widget.
icon IconInfo Optional. Icon to display next to scene name.
API 1.24+
Removed in API 4.0+
active bool Optional. Specifies whether this Scene is currently the active scene in OBS.
When creating scenes, this property specifies whether the new scene will become the active scene.
Default value: true
API 1.26+
defaultAction ActionInfo Default action associated with this Scene to invoke when user double-clicks with their mouse on the scene item.
API 1.24+
Removed in API 4.0+
contextMenu MenuItemInfo[] Context menu associated with this Scene to invoke when user right-clicks with their mouse on the scene item.
API 1.24+
Removed in API 4.0+
auxiliaryData any Optional. Auxiliary application data to associate with this Scene.
API 1.24+