Class Device

This class represents a MIDI or audio device in Live.

Hierarchy

Properties<DeviceGetProperties, DeviceChildrenProperties, DeviceTransformedProperties, DeviceSetProperties, DeviceObservableProperties>
- Device

Index

Constructors

constructor

new Device(ableton, raw, path?): Device
Parameters
- ableton: AbletonLive
- raw: RawDevice
- Optional path: string
Returns Device
Overrides Properties< DeviceGetProperties, DeviceChildrenProperties, DeviceTransformedProperties, DeviceSetProperties, DeviceObservableProperties >.constructor
- Defined in Device.ts:114

Properties

raw

raw: RawDevice

`Static` path

path: string = 'live_set tracks $1 devices'

Accessors

classDisplayName

get classDisplayName(): string
Get the original name of the device (e.g. Operator, Auto Filter)

Memberof
Device

Returns string
- Defined in Device.ts:157

className

get className(): string
Live device type such as MidiChord , Operator , Limiter , MxDeviceAudioEffect , or PluginDevice.

Memberof
Device

Returns string
- Defined in Device.ts:146

id

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

name

get name(): string
This is the string shown in the title bar of the device

Memberof
Device

Returns string
- Defined in Device.ts:135

type

get type(): DeviceType
The type of device

Memberof
Device

Returns DeviceType
- Defined in Device.ts:168

Methods

child

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

children

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

get

get<T>(prop): Promise<T extends "parameters"
? DeviceTransformedProperties[T]
: DeviceGetProperties[T]>
Type Parameters
- T extends keyof DeviceGetProperties
Parameters
- prop: T
Returns Promise<T extends "parameters"
? DeviceTransformedProperties[T]
: DeviceGetProperties[T]>
Inherited from Properties.get
- Defined in Properties.ts:37

observe

observe<T>(prop, listener): Promise<any>
Type Parameters
- T extends "parameters" | keyof DeviceObservableProperties
Parameters
- prop: T
- listener: ((data) => any)
  - - (data): any
    - Parameters
      
      data: T extends keyof DeviceObservableProperties
          ? DeviceObservableProperties[T]
          : T extends "parameters"
              ? DeviceTransformedProperties[T]
              : any
      
      Returns any
Returns Promise<any>
Inherited from Properties.observe
- Defined in Properties.ts:84

set

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

Class Device

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

ableton: AbletonLive

raw: RawDevice

Optional path: string

Returns Device

Properties

raw

Static path

Accessors

classDisplayName

Memberof

Returns string

className

Memberof

Returns string

id

Returns undefined | number

name

Memberof

Returns string

type

Memberof

Returns DeviceType

Methods

child

Type Parameters

TName extends "parameters"

Parameters

child: TName

index: number

Optional childProps: string[]

Returns Promise<FlatPropertyType<TName, DeviceTransformedProperties, DeviceChildrenProperties>>

children

Type Parameters

TName extends "parameters"

Parameters

child: TName

Optional childProps: string[]

Optional index: number

Returns Promise<PropertyType<TName, DeviceTransformedProperties, DeviceChildrenProperties>>

get

Type Parameters

T extends keyof DeviceGetProperties

Parameters

prop: T

Returns Promise<T extends "parameters" ? DeviceTransformedProperties[T] : DeviceGetProperties[T]>

observe

Type Parameters

T extends "parameters" | keyof DeviceObservableProperties

Parameters

prop: T

listener: ((data) => any)

Parameters

data: T extends keyof DeviceObservableProperties ? DeviceObservableProperties[T] : T extends "parameters" ? DeviceTransformedProperties[T] : any

Returns any

Returns Promise<any>

set

Type Parameters

T extends keyof DeviceSetProperties

Parameters

prop: T

value: DeviceSetProperties[T]

Returns Promise<null>

Settings

Member Visibility

Theme

On This Page

`Optional` path: string

`Static` path

`Optional` childProps: string[]

`Optional` childProps: string[]

`Optional` index: number

Returns Promise<T extends "parameters"
? DeviceTransformedProperties[T]
: DeviceGetProperties[T]>

data: T extends keyof DeviceObservableProperties
? DeviceObservableProperties[T]
: T extends "parameters"
? DeviceTransformedProperties[T]
: any