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.

Clip

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)

Returns number
Memberof
Clip
- Defined in Clip.ts:584

name

get name(): string
The name of the clip

Returns string
Memberof
Clip
- Defined in Clip.ts:562

path

get path(): string
Returns string
Inherited from Properties.path
- Defined in Properties.ts:24

type

get type(): ClipType
The type of clip

Returns ClipType
Memberof
Clip
- Defined in Clip.ts:573

Methods

addNewNotes

addNewNotes(notes): Promise<void>
Add new notes to a clip. For MIDI clips only.
Parameters
- notes: Note[]
Returns Promise<void>
Memberof
Clip
- Defined in Clip.ts:596

applyNoteModifications

applyNoteModifications(notes): Promise<void>
Add new notes to a clip. For MIDI clips only.
Parameters
- notes: Note[]
  as returned from getNotesExtended
Returns Promise<void>
Memberof
Clip
- Defined in Clip.ts:608

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:83

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:57

clearAllEnvelopes

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

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

clearEnvelope

clearEnvelope(deviceParameterId?): Promise<void>
Removes the automation of the clip for the given parameter
Parameters
- Optional deviceParameterId: number
Returns Promise<void>
Memberof
Clip
- Defined in Clip.ts:629

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.

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

deselectAllNotes

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

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

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.

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

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.
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>
Memberof
Clip

Example
```
// duplicates 1 bar to the beginning of the next bar
await clip.duplicateRegion(0, 4, 4);
```
- Defined in Clip.ts:684

fire

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

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

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:41

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.
Parameters
- Optional startTime: number = 0
- Optional timeRange: number = 256
- Optional startPitch: number = 0
- Optional pitchRange: number = 127
Returns Promise<Note[]>
Memberof
Clip
- Defined in Clip.ts:715

getNotesById

getNotesById(ids): Promise<Note[]>
Provided note IDs must be associated with existing notes in the clip. Existing notes can be queried with getNotw.
Parameters
- ids: number[]
  note ids
Returns Promise<Note[]>
Memberof
Clip
- Defined in Clip.ts:729

getSelectedNotes

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

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

movePlayingPos

movePlayingPos(beats): Promise<void>
Jumps by given amount, unquantized. Unwarped audio clips, recording audio clips and recording non-overdub MIDI clips cannot jump.
Parameters
- beats: number
  relative jump distance in beats. Negative beats jump backwards.
Returns Promise<void>
Memberof
Clip
- Defined in Clip.ts:753

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:96

quantize

quantize(quantizationGrid, amount): Promise<void>
Quantizes all notes in the clip to the quantization_grid taking the song's swing_amount into account.
Parameters
- quantizationGrid: number
- amount: number
Returns Promise<void>
Memberof
Clip
- Defined in Clip.ts:766

quantizePitch

quantizePitch(pitch, quantizationGrid, amount): Promise<void>
Same as quantize, but only for notes in the given pitch.
Parameters
- pitch: number
- quantizationGrid: number
- amount: number
Returns Promise<void>
Memberof
Clip
- Defined in Clip.ts:780

removeNotes

removeNotes(startTime?, timeRange?, startPitch?, pitchRange?): Promise<void>
Deletes all notes that start in the given area.
Parameters
- Optional startTime: number = 0
- Optional timeRange: number = 256
- Optional startPitch: number = 0
- Optional pitchRange: number = 127
Returns Promise<void>
Memberof
Clip
- Defined in Clip.ts:795

removeNotesById

removeNotesById(ids): Promise<void>
Deletes all notes associated with the provided IDs.
Parameters
- ids: number[]
  note ids
Returns Promise<void>
Memberof
Clip
- Defined in Clip.ts:807

removeSelectedNotes

removeSelectedNotes(notes): Promise<void>
Remove all selected notes
Parameters
- notes: Note[]
Returns Promise<void>
Memberof
Clip
- Defined in Clip.ts:543

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.
Parameters
- beatTime: number
Returns Promise<void>
Memberof
Clip
- Defined in Clip.ts:821

selectAllNotes

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

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

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:92

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.
Parameters
- state: boolean
Returns Promise<void>
Memberof
Clip
- Defined in Clip.ts:844

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.

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

stopScrub

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

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

`Static` getArrangementPath

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

`Static` getSessionPath

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

Class Clip

Hierarchy

Index

Properties

Accessors

Methods

Properties

raw

Static arrangementPath

Static sessionPath

Accessors

id

Returns undefined | number

length

Returns number

Memberof

name

Returns string

Memberof

path

Returns string

type

Returns ClipType

Memberof

Methods

addNewNotes

Parameters

Returns Promise<void>

Memberof

applyNoteModifications

Parameters

Returns Promise<void>

Memberof

child

Type Parameters

Parameters

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

children

Type Parameters

Parameters

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

clearAllEnvelopes

Returns Promise<void>

Memberof

clearEnvelope

Parameters

Returns Promise<void>

Memberof

crop

Returns Promise<void>

Memberof

deselectAllNotes

Returns Promise<void>

Memberof

duplicateLoop

Returns Promise<void>

Memberof

duplicateRegion

Parameters

Returns Promise<void>

Memberof

Example

fire

Returns Promise<void>

Memberof

get

Type Parameters

Parameters

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

getNotes

Parameters

Returns Promise<Note[]>

Memberof

getNotesById

Parameters

Returns Promise<Note[]>

Memberof

getSelectedNotes

Returns Promise<Note[]>

Memberof

`Static` arrangementPath

`Static` sessionPath

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

`Static` getArrangementPath

`Static` getSessionPath