Class ClipSlot

Hierarchy

Properties<ClipSlotGetProperties, ClipSlotChildrenProperties, ClipSlotTransformedProperties, ClipSlotSetProperties, ObservableProperties>
- ClipSlot

Index

Constructors

constructor

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

Memberof
ClipSlot
Parameters
- ableton: AbletonLive
- raw: RawClipSlot
- Optional path: string
Returns ClipSlot
Overrides Properties< ClipSlotGetProperties, ClipSlotChildrenProperties, ClipSlotTransformedProperties, ClipSlotSetProperties, ObservableProperties >.constructor
- Defined in ClipSlot.ts:145

Properties

raw

raw: RawClipSlot

`Static` path

path: string = 'live_set tracks $1 clip_slots $2'

Accessors

hasClip

get hasClip(): boolean
If it contains a clip

Memberof
ClipSlot

Returns boolean
- Defined in ClipSlot.ts:169

id

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

Methods

child

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

children

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

clip

clip(): Promise<null | Clip>
Gets the clip or return's null if there's none

Memberof
ClipSlot

Returns Promise<null | Clip>
- Defined in ClipSlot.ts:179

createClip

createClip(lengthInBeats?): Promise<Clip>
Creates a new clip

Memberof
ClipSlot
Parameters
- Optional lengthInBeats: number = 4
Returns Promise<Clip>
- Defined in ClipSlot.ts:190

deleteClip

deleteClip(): Promise<void>
Deletes the clip

Memberof
ClipSlot

Returns Promise<void>
- Defined in ClipSlot.ts:202

duplicateClipTo

duplicateClipTo(targetClipSlot?): Promise<void>
Duplicates the clip into a new clip slot

Memberof
ClipSlot
Parameters
- Optional targetClipSlot: number
  
  target clip slot
Returns Promise<void>
- Defined in ClipSlot.ts:213

fire

fire(recordLength?, launchQuantization?): Promise<void>
Plays/Triggers a clip

Memberof
ClipSlot
Parameters
- Optional recordLength: number
- Optional launchQuantization: number
Returns Promise<void>
- Defined in ClipSlot.ts:225

get

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

observe

observe<T>(prop, listener): Promise<any>
Type Parameters
- T extends "clip" | keyof ObservableProperties
Parameters
- prop: T
- listener: ((data) => any)
  - - (data): any
    - Parameters
      
      data: T extends keyof ObservableProperties
          ? ObservableProperties[T]
          : T extends "clip"
              ? ClipSlotTransformedProperties[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 "has_stop_button"
Parameters
- prop: T
- value: ClipSlotSetProperties[T]
Returns Promise<null>
Inherited from Properties.set
- Defined in Properties.ts:80

stop

stop(): Promise<void>
Stops a clip

Memberof
ClipSlot

Returns Promise<void>
- Defined in ClipSlot.ts:235

Class ClipSlot

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Memberof

Parameters

ableton: AbletonLive

raw: RawClipSlot

Optional path: string

Returns ClipSlot

Properties

raw

Static path

Accessors

hasClip

Memberof

Returns boolean

id

Returns undefined | number

Methods

child

Type Parameters

TName extends never

Parameters

child: TName

index: number

Optional childProps: string[]

Returns Promise<FlatPropertyType<TName, ClipSlotTransformedProperties, ClipSlotChildrenProperties>>

children

Type Parameters

TName extends "clip"

Parameters

child: TName

Optional childProps: string[]

Optional index: number

Returns Promise<PropertyType<TName, ClipSlotTransformedProperties, ClipSlotChildrenProperties>>

clip

Memberof

Returns Promise<null | Clip>

createClip

Memberof

Parameters

Optional lengthInBeats: number = 4

Returns Promise<Clip>

deleteClip

Memberof

Returns Promise<void>

duplicateClipTo

Memberof

Parameters

Optional targetClipSlot: number

Returns Promise<void>

fire

Memberof

Parameters

Optional recordLength: number

Optional launchQuantization: number

Returns Promise<void>

get

Type Parameters

T extends keyof ClipSlotGetProperties

Parameters

prop: T

Returns Promise<T extends "clip" ? ClipSlotTransformedProperties[T] : ClipSlotGetProperties[T]>

observe

Type Parameters

T extends "clip" | keyof ObservableProperties

Parameters

prop: T

listener: ((data) => any)

Parameters

data: T extends keyof ObservableProperties ? ObservableProperties[T] : T extends "clip" ? ClipSlotTransformedProperties[T] : any

Returns any

Returns Promise<any>

set

`Optional` path: string

`Static` path

`Optional` childProps: string[]

`Optional` childProps: string[]

`Optional` index: number

`Optional` lengthInBeats: number = 4

`Optional` targetClipSlot: number

`Optional` recordLength: number

`Optional` launchQuantization: number

Returns Promise<T extends "clip"
? ClipSlotTransformedProperties[T]
: ClipSlotGetProperties[T]>

data: T extends keyof ObservableProperties
? ObservableProperties[T]
: T extends "clip"
? ClipSlotTransformedProperties[T]
: any