Class DeviceParameter<Version>

Represents a device parameter.

Type Parameters

Version extends ApiVersion

Hierarchy (View Summary)

DataModelObject<Version>
- DeviceParameter

Index

Properties

handle className

Accessors

defaultValue isQuantized max min name parent valueItems

Methods

getValue setValue

Properties

`Readonly`handle

handle: Handle

`Static` `Readonly`className

className: "DeviceParameter"

Accessors

defaultValue

get defaultValue(): number
Returns number

isQuantized

get isQuantized(): boolean
Returns boolean

max

get max(): number
Returns number

min

get min(): number
Returns number

name

get name(): string
Returns string

parent

get parent(): DataModelObject<Version> | null
The canonical parent of this object in Live's object hierarchy, or null if it has none.

Returns DataModelObject<Version> | null
Inherited from DataModelObject.parent

valueItems

get valueItems(): DeviceParameterValueItem[]
Returns DeviceParameterValueItem[]

Methods

getValue

getValue(): Promise<number>
Returns Promise<number>

setValue

setValue(value: number): Promise<void>
Parameters
- value: number
Returns Promise<void>