Class Clip

This class represents a clip in Live. It can be either an audio clip or a MIDI clip in the Arrangement or Session View, depending on the track / slot it lives in.

Hierarchy

Properties<ClipGetProperties, ClipChildrenProperties, ClipTransformedProperties, ClipSetProperties, ClipObservableProperties>
- Clip

Properties

raw

raw: RawClip

`Static` arrangementPath

arrangementPath: string = 'live_set tracks $1 arrangement_clips $2 clip'

`Static` sessionPath

sessionPath: string = 'live_set tracks $1 clip_slots $2 clip'

Accessors

id

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

length

get length(): number
The clip's length (duration)

Memberof
Clip

Returns number
- Defined in Clip.ts:583

name

get name(): string
The name of the clip

Memberof
Clip

Returns string
- Defined in Clip.ts:561

type

get type(): ClipType
The type of clip

Memberof
Clip

Returns ClipType
- Defined in Clip.ts:572

Methods

addNewNotes

addNewNotes(notes): Promise<void>
Add new notes to a clip. For MIDI clips only.

Memberof
Clip
Parameters
- notes: Note[]
Returns Promise<void>
- Defined in Clip.ts:595

applyNoteModifications

applyNoteModifications(notes): Promise<void>
Add new notes to a clip. For MIDI clips only.

Memberof
Clip
Parameters
- notes: Note[]
  
  as returned from getNotesExtended
Returns Promise<void>
- Defined in Clip.ts:607

child

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

children

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

clearAllEnvelopes

clearAllEnvelopes(): Promise<void>
Removes all automation in the clip

Memberof
Clip

Returns Promise<void>
- Defined in Clip.ts:617

clearEnvelope

clearEnvelope(deviceParameterId?): Promise<void>
Removes the automation of the clip for the given parameter

Memberof
Clip
Parameters
- Optional deviceParameterId: number
Returns Promise<void>
- Defined in Clip.ts:628

crop

crop(): Promise<void>
Crops the clip: if the clip is looped, the region outside the loop is removed; if it isn't, the region outside the start and end markers.

Memberof
Clip

Returns Promise<void>
- Defined in Clip.ts:639

deselectAllNotes

deselectAllNotes(): Promise<void>
Call this before replace_selected_notes if you just want to add some notes. For MIDI clips only.

Memberof
Clip

Returns Promise<void>
- Defined in Clip.ts:650

duplicateLoop

duplicateLoop(): Promise<void>
Makes the loop two times longer by moving loop_end to the right, and duplicates both the notes and the envelopes. If the clip is not looped, the clip start/end range is duplicated. For MIDI clips only.

Memberof
Clip

Returns Promise<void>
- Defined in Clip.ts:662

duplicateRegion

duplicateRegion(regionStart?, regionLength?, destinationTime?, pitch?, transpositionAmount?): Promise<void>
Duplicate the notes in the specified region to the destination_time. Only notes of the specified pitch are duplicated or all if pitch is -1. If the transposition_amount is not 0, the notes in the region will be transposed by the transpose_amount of semitones. For MIDI clips only.

Memberof
Clip

Example
```
// duplicates 1 bar to the beginning of the next bar
await clip.duplicateRegion(0, 4, 4);
```
Parameters
- Optional regionStart: number
  
  beats time
- Optional regionLength: number
  
  beats time
- Optional destinationTime: number
  
  beats time
- Optional pitch: number = -1
- Optional transpositionAmount: number = 0
Returns Promise<void>
- Defined in Clip.ts:683

fire

fire(): Promise<void>
Same effect as pressing the Clip Launch button.

Memberof
Clip

Returns Promise<void>
- Defined in Clip.ts:699

get

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

getNotes

getNotes(startTime?, timeRange?, startPitch?, pitchRange?): Promise<Note[]>
Returns a list of notes that start in the given area. The output is similar to get_selected_notes.

Memberof
Clip
Parameters
- Optional startTime: number = 0
- Optional timeRange: number = 256
- Optional startPitch: number = 0
- Optional pitchRange: number = 127
Returns Promise<Note[]>
- Defined in Clip.ts:714

getNotesById

getNotesById(ids): Promise<Note[]>
Provided note IDs must be associated with existing notes in the clip. Existing notes can be queried with getNotw.

Memberof
Clip
Parameters
- ids: number[]
  
  note ids
Returns Promise<Note[]>
- Defined in Clip.ts:728

getSelectedNotes

getSelectedNotes(): Promise<Note[]>
Use this if you want to operate on the selected notes

Memberof
Clip

Returns Promise<Note[]>
- Defined in Clip.ts:739

movePlayingPos

movePlayingPos(beats): Promise<void>
Jumps by given amount, unquantized. Unwarped audio clips, recording audio clips and recording non-overdub MIDI clips cannot jump.

Memberof
Clip
Parameters
- beats: number
  
  relative jump distance in beats. Negative beats jump backwards.
Returns Promise<void>
- Defined in Clip.ts:752

observe

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

quantize

quantize(quantizationGrid, amount): Promise<void>
Quantizes all notes in the clip to the quantization_grid taking the song's swing_amount into account.

Memberof
Clip
Parameters
- quantizationGrid: number
- amount: number
Returns Promise<void>
- Defined in Clip.ts:765

quantizePitch

quantizePitch(pitch, quantizationGrid, amount): Promise<void>
Same as quantize, but only for notes in the given pitch.

Memberof
Clip
Parameters
- pitch: number
- quantizationGrid: number
- amount: number
Returns Promise<void>
- Defined in Clip.ts:779

removeNotes

removeNotes(startTime?, timeRange?, startPitch?, pitchRange?): Promise<void>
Deletes all notes that start in the given area.

Memberof
Clip
Parameters
- Optional startTime: number = 0
- Optional timeRange: number = 256
- Optional startPitch: number = 0
- Optional pitchRange: number = 127
Returns Promise<void>
- Defined in Clip.ts:794

removeNotesById

removeNotesById(ids): Promise<void>
Deletes all notes associated with the provided IDs.

Memberof
Clip
Parameters
- ids: number[]
  
  note ids
Returns Promise<void>
- Defined in Clip.ts:806

removeSelectedNotes

removeSelectedNotes(notes): Promise<void>
Remove all selected notes

Memberof
Clip
Parameters
- notes: Note[]
Returns Promise<void>
- Defined in Clip.ts:542

scrub

scrub(beatTime): Promise<void>
Scrub the clip to a time, specified in beats. This behaves exactly like scrubbing with the mouse; the scrub will respect Global Quantization, starting and looping in time with the transport. The scrub will continue until stopScrub() is called.

Memberof
Clip
Parameters
- beatTime: number
Returns Promise<void>
- Defined in Clip.ts:820

selectAllNotes

selectAllNotes(): Promise<void>
Use this function to process all notes of a clip, independent of the current selection.

Memberof
Clip

Returns Promise<void>
- Defined in Clip.ts:830

set

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

setFireButtonState

setFireButtonState(state): Promise<void>
If the state is set to true, Live simulates pressing the clip start button until the state is set to false, or until the clip is otherwise stopped.

Memberof
Clip
Parameters
- state: boolean
Returns Promise<void>
- Defined in Clip.ts:843

stop

stop(): Promise<void>
Same effect as pressing the stop button of the track, but only if this clip is actually playing or recording. If this clip is triggered or if another clip in this track is playing, it has no effect.

Memberof
Clip

Returns Promise<void>
- Defined in Clip.ts:854

stopScrub

stopScrub(): Promise<void>
Stops an active scrub on a clip

Memberof
Clip

Returns Promise<void>
- Defined in Clip.ts:864

`Static` getArrangementPath

getArrangementPath(trackNumber, clipSlotNumber): string
Parameters
- trackNumber: number
- clipSlotNumber: number
Returns string
- Defined in Clip.ts:502

`Static` getSessionPath

getSessionPath(trackNumber, clipSlotNumber): string
Parameters
- trackNumber: number
- clipSlotNumber: number
Returns string
- Defined in Clip.ts:498

Class Clip

Hierarchy

Index

Properties

Accessors

Methods

Properties

raw

Static arrangementPath

Static sessionPath

Accessors

id

Returns undefined | number

length

Memberof

Returns number

name

Memberof

Returns string

type

Memberof

Returns ClipType

Methods

addNewNotes

Memberof

Parameters

notes: Note[]

Returns Promise<void>

applyNoteModifications

Memberof

Parameters

notes: Note[]

Returns Promise<void>

child

Type Parameters

TName extends never

Parameters

child: TName

index: number

Optional childProps: string[]

Returns Promise<FlatPropertyType<TName, ClipTransformedProperties, ClipChildrenProperties>>

children

Type Parameters

TName extends "clipView"

Parameters

child: TName

Optional childProps: string[]

Optional index: number

Returns Promise<PropertyType<TName, ClipTransformedProperties, ClipChildrenProperties>>

clearAllEnvelopes

Memberof

Returns Promise<void>

clearEnvelope

Memberof

Parameters

Optional deviceParameterId: number

Returns Promise<void>

crop

Memberof

Returns Promise<void>

deselectAllNotes

Memberof

Returns Promise<void>

duplicateLoop

Memberof

Returns Promise<void>

duplicateRegion

Memberof

Example

Parameters

Optional regionStart: number

Optional regionLength: number

Optional destinationTime: number

Optional pitch: number = -1

Optional transpositionAmount: number = 0

Returns Promise<void>

fire

Memberof

Returns Promise<void>

get

`Static` arrangementPath

`Static` sessionPath

`Optional` childProps: string[]

`Optional` childProps: string[]

`Optional` index: number

`Optional` deviceParameterId: number

`Optional` regionStart: number

`Optional` regionLength: number

`Optional` destinationTime: number

`Optional` pitch: number = -1

`Optional` transpositionAmount: number = 0

Returns Promise<T extends "clipView"
? ClipTransformedProperties[T]
: ClipGetProperties[T]>

`Optional` startTime: number = 0

`Optional` timeRange: number = 256

`Optional` startPitch: number = 0

`Optional` pitchRange: number = 127

data: T extends keyof ClipObservableProperties
? ClipObservableProperties[T]
: T extends "clipView"
? ClipTransformedProperties[T]
: any

`Optional` startTime: number = 0

`Optional` timeRange: number = 256

`Optional` startPitch: number = 0

`Optional` pitchRange: number = 127