Hierarchy

  • Scene

Implements

Index

Constructors

constructor

  • new Scene(sceneId: string): Scene

Properties

id

id: string

name

name: string

nodes

resourceId

resourceId: string

Accessors

items

Methods

addSource

addSources

canAddSource

  • canAddSource(sourceId: string): boolean

createAndAddSource

createFolder

getFolder

getFolders

getItem

getItems

getModel

getNestedItems

  • getNestedItems(options?: object): SceneItem[]
  • returns scene items of scene + scene items of nested scenes

    Parameters

    • Default value options: object = { excludeScenes: false }
      • excludeScenes: boolean

    Returns SceneItem[]

getNestedSources

  • getNestedSources(options?: object): Source[]
  • returns sources of scene + sources of nested scenes result also includes nested scenes

    Parameters

    • Default value options: object = { excludeScenes: false }
      • excludeScenes: boolean

    Returns Source[]

getNode

getNodeByName

getNodes

getNodesIds

  • getNodesIds(): string[]

getObsScene

  • getObsScene(): IScene

getResourceId

  • getResourceId(): string

getRootNodes

getRootNodesIds

  • getRootNodesIds(): string[]

getSelection

hasNestedScene

  • hasNestedScene(sceneId: string): boolean

makeActive

  • makeActive(): void

placeAfter

  • placeAfter(sourceNodeId: string, destNodeId?: string): void
  • Parameters

    • sourceNodeId: string
    • Optional destNodeId: string

    Returns void

placeBefore

  • placeBefore(sourceNodeId: string, destNodeId: string): void
  • Parameters

    • sourceNodeId: string
    • destNodeId: string

    Returns void

remove

  • remove(force?: boolean): IScene

removeFolder

  • removeFolder(folderId: string): void

removeItem

  • removeItem(sceneItemId: string): void

setLockOnAllItems

  • setLockOnAllItems(locked: boolean): void

setName

  • setName(newName: string): void