Scene
To create an empty scene, first declare it with and give it a name:
const someScene = new Scene({
name: "Scene Name", // Name of the scene in OBS
// Must be unique among all sources and scenes
});
Then, call create() and provide an instance of OBS the scene should be created in:
await someScene.create(obs);
Items​
Scenes accept an items property, which is a map that describes how each of the scene's items should be created.
The keys of this map are what Sceneify calls refs, and are used to uniquely identify each item of a scene.
The values of this map are scene item schemas, which specify the properties that the items should be created with, as well as the source they are instances of. The source does not have to exist in OBS, nor does it even have to be initialized. This will all be done by the scene when it is created.
new Scene({
items: {
// someItem will be the ref of this item
someItem: {
source: someSource, // The item's source must be provided.
// Specify transform fields, enabled etc...
scaleX: 1,
enabled: true,
},
},
name: "Scene Name",
});
After the scene is created, its items array will be populated with all of its items, and each item can be accessed by ref using item().
Properties​
As scenes are also sources, they share many similar properties as Inputs: