Class DeviceParameter

This class represents an (automatable) parameter within a MIDI or audio device. To modify a device parameter, set its value property.

Hierarchy

Properties<DeviceParameterGetProperties, null, null, DeviceParameterSetProperties, DeviceParameterObservableProperties>
- DeviceParameter

Index

Constructors

constructor

new DeviceParameter(ableton, raw, path?): DeviceParameter
Creates an instance of DeviceParameter.

Memberof
DeviceParameter
Parameters
- ableton: AbletonLive
- raw: RawDeviceParameter
- Optional path: string
Returns DeviceParameter
Overrides Properties< DeviceParameterGetProperties, null, null, DeviceParameterSetProperties, DeviceParameterObservableProperties >.constructor
- Defined in DeviceParameter.ts:142

Properties

raw

raw: RawDeviceParameter

`Static` path

path: string = 'live_set tracks N devices M parameters L'

Accessors

id

get id(): undefined | number
Returns undefined | number
Inherited from Properties.id
- Defined in Properties.ts:20

isQuantized

get isQuantized(): boolean
Returns boolean
- Defined in DeviceParameter.ts:160

name

get name(): string
Returns string
- Defined in DeviceParameter.ts:152

value

get value(): number
Returns number
- Defined in DeviceParameter.ts:156

Methods

child

child<TName>(child, index, childProps?): Promise<FlatPropertyType<TName, null, null>>
Type Parameters
- TName extends never
Parameters
- child: TName
- index: number
- Optional childProps: string[]
Returns Promise<FlatPropertyType<TName, null, null>>
Inherited from Properties.child
- Defined in Properties.ts:75

children

children<TName>(child, childProps?, index?): Promise<PropertyType<TName, null, null>>
Type Parameters
- TName extends never
Parameters
- child: TName
- Optional childProps: string[]
- Optional index: number
Returns Promise<PropertyType<TName, null, null>>
Inherited from Properties.children
- Defined in Properties.ts:53

get

get<T>(prop): Promise<T extends never
? null[T]
: DeviceParameterGetProperties[T]>
Type Parameters
- T extends keyof DeviceParameterGetProperties
Parameters
- prop: T
Returns Promise<T extends never
? null[T]
: DeviceParameterGetProperties[T]>
Inherited from Properties.get
- Defined in Properties.ts:37

observe

observe<T>(prop, listener): Promise<any>
Type Parameters
- T extends keyof DeviceParameterObservableProperties
Parameters
- prop: T
- listener: ((data) => any)
  - - (data): any
    - Parameters
      
      data: T extends keyof DeviceParameterObservableProperties
          ? DeviceParameterObservableProperties[T]
          : T extends never
              ? null[T]
              : any
      
      Returns any
Returns Promise<any>
Inherited from Properties.observe
- Defined in Properties.ts:84

reEnableAutomation

reEnableAutomation(): Promise<void>
Re-enable automation for this parameter.

Memberof
DeviceParameter

Returns Promise<void>
- Defined in DeviceParameter.ts:170

set

set<T>(prop, value): Promise<null>
Type Parameters
- T extends "value"
Parameters
- prop: T
- value: DeviceParameterSetProperties[T]
Returns Promise<null>
Inherited from Properties.set
- Defined in Properties.ts:80

str

str(): Promise<string>
Returns: [symbol] String representation of the current parameter value.

Memberof
DeviceParameter

Returns Promise<string>
- Defined in DeviceParameter.ts:190

strForValue

strForValue(value): Promise<string>
Returns: [symbol] String representation of the specified value.

Memberof
DeviceParameter
Parameters
- value: number
Returns Promise<string>
- Defined in DeviceParameter.ts:180

Class DeviceParameter

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Memberof

Parameters

ableton: AbletonLive

raw: RawDeviceParameter

Optional path: string

Returns DeviceParameter

Properties

raw

Static path

Accessors

id

Returns undefined | number

isQuantized

Returns boolean

name

Returns string

value

Returns number

Methods

child

Type Parameters

TName extends never

Parameters

child: TName

index: number

Optional childProps: string[]

Returns Promise<FlatPropertyType<TName, null, null>>

children

Type Parameters

TName extends never

Parameters

child: TName

Optional childProps: string[]

Optional index: number

Returns Promise<PropertyType<TName, null, null>>

get

Type Parameters

T extends keyof DeviceParameterGetProperties

Parameters

prop: T

Returns Promise<T extends never ? null[T] : DeviceParameterGetProperties[T]>

observe

Type Parameters

T extends keyof DeviceParameterObservableProperties

Parameters

prop: T

listener: ((data) => any)

Parameters

data: T extends keyof DeviceParameterObservableProperties ? DeviceParameterObservableProperties[T] : T extends never ? null[T] : any

Returns any

Returns Promise<any>

reEnableAutomation

Memberof

Returns Promise<void>

set

Type Parameters

T extends "value"

Parameters

prop: T

value: DeviceParameterSetProperties[T]

Returns Promise<null>

str

Memberof

Returns Promise<string>

strForValue

Memberof

Parameters

value: number

Returns Promise<string>

Settings

Member Visibility

`Optional` path: string

`Static` path

`Optional` childProps: string[]

`Optional` childProps: string[]

`Optional` index: number

Returns Promise<T extends never
? null[T]
: DeviceParameterGetProperties[T]>

data: T extends keyof DeviceParameterObservableProperties
? DeviceParameterObservableProperties[T]
: T extends never
? null[T]
: any