Interface AxDeck

Hierarchy

AxNode
- AxDeck

Index

Properties

Methods

Properties

Optional Readonly deckId

deckId: string | null

Optional Readonly deckName

deckName: string | null

Optional Readonly defaultInstance

defaultInstance: AxDeckInstance | null

Optional Readonly parent

parent: AxNode | null

Optional Readonly supportsAutoUpdate

supportsAutoUpdate: boolean | null

Methods

getAllLoadedInstances

getAllLoadedInstances(): Array<AxDeckInstance>

- Defined in sfgui/app/_data/typings-web.d.ts:12751
Returns Array<AxDeckInstance>

getInstance

getInstance(instanceKey: string): AxDeckInstance

- Defined in sfgui/app/_data/typings-web.d.ts:12750
Parameters
- instanceKey: string
Returns AxDeckInstance

invalidate

invalidate(): AxDeck

Overrides AxNode.invalidate
- Defined in sfgui/app/_data/typings-web.d.ts:12749
Returns AxDeck

showOnStreamDeck

showOnStreamDeck(): DeckShowOnStreamDeckDeviceResult
showOnStreamDeck(args: DeckShowOnStreamDeckDeviceActionArgs): DeckShowOnStreamDeckDeviceResult
showOnStreamDeck(args: DeckShowOnStreamDeckDeviceActionArgs, errorMessage: string): DeckShowOnStreamDeckDeviceResult
showOnStreamDeck(args: DeckShowOnStreamDeckDeviceActionArgs, errorCallback: (errorMessage: string) => void): DeckShowOnStreamDeckDeviceResult

- Defined in sfgui/app/_data/typings-web.d.ts:12745
Returns DeckShowOnStreamDeckDeviceResult
- Defined in sfgui/app/_data/typings-web.d.ts:12746
Parameters
- args: DeckShowOnStreamDeckDeviceActionArgs
Returns DeckShowOnStreamDeckDeviceResult
- Defined in sfgui/app/_data/typings-web.d.ts:12747
Parameters
- args: DeckShowOnStreamDeckDeviceActionArgs
- errorMessage: string
Returns DeckShowOnStreamDeckDeviceResult
- Defined in sfgui/app/_data/typings-web.d.ts:12748
Parameters
- args: DeckShowOnStreamDeckDeviceActionArgs
- errorCallback: (errorMessage: string) => void
  - - (errorMessage: string): void
    - Parameters
      - errorMessage: string
      Returns void
Returns DeckShowOnStreamDeckDeviceResult

Generated using TypeDoc