Required Permissions: slobs.scene-collections

This module can be used to fetch a full schema of all scene collections for the streamer. This is useful for getting a big picture of all scenes and sources across all scene collections.

Minimum Version

This was module was added in Build 3 of the Streamlabs Desktop App Developer build.

getSceneCollectionsSchema `method`

This method returns a full schema of all scene collections. This is an expensive method and should not be called frequently.

Arguments

None

Returns

An array of scene collection schemas.

Example

streamlabsOBS.v1.SceneCollections.getSceneCollectionsSchema().then(schema => {
  console.log(schema);
});

Scene Collection Schema

interface ISceneCollectionSchema {
  name: string;
  id: string;

  scenes: {
    id: string;
    name: string;
    sceneItems: {
      sceneItemId: string,
      sourceId: string
    }[]
  }[];

  sources: {
    sourceId: string;
    name: string;
    type: string;
    channel: number;
  }[];
}