AxStreamDeckDevice

Hierarchy

AxNode
- AxStreamDeckDevice

Index

Properties

Methods

Properties

Optional buttonCount

buttonCount: number | null

Optional buttons

buttons: Array<AxStreamDeckDeviceButton>

Optional columnCount

columnCount: number | null

Optional context

context: string | null

Optional currentDeckInstance

currentDeckInstance: AxDeckInstance | null

Optional isSeized

isSeized: boolean | null

Optional name

name: string | null

Optional parent

parent: AxNode | null

Optional rowCount

rowCount: number | null

Optional supportsAutoUpdate

supportsAutoUpdate: boolean | null

Methods

doWithSeizedDevice

doWithSeizedDevice(): SdDoWithSeizedDeviceResult
doWithSeizedDevice(args: SdDoWithSeizedDeviceActionArgs): SdDoWithSeizedDeviceResult
doWithSeizedDevice(args: SdDoWithSeizedDeviceActionArgs, errorMessage: string): SdDoWithSeizedDeviceResult
doWithSeizedDevice(args: SdDoWithSeizedDeviceActionArgs, errorCallback: (errorMessage: string) => void): SdDoWithSeizedDeviceResult

- Defined in sfgui/app/_data/typings-web.d.ts:12807
Returns SdDoWithSeizedDeviceResult
- Defined in sfgui/app/_data/typings-web.d.ts:12808
Parameters
- args: SdDoWithSeizedDeviceActionArgs
Returns SdDoWithSeizedDeviceResult
- Defined in sfgui/app/_data/typings-web.d.ts:12809
Parameters
- args: SdDoWithSeizedDeviceActionArgs
- errorMessage: string
Returns SdDoWithSeizedDeviceResult
- Defined in sfgui/app/_data/typings-web.d.ts:12810
Parameters
- args: SdDoWithSeizedDeviceActionArgs
- errorCallback: (errorMessage: string) => void
  - - (errorMessage: string): void
    - Parameters
      - errorMessage: string
      Returns void
Returns SdDoWithSeizedDeviceResult

getButton

getButton(x: number, y: number): AxStreamDeckDeviceButton

- Defined in sfgui/app/_data/typings-web.d.ts:12828
Parameters
- x: number
- y: number
Returns AxStreamDeckDeviceButton

invalidate

invalidate(): AxStreamDeckDevice

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

releaseDevice

releaseDevice(): SdReleaseDeviceResult
releaseDevice(args: SdReleaseDeviceActionArgs): SdReleaseDeviceResult
releaseDevice(args: SdReleaseDeviceActionArgs, errorMessage: string): SdReleaseDeviceResult
releaseDevice(args: SdReleaseDeviceActionArgs, errorCallback: (errorMessage: string) => void): SdReleaseDeviceResult

- Defined in sfgui/app/_data/typings-web.d.ts:12811
Returns SdReleaseDeviceResult
- Defined in sfgui/app/_data/typings-web.d.ts:12812
Parameters
- args: SdReleaseDeviceActionArgs
Returns SdReleaseDeviceResult
- Defined in sfgui/app/_data/typings-web.d.ts:12813
Parameters
- args: SdReleaseDeviceActionArgs
- errorMessage: string
Returns SdReleaseDeviceResult
- Defined in sfgui/app/_data/typings-web.d.ts:12814
Parameters
- args: SdReleaseDeviceActionArgs
- errorCallback: (errorMessage: string) => void
  - - (errorMessage: string): void
    - Parameters
      - errorMessage: string
      Returns void
Returns SdReleaseDeviceResult

seizeDevice

seizeDevice(): SdSeizeDeviceResult
seizeDevice(args: SdSeizeDeviceActionArgs): SdSeizeDeviceResult
seizeDevice(args: SdSeizeDeviceActionArgs, errorMessage: string): SdSeizeDeviceResult
seizeDevice(args: SdSeizeDeviceActionArgs, errorCallback: (errorMessage: string) => void): SdSeizeDeviceResult

- Defined in sfgui/app/_data/typings-web.d.ts:12815
Returns SdSeizeDeviceResult
- Defined in sfgui/app/_data/typings-web.d.ts:12816
Parameters
- args: SdSeizeDeviceActionArgs
Returns SdSeizeDeviceResult
- Defined in sfgui/app/_data/typings-web.d.ts:12817
Parameters
- args: SdSeizeDeviceActionArgs
- errorMessage: string
Returns SdSeizeDeviceResult
- Defined in sfgui/app/_data/typings-web.d.ts:12818
Parameters
- args: SdSeizeDeviceActionArgs
- errorCallback: (errorMessage: string) => void
  - - (errorMessage: string): void
    - Parameters
      - errorMessage: string
      Returns void
Returns SdSeizeDeviceResult

showModal

showModal(): SdShowModalResult
showModal(args: SdShowModalActionArgs): SdShowModalResult
showModal(args: SdShowModalActionArgs, errorMessage: string): SdShowModalResult
showModal(args: SdShowModalActionArgs, errorCallback: (errorMessage: string) => void): SdShowModalResult

- Defined in sfgui/app/_data/typings-web.d.ts:12819
Returns SdShowModalResult
- Defined in sfgui/app/_data/typings-web.d.ts:12820
Parameters
- args: SdShowModalActionArgs
Returns SdShowModalResult
- Defined in sfgui/app/_data/typings-web.d.ts:12821
Parameters
- args: SdShowModalActionArgs
- errorMessage: string
Returns SdShowModalResult
- Defined in sfgui/app/_data/typings-web.d.ts:12822
Parameters
- args: SdShowModalActionArgs
- errorCallback: (errorMessage: string) => void
  - - (errorMessage: string): void
    - Parameters
      - errorMessage: string
      Returns void
Returns SdShowModalResult

waitForPress

waitForPress(): SdWaitForPressResult
waitForPress(args: SdWaitForPressActionArgs): SdWaitForPressResult
waitForPress(args: SdWaitForPressActionArgs, errorMessage: string): SdWaitForPressResult
waitForPress(args: SdWaitForPressActionArgs, errorCallback: (errorMessage: string) => void): SdWaitForPressResult

- Defined in sfgui/app/_data/typings-web.d.ts:12823
Returns SdWaitForPressResult
- Defined in sfgui/app/_data/typings-web.d.ts:12824
Parameters
- args: SdWaitForPressActionArgs
Returns SdWaitForPressResult
- Defined in sfgui/app/_data/typings-web.d.ts:12825
Parameters
- args: SdWaitForPressActionArgs
- errorMessage: string
Returns SdWaitForPressResult
- Defined in sfgui/app/_data/typings-web.d.ts:12826
Parameters
- args: SdWaitForPressActionArgs
- errorCallback: (errorMessage: string) => void
  - - (errorMessage: string): void
    - Parameters
      - errorMessage: string
      Returns void
Returns SdWaitForPressResult

Hierarchy

Index

Properties

Methods

Properties

Optional buttonCount

Optional buttons

Optional columnCount

Optional context

Optional currentDeckInstance

Optional isSeized

Optional name

Optional parent

Optional rowCount

Optional supportsAutoUpdate

Methods

doWithSeizedDevice

Returns SdDoWithSeizedDeviceResult

Parameters

args: SdDoWithSeizedDeviceActionArgs

Returns SdDoWithSeizedDeviceResult

Parameters

args: SdDoWithSeizedDeviceActionArgs

errorMessage: string

Returns SdDoWithSeizedDeviceResult

Parameters

args: SdDoWithSeizedDeviceActionArgs

errorCallback: (errorMessage: string) => void

Parameters

errorMessage: string

Returns void

Returns SdDoWithSeizedDeviceResult

getButton

Parameters

x: number

y: number

Returns AxStreamDeckDeviceButton

invalidate

Returns AxStreamDeckDevice

releaseDevice

Returns SdReleaseDeviceResult

Parameters

args: SdReleaseDeviceActionArgs

Returns SdReleaseDeviceResult

Parameters

args: SdReleaseDeviceActionArgs

errorMessage: string

Returns SdReleaseDeviceResult

Parameters

args: SdReleaseDeviceActionArgs

errorCallback: (errorMessage: string) => void

Parameters

errorMessage: string

Returns void

Returns SdReleaseDeviceResult

seizeDevice

Returns SdSeizeDeviceResult

Parameters

args: SdSeizeDeviceActionArgs

Returns SdSeizeDeviceResult

Parameters

args: SdSeizeDeviceActionArgs

errorMessage: string

Returns SdSeizeDeviceResult

Parameters

args: SdSeizeDeviceActionArgs

errorCallback: (errorMessage: string) => void

Parameters

errorMessage: string

Returns void

Returns SdSeizeDeviceResult

showModal

Returns SdShowModalResult

Parameters

args: SdShowModalActionArgs

Returns SdShowModalResult

Parameters

args: SdShowModalActionArgs

errorMessage: string

Returns SdShowModalResult