A SceneItem is a source that contains all of the information about that source, and how it fits in to the given scene

Hierarchy

Implements

Index

Constructors

constructor

  • new SceneItem(sceneId: string, sceneItemId: string, sourceId: string): SceneItem

Properties

audio

audio: boolean

Optional channel

channel: number

childrenIds

childrenIds: string[]

height

height: number

id

id: string

locked

locked: boolean

muted

muted: boolean

name

name: string

obsSceneItemId

obsSceneItemId: number

parentId

parentId: string

properties

properties: TFormData

resourceId

resourceId: string

sceneId

sceneId: string

sceneItemId

sceneItemId: string

sceneItemState

sceneItemState: ISceneItem

sceneNodeType

sceneNodeType: TSceneNodeType

Protected scenesService

scenesService: ScenesService

Protected selectionService

selectionService: SelectionService

sourceId

sourceId: string

transform

transform: ITransform

type

video

video: boolean

visible

visible: boolean

width

width: number

Accessors

isVisualSource

  • get isVisualSource(): boolean

scaledHeight

  • get scaledHeight(): number

scaledWidth

  • get scaledWidth(): number

source

Protected state

Methods

Protected SET_PARENT

  • SET_PARENT(parentId?: string): void

addToSelection

  • addToSelection(): void

centerOnScreen

  • centerOnScreen(): void

deselect

  • deselect(): void

detachParent

  • detachParent(): void

fitToScreen

  • fitToScreen(): void

flipX

  • flipX(): void

flipY

  • flipY(): void

getItemIndex

  • getItemIndex(): number

getModel

getNextItem

getNextNode

getNextSiblingNode

getNodeIndex

  • getNodeIndex(): number

getObsInput

  • getObsInput(): IInput

getObsSceneItem

  • getObsSceneItem(): ISceneItem

getParent

getPath

  • getPath(): string[]

getPrevItem

getPrevNode

getPrevSiblingNode

getRectangle

  • getRectangle(): ScalableRectangle

getResourceId

  • getResourceId(): string

getScene

getSelection

getSettings

getSource

hasParent

  • hasParent(): boolean

isFolder

  • isFolder(): boolean

isItem

  • isItem(): boolean

isSelected

  • isSelected(): boolean

loadAttributes

  • loadAttributes(): void

loadItemAttributes

nudgeDown

  • nudgeDown(): void

nudgeLeft

  • nudgeLeft(): void

nudgeRight

  • nudgeRight(): void

nudgeUp

  • nudgeUp(): void

placeAfter

  • placeAfter(nodeId: string): void

placeBefore

  • placeBefore(nodeId: string): void

remove

  • remove(): void

resetTransform

  • resetTransform(): void

rotate

  • rotate(deltaRotation: number): void

select

  • select(): void

setContentCrop

  • setContentCrop(): void

setLocked

  • setLocked(locked: boolean): void

setParent

  • setParent(parentId: string): void

setSettings

setTransform

setVisibility

  • setVisibility(visible: boolean): void

stretchToScreen

  • stretchToScreen(): void