LOM - The Live Object Model
Objects which comprise the Live API described by their structure, properties and functions.
Introduction
The Live Object Model lists a number of Live object classes with their
properties and functions, as well as their parent-child relations through
which a hierarchy is formed. Please refer to the
Live API overview chapter
for definitions of the basic Live API terms and a list of the Max objects
used to access it.
This document refers to Ableton Live version 12.1
Object Model Overview
| Click on the classes to navigate to their description. |
|---|
Application
This class represents the Live application. It is reachable by the root path live_app .
Canonical path
live_app
Children
control_surfaces
Description
A list of the control surfaces currently selected in Live's
Preferences.
If None is selected in any of the slots or the script is inactive (e.g. when Push2 is selected,
but no Push is connected), id 0 will be returned at those indices.
Properties
current_dialog_button_count
Description
The number of buttons in the current message box.
current_dialog_message
Description
The text of the current message box (empty if no message box is currently shown).
average_process_usage
Description
Reports Live's average CPU load.
Note that Live's CPU meter shows the audio processing load but not Live's overall CPU usage.
peak_process_usage
Description
Reports Live's peak CPU load.
Note that Live's CPU meter shows the audio processing load but not Live's overall CPU usage.
Functions
get_bugfix_version
Returns: the 2 in Live 9.1.2.
get_document
Returns: the current Live Set.
get_major_version
Returns: the 9 in Live 9.1.2.
get_minor_version
Returns: the 1 in Live 9.1.2.
get_version_string
Returns: the text 9.1.2 in Live 9.1.2.
press_current_dialog_button
Parameter:
index
Press the button with the given index in the current dialog box.
Application.View
This class represents the aspects of the Live application related to viewing the application.
Canonical path
live_app view
Children
Properties
focused_document_view
Description
The name of the currently visible view in the focused Live window ('Session' or 'Arranger').
Functions
available_main_views
Returns:
view names
[list of symbols].
This is a constant list of view names to be used
as an argument when calling other functions:
Browser Arranger Session Detail Detail/Clip Detail/DeviceChain
.
focus_view
Parameter:
view_name
Shows named view and focuses on it. You can also pass an empty view_name “ ", which refers to the Arrangement or Session View (whichever is visible in the main window).
hide_view
Parameter:
view_name
Hides the named view. You can also pass an empty view_name “ ", which refers to the Arrangement or Session View (whichever is visible in the main window).
is_view_visible
Parameter:
view_name
Returns: [bool] Whether the specified view is currently visible.
scroll_view
Parameters:
direction view_name modifier_pressed
direction
[int] is 0 = up, 1 = down, 2 = left, 3 = right
modifier_pressed
[bool] If view_name is "Arranger" and modifier_pressed is 1 and direction is left or right, then the size of the selected time region is modified, otherwise the position of the playback cursor is moved.
Not all views are scrollable, and not in all directions. Currently, only the
Arranger
,
Browser
,
Session
, and
Detail/DeviceChain
views can be scrolled.
You can also pass an empty view_name
" "
, which refers to the Arrangement or Session View (whichever view is
visible).
show_view
Parameter: view_name
toggle_browse
Displays the device chain and the browser and activates Hot-Swap Mode for the selected device. Calling this function again deactivates Hot-Swap Mode.
zoom_view
Parameter:
direction view_name modifier_pressed
direction
[int] - 0 = up, 1 = down, 2 = left, 3 = right
modifier_pressed
[bool] If view_name is 'Arrangement', modifier_pressed is 1, and direction is left or right, then the size of the selected time region is modified, otherwise the position of the playback cursor is moved. If view_name is Arrangement and modifier_pressed is 1 and direction is up or down, then only the height of the highlighted track is changed, otherwise the height of all tracks is changed.
Only the Arrangement and Session Views can be zoomed. For Session View, the behaviour of zoom_view is identical to scroll_view.
You can also pass an empty view_name “ ", which refers to the Arrangement or Session View (whichever is visible in the main window).
TuningSystem
This class represents a tuning system in Live.
Canonical path
live_set tuning_system
Properties
pseudo_octave_in_cents
Description
The pseudo octave in cents of the currently active tuning system.
lowest_note
Description
The note index within the pseudo octave and octave of the lowest note.
highest_note
Description
The note index within the pseudo octave and octave of the highest note.
reference_pitch
Description
The reference pitch of the current tuning system.
note_tunings
Description
The relative note tunings of the Tuning System in cents.
Song
This class represents a Live Set. The current Live Set is reachable by the root path live_set .
Canonical path
live_set
Children
cue_points
Description
Cue points are the markers in the Arrangement to which you can jump.
visible_tracks
Description
A track is visible if it's not part of a folded group. If a track is scrolled out of view it's still considered visible.
tuning_system
Description
Live's currently active tuning system.
Properties
appointed_device
Description
The appointed device is the one used by a control surface unless the control surface itself chooses which device to use. It is marked by a blue hand.
arrangement_overdub
Description
Get/set the state of the MIDI Arrangement Overdub button.
back_to_arranger
Description
Get/set/observe the current state of the Back to Arrangement button located
in Live's transport bar (1 = highlighted). This button is
used to indicate that the current state of the playback differs from
what is stored in the Arrangement.
Setting this property to 0 will make Live go back to playing the content of
the arrangement.
can_capture_midi
Description
1 = Recently played MIDI material exists that can be captured into a Live Track. See capture_midi.
can_jump_to_next_cue
Description
0 = there is no cue point to the right of the current one, or none at all.
can_jump_to_prev_cue
Description
0 = there is no cue point to the left of the current one, or none at all.
clip_trigger_quantization
Description
Reflects the quantization setting in the transport bar.
0 = None
1 = 8 Bars
2 = 4 Bars
3 = 2 Bars
4 = 1 Bar
5 = 1/2
6 = 1/2T
7 = 1/4
8 = 1/4T
9 = 1/8
10 = 1/8T
11 = 1/16
12 = 1/16T
13 = 1/32
count_in_duration
Description
The duration of the Metronome's Count-In setting as an index, mapped as follows:
0 = None
1 = 1 Bar
2 = 2 Bars
3 = 4 Bars
current_song_time
Description
The playing position in the Live Set, in beats.
exclusive_arm
Description
Current status of the exclusive Arm option set in the Live preferences.
exclusive_solo
Description
Current status of the exclusive Solo option set in the Live preferences.
file_path
Description
The path to the current Live Set, in OS-native format. If the Live Set hasn't been saved, the path is empty.
groove_amount
Description
The groove amount from the current set's groove pool (0. - 1.0).
is_ableton_link_enabled
Description
Enable/disable Ableton Link. The Link toggle in the Live's transport bar must be visible to enable Link.
is_ableton_link_start_stop_sync_enabled
Description
Enable/disable Ableton Link Start Stop Sync.
last_event_time
Description
The beat time of the last event (i.e. automation breakpoint, clip end, cue point, loop end) in the Arrangement.
loop
Description
Get/set the enabled state of the Arrangement loop.
midi_recording_quantization
Description
Get/set the current Record Quantization value.
0 = None
1 = 1/4
2 = 1/8
3 = 1/8T
4 = 1/8 + 1/8T
5 = 1/16
6 = 1/16T
7 = 1/16 + 1/16T
8 = 1/32
name
Description
The name of the current Live Set. If the Live Set hasn't been saved, the name is empty.
nudge_down
Description
1 = the Tempo Nudge Down button in the transport bar is currently pressed.
nudge_up
Description
1 = the Tempo Nudge Up button in the transport bar is currently pressed.
tempo_follower_enabled
Description
1 = the Tempo Follower controls the tempo. The Tempo Follower Toggle must be made visible in the preferences for this property to be effective.
overdub
Description
1 = MIDI Arrangement Overdub is enabled in the transport.
punch_in
Description
1 = the Punch-In button is enabled in the transport.
punch_out
Description
1 = the Punch-Out button is enabled in the transport.
re_enable_automation_enabled
Description
1 = the Re-Enable Automation button is on.
root_note
Description
The root note of the scale currently selected in Live. The root note can be a number between 0 and 11, where 0 = C and 11 = B.
scale_intervals
Description
A list of integers representing the intervals in Live's current scale (see scale_name and scale_mode). An interval is expressed as the difference between the scale degree at the list index and the first scale degree.
scale_mode
Description
Access to the Scale Mode setting in Live.
When on, key tracks that belong to the currently selected scale are highlighted
in Live's MIDI Note Editor, and pitch-based parameters in MIDI Tools and Devices
can be edited in scale degrees rather than semitones.
See also root_note, scale_name, and scale_intervals.
scale_name
Description
The name of the scale selected in Live, as displayed in the Current Scale Name chooser.
select_on_launch
Description
1 = the "Select on Launch" option is set in Live's preferences.
session_automation_record
Description
The state of the Automation Arm button.
session_record
Description
The state of the Session Overdub button.
session_record_status
Description
Reflects the state of the Session Record button.
start_time
Description
The position in the Live Set where playing will start, in beats.
swing_amount
Description
Range: 0.0 - 1.0; affects MIDI Recording Quantization and all direct calls to Clip.quantize.
tempo
Description
Current tempo of the Live Set in BPM, 20.0 ... 999.0. The tempo may be automated, so it can change depending on the current song time.
Functions
capture_and_insert_scene
Capture the currently playing clips and insert them as a new scene below the selected scene.
capture_midi
Parameter: destination [int]
0 = auto, 1 = session, 2 = arrangement
Capture recently played MIDI material from audible tracks into a Live Clip.
If destinaton is not set or it is set to auto, the Clip is inserted
into the view currently visible in the focused Live window. Otherwise, it is inserted
into the specified view.
continue_playing
From the current playback position.
create_audio_track
Parameter:
index
Index determines where the track is added, it is only valid between 0 and
len(song.tracks). Using an index of -1 will add the new track at the end of the list.
create_midi_track
Parameter:
index
Index determines where the track is added, it is only valid between 0 and
len(song.tracks). Using an index of -1 will add the new track at the end of the list.
create_return_track
Adds a new return track at the end.
create_scene
Parameter:
index
Returns: The new scene
Index determines where the scene is added. It is only valid between 0 and
len(song.scenes). Using an index of -1 will add the new scene at the end of the list.
delete_scene
Parameter:
index
Delete the scene at the given index.
delete_track
Parameter:
index
Delete the track at the given index.
delete_return_track
Parameter:
index
Delete the return track at the given index.
duplicate_scene
Parameter:
index
Index determines which scene to duplicate.
duplicate_track
Parameter:
index
Index determines which track to duplicate.
find_device_position
Parameter:
device [live object]
target [live object]
target position [int]
Returns:
[int] The position in the target's chain where the device can be
inserted that is the closest possible to the target position.
force_link_beat_time
Force the Link timeline to jump to Live's current beat time.
get_beats_loop_length
Returns:
bars.beats.sixteenths.ticks
[symbol]
The Arrangement loop length.
get_beats_loop_start
Returns:
bars.beats.sixteenths.ticks
[symbol]
The Arrangement loop start.
get_current_beats_song_time
Returns:
bars.beats.sixteenths.ticks
[symbol]
The current Arrangement playback position.
get_current_smpte_song_time
Parameter:
format
format
[int] is the time code type to be returned
0 = the frame position shows the milliseconds
1 = Smpte24
2 = Smpte25
3 = Smpte30
4 = Smpte30Drop
5 = Smpte29
Returns:
hours:min:sec:frames
[symbol]
The current Arrangement playback position.
is_cue_point_selected
Returns: bool 1 = the current Arrangement playback position is at a cue point
jump_by
Parameter:
beats
beats
[double] is the amount to jump relatively to the current position
jump_to_next_cue
Jump to the right, if possible.
jump_to_prev_cue
Jump to the left, if possible.
move_device
Parameter:
device [live object]
target [live object]
target position [int]
Returns: [int] The position in the target's chain where the device was inserted.
Move the device to the specified position in the target chain. If the device cannot be moved to the specified position, the nearest possible
position is chosen.
play_selection
Do nothing if no selection is set in Arrangement, or play the current selection.
re_enable_automation
Trigger 'Re-Enable Automation', re-activating automation in all running Session clips.
redo
Causes the Live application to redo the last operation.
scrub_by
Parameter:
beats
beats
[double] the amount to scrub relative to the current Arrangement
playback position
Same as
jump_by
, at the moment.
set_or_delete_cue
Toggle cue point at current Arrangement playback position.
start_playing
Start playback from the insert marker.
stop_all_clips
Parameter (optional):
quantized
Calling the function with 0 will stop all clips immediately, independent of
the launch quantization. The default is '1'.
stop_playing
Stop the playback.
tap_tempo
Same as pressing the Tap Tempo button in the transport bar. The new tempo is calculated based on the time between subsequent calls of this function.
trigger_session_record
Parameter:
record_length (optional)
Starts recording in either the selected slot or the next empty slot, if the track
is armed. If record_length is provided, the slot will record for the
given length in beats.
If triggered while recording, recording will stop and clip playback will start.
undo
Causes the Live application to undo the last operation.
Song.View
This class represents the view aspects of a Live document: the Session and Arrangement Views.
Canonical path
live_set view
Children
detail_clip
Description
The clip currently displayed in the Live application's Detail View.
highlighted_clip_slot
Description
The slot highlighted in the Session View.
selected_parameter
Description
The selected parameter, or "id 0"
Properties
draw_mode
Description
Reflects the state of the envelope/automation Draw Mode Switch in the
transport bar, as toggled with Cmd/Ctrl-B.
0 = breakpoint editing (shows arrow), 1 = drawing (shows pencil)
follow_song
Description
Reflects the state of the Follow switch in the transport bar as toggled
with Cmd/Ctrl-F.
0 = don't follow playback position, 1 = follow playback position
Functions
select_device
Parameter:
id NN
Selects the given device object in its track.
You may obtain the id using a
live.path
or by using
get devices
on a track, for example.
The track containing the device will not be shown automatically, and
the device gets the appointed device (blue hand) only if its track is
selected.
GroovePool
This class represents the groove pool in Live. It provides access to the current set's list of grooves.
Canonical path
live_set groove_pool
Children
grooves
Description
List of grooves in the groove pool from top to bottom, can be accessed via index.
Track
This class represents a track in Live. It can either be an audio track, a
MIDI track, a return track or the master track. The master track and at
least one Audio or MIDI track will be always present. Return tracks are
optional.
Not all properties are supported by all types of tracks. The properties
are marked accordingly.
Canonical path
live_set tracks N
Children
arrangement_clips
Description
The list of this track's Arrangement View clip IDs
Available since Live 11.0.
group_track
Description
The Group Track, if the Track is grouped. If it is not, id 0 is returned.
Properties
arm
Description
1 = track is armed for recording. [not in return/master tracks]
available_input_routing_channels
Description
The list of available source channels for the track's input routing.
It's represented as a dictionary with the following key:
available_input_routing_channels [list]
The list contains dictionaries as described in input_routing_channel.
Only available on MIDI and audio tracks.
available_input_routing_types
Description
The list of available source types for the track's input routing.
It's represented as a dictionary with the following key:
available_input_routing_types [list]
The list contains dictionaries as described in input_routing_type.
Only available on MIDI and audio tracks.
available_output_routing_channels
Description
The list of available target channels for the track's output routing.
It's represented as a dictionary with the following key:
available_output_routing_channels [list]
The list contains dictionaries as described in output_routing_channel.
Not available on the master track.
available_output_routing_types
Description
The list of available target types for the track's output routing.
It's represented as a dictionary with the following key:
available_output_routing_types [list]
The list contains dictionaries as described in output_routing_type.
Not available on the master track.
back_to_arranger
Description
Get/set/observe the current state of the Single Track Back to Arrangement button
(1 = highlighted). This button is used to indicate that the current state of the
playback differs from what is stored in the Arrangement.
Setting this property to 0 will make Live go back to playing the track's arrangement
content. For group tracks, this means that all of the tracks that belong to the
group and any subgroups will go back to playing the arrangement.
can_show_chains
Description
1 = the track contains an Instrument Rack device that can show chains in Session View.
color
Description
The RGB value of the track's color in the form
0x00rrggbb
or (2^16 * red) + (2^8) * green + blue, where red, green and blue are
values from 0 (dark) to 255 (light).
When setting the RGB value, the nearest color from the track color
chooser is taken.
fired_slot_index
Description
Reflects the blinking clip slot.
-1 = no slot fired, -2 = Clip Stop Button fired
First clip slot has index 0.
[not in return/master tracks]
fold_state
Description
0 = tracks within the Group Track are visible, 1 = Group Track is folded and the tracks within the Group Track are hidden
[only available if
is_foldable
= 1]
has_audio_output
Description
1 for audio tracks and MIDI tracks with instruments.
has_midi_output
Description
1 for MIDI tracks with no instruments and no audio effects.
implicit_arm
Description
A second arm state, only used by Push so far.
input_meter_left
Description
Smoothed momentary peak value of left channel input meter, 0.0 to 1.0. For tracks with audio output only. This value corresponds to the meters shown in Live. Please take into account that the left/right audio meters put a significant load onto the GUI part of Live.
input_meter_level
Description
Hold peak value of input meters of audio and MIDI tracks, 0.0 ... 1.0. For audio tracks it is the maximum of the left and right channels. The hold time is 1 second.
input_meter_right
Description
Smoothed momentary peak value of right channel input meter, 0.0 to 1.0. For tracks with audio output only. This value corresponds to the meters shown in Live.
input_routing_channel
Description
The currently selected source channel for the track's input routing.
It's represented as a dictionary with the following keys:
display_name [symbol]
identifier [symbol]
Can be set to all values found in the track's available_input_routing_channels.
Only available on MIDI and audio tracks.
input_routing_type
Description
The currently selected source type for the track's input routing.
It's represented as a dictionary with the following keys:
display_name [symbol]
identifier [symbol]
Can be set to all values found in the track's available_input_routing_types.
Only available on MIDI and audio tracks.
is_foldable
Description
1 = track can be (un)folded to hide or reveal the contained tracks. This is currently the case for Group Tracks. Instrument and Drum Racks return 0 although they can be opened/closed. This will be fixed in a later release.
is_showing_chains
Description
Get or set whether a track with an Instrument Rack device is currently showing its chains in Session View.
muted_via_solo
Description
1 = the track or chain is muted due to Solo being active on at least one other track.
output_meter_left
Description
Smoothed momentary peak value of left channel output meter, 0.0 to 1.0. For tracks with audio output only. This value corresponds to the meters shown in Live. Please take into account that the left/right audio meters add a significant load to Live GUI resource usage.
output_meter_level
Description
Hold peak value of output meters of audio and MIDI tracks, 0.0 to 1.0. For audio tracks, it is the maximum of the left and right channels. The hold time is 1 second.
output_meter_right
Description
Smoothed momentary peak value of right channel output meter, 0.0 to 1.0. For tracks with audio output only. This value corresponds to the meters shown in Live.
performance_impact
Description
Reports the performance impact of this track.
output_routing_channel
Description
The currently selected target channel for the track's output routing.
It's represented as a dictionary with the following keys:
display_name [symbol]
identifier [symbol]
Can be set to all values found in the track's available_output_routing_channels.
Not available on the master track.
output_routing_type
Description
The currently selected target type for the track's output routing.
It's represented as a dictionary with the following keys:
display_name [symbol]
identifier [symbol]
Can be set to all values found in the track's available_output_routing_types.
Not available on the master track.
playing_slot_index
Description
First slot has index 0, -2 = Clip Stop slot fired in Session View, -1 = Arrangement recording with no Session clip playing. [not in return/master tracks]
solo
Description
Remark: when setting this property, the exclusive Solo logic is bypassed, so you have to unsolo the other tracks yourself. [not in master track]
Functions
create_audio_clip
Parameters:
file_path [symbol]
position [float]
Given an absolute path to a valid audio file in a supported format, creates an
audio clip that references the file at the specified position in the
arrangement view. Prints an error if the track is not an audio track, if the
track is frozen, or if the track is being recorded into. The position must be
within the range [0., 1576800].
See the ClipSlot.create_audio_clip function if you need to create
audio clips in session view instead.
delete_clip
Parameter:
clip
Delete the given clip.
delete_device
Parameter:
index
Delete the device at the given index.
duplicate_clip_slot
Parameter:
index
Works like 'Duplicate' in a clip's context menu.
duplicate_clip_to_arrangement
Parameters:
clip
destination_time
[double]
Duplicate the given clip to the Arrangement, placing it at the given destination_time in beats.
jump_in_running_session_clip
Parameter:
beats
beats
[double] is the amount to jump relatively to the current clip
position.
Modify playback position in running Session clip, if any.
stop_all_clips
Stops all playing and fired clips in this track.
Track.View
Representing the view aspects of a track.
Canonical path
live_set tracks N view
Children
selected_device
Description
The selected device or the first selected device (in case of multi/group selection).
Properties
device_insert_mode
Description
Determines where a device will be inserted when loaded from the browser. 0 = add device at the end, 1 = add device to the left of the selected device, 2 = add device to the right of the selected device.
is_collapsed
Description
In Arrangement View: 1 = track collapsed, 0 = track opened.
Functions
select_instrument
Returns: bool 0 = there are no devices to select
Selects track's instrument or first device, makes it visible and
focuses on it.
ClipSlot
This class represents an entry in Live's Session View matrix.
The properties
playing_status
,
is_playing
and
is_recording
are useful for clip slots of Group Tracks. These are always empty and
represent the state of the clips in the tracks within the Group Track.
Canonical path
live_set tracks N clip_slots M
Children
Properties
color
Description
The color of the first clip in the Group Track if the clip slot is a Group Track slot.
color_index
Description
The color index of the first clip in the Group Track if the clip slot is a Group Track slot.
controls_other_clips
Description
1 for a Group Track slot that has non-deactivated clips in the tracks
within its group.
Control of empty clip slots doesn't count.
has_stop_button
Description
1 = this clip stops its track (or tracks within a Group Track).
is_triggered
Description
1 = clip slot button (Clip Launch, Clip Stop or Clip Record) or button of contained clip are blinking.
playing_status
Description
0 = all clips in tracks within a Group Track stopped or all tracks within a Group Track are empty.
1 = at least one clip in a track within a Group Track is playing.
2 = at least one clip in a track within a Group Track is playing or recording.
Equals 0 if this is not a clip slot of a Group Track.
Functions
create_audio_clip
Parameter: path
Given an absolute path to a valid audio file in a supported format, creates an
audio clip that references the file in the clip slot. Throws an error if the
clip slot doesn't belong to an audio track or if the track is frozen.
create_clip
Parameter:
length
Length is given in beats and must be a greater value than 0.0. Can only be called on empty
clip slots in MIDI tracks.
delete_clip
Deletes the contained clip.
duplicate_clip_to
Parameter: target_clip_slot [ClipSlot]
Duplicates the slot's clip to the given clip slot, overriding the target clip slot's clip if it's not empty.
fire
Parameter:
record_length (optional)
launch_quantization (optional)
Fires the clip or triggers the Stop Button, if any. Starts recording
if slot is empty and track is armed. Starts recording of armed and
empty tracks within a Group Track if Preferences->Launch->Start Recording on Scene
Launch is ON. If record_length is provided, the slot will record for the
given length in beats. launch_quantization overrides the global quantization
if provided.
set_fire_button_state
Parameter:
state
[bool]
1 = Live simulates pressing of Clip Launch
button until the state is set to 0 or until the slot is stopped
otherwise.
stop
Stops playing or recording clips in this track or the tracks within the group, if any. It doesn't matter on which slot of the track you call this function.
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.
Canonical path
live_set tracks N clip_slots M clip
Canonical path
live_set tracks N arrangement_clips M
Children
Properties
available_warp_modes
Description
Returns the list of indexes of the Warp Modes available for the clip. Only valid for audio clips.
color
Description
The RGB value of the clip's color in the form
0x00rrggbb
or (2^16 * red) + (2^8) * green + blue, where red, green and blue are
values from 0 (dark) to 255 (light).
When setting the RGB value, the nearest color from the clip color
chooser is taken.
end_marker
Description
The end marker of the clip in beats, independent of the loop state. Cannot be set before the start marker.
end_time
Description
The end time of the clip. For Session View clips, if Loop is on, this is the Loop End, otherwise it's the End Marker. For Arrangement View clips, this is always the position of the clip's rightmost edge in the Arrangement.
gain
Description
The gain of the clip (range is 0.0 to 1.0). Only valid for audio clips.
gain_display_string
Description
Get the gain display value of the clip as a string (e.g. "1.3 dB"). Can only be called on audio clips.
file_path
Description
Get the location of the audio file represented by the clip. Only available for audio clips.
groove
Description
Get/set/observe access to the groove associated with this clip.
Available since Live 11.0.
has_envelopes
Description
Get/observe whether the clip has any automation.
has_groove
Description
Returns true if a groove is associated with this clip.
Available since Live 11.0.
is_arrangement_clip
Description
1 = The clip is an Arrangement clip.
A clip can be either an Arrangement or a Session clip.
launch_mode
Description
The Launch Mode of the Clip as an integer index. Available Launch Modes are:
0 = Trigger (default)
1 = Gate
2 = Toggle
3 = Repeat
Available since Live 11.0.
launch_quantization
Description
The Launch Quantization of the Clip as an integer index. Available Launch Quantization values are:
0 = Global (default)
1 = None
2 = 8 Bars
3 = 4 Bars
4 = 2 Bars
5 = 1 Bar
6 = 1/2
7 = 1/2T
8 = 1/4
9 = 1/4T
10 = 1/8
11 = 1/8T
12 = 1/16
13 = 1/16T
14 = 1/32
Available since Live 11.0.
legato
Description
1 = Legato Mode switch in the Clip's Launch settings is on.
Available since Live 11.0.
length
Description
For looped clips: loop length in beats. Otherwise it's the distance in beats from start to end marker. Makes no sense for unwarped audio clips.
loop_end
Description
For looped clips: loop end.
For unlooped clips: clip end.
loop_jump
Description
Bangs when the clip play position is crossing the loop start marker (possibly projected into the loop).
loop_start
Description
For looped clips: loop start.
For unlooped clips: clip start.
loop_start and loop_end are in absolute clip beat time if clip is
MIDI or warped. The 1.1.1 position has beat time 0. If the clip is
unwarped audio, they are given in seconds, 0 is the time of the first
sample in the audio material.
looping
Description
1 = clip is looped. Unwarped audio cannot be looped.
muted
Description
1 = muted (i.e. the Clip Activator button of the clip is off).
notes
Description
Observer sends bang when the list of notes changes.
Available for MIDI clips only.
warp_markers
Description
The Clip's Warp Markers as a dict. Observing this property bangs when the warp_markers change.
The last Warp Marker in the dict is not visible in the Live interface. This hidden marker is used to calculate the BPM of the last segment.
Available for audio clips only.
Getting is available since Live 11.0.
pitch_coarse
Description
Pitch shift in semitones ("Transpose"), -48 ... 48.
Available for audio clips only.
pitch_fine
Description
Extra pitch shift in cents ("Detune"), -50 ... 49.
Available for audio clips only.
playing_position
Description
Current playing position of the clip.
For MIDI and warped audio clips, the value is given in beats of
absolute clip time. The clip's beat time of 0 is where 1 is shown in
the bar/beat/16th time scale at the top of the clip view.
For unwarped audio clips, the position is given in seconds, according
to the time scale shown at the bottom of the clip view.
Stopped clips have a playing position of 0.
playing_status
Description
Observer sends bang when playing/trigger status changes.
position
Description
Get and set the clip's loop position. The value will always equal loop_start, however setting this property, unlike setting loop_start, preserves the loop length.
start_marker
Description
The start marker of the clip in beats, independent of the loop state. Cannot be set behind the end marker.
start_time
Description
The start time of the clip, relative to the global song time. For Session View clips, this is the time the clip was started. For Arrangement View clips, this is the offset within the arrangement. The value is in beats.
velocity_amount
Description
How much the velocity of the note that triggers the clip affects its volume, 0 = no effect, 1 = full effect.
Available since Live 11.0.
warp_mode
Description
The Warp Mode of the clip as an integer index. Available Warp Modes are:
0 = Beats Mode
1 = Tones Mode
2 = Texture Mode
3 = Re-Pitch Mode
4 = Complex Mode
5 = REX Mode
6 = Complex Pro Mode
Available for audio clips only.
warping
Description
1 = Warp switch is on.
Available for audio clips only.
will_record_on_start
Description
1 for MIDI clips which are in triggered state, with the track armed and MIDI Arrangement Overdub on.
Functions
add_new_notes
Parameter:
dictionary
Key: "notes" [list of note specification dictionaries]
Note specification dictionaries have the following keys:
pitch: [int] the MIDI note number, 0...127, 60 is C3.
start_time: [float] the note start time in beats of absolute clip
time.
duration: [float] the note length in beats.
velocity (optional): [float] the note velocity, 0 ... 127
(100 by default).
mute (optional): [bool] 1 = the note is deactivated
(0 by default).
probability (optional): [float] the chance that the note will be
played:
1.0 = the note is always played
0.0 = the note is never played
(1.0 by default).
velocity_deviation (optional): [float] the range of velocity
values at which the note can be played:
0.0 = no deviation; the note will always play at the velocity specified by the
velocity property
-127.0 to 127.0 = the note will be assigned a velocity value between
velocity and velocity + velocity_deviation, inclusive;
if the resulting range exceeds the limits of MIDI velocity (0 to 127), then
it will be clamped within those limits
(0.0 by default).
release_velocity (optional): [float] the note release velocity
(64 by default).
Returns a list of note IDs of the added notes.
For MIDI clips only.
Available since Live 11.0.
add_warp_marker
Only available for warped Audio Clips. Adds the specified warp marker, if
possible.
The warp marker is specified as a dict which can have a
beat_time and a sample_time key, both associated
with float values.
The sample_time key may be omitted; in this
case, Live will calculate the appropriate sample time to create a warp marker at
the specified beat time without changing the Clip's playback timing, similar to
what would happen if you were to double-click in the upper half of the Sample
Display in Clip View.
If sample_time is specified, certain limitations must be taken
into account:
- The sample time must lie within the range [0, s], where s is the sample's length. The sample_length Clip property helps with this.
- The sample time must lie between the left and right adjacents markers' respective sample times (this is a logical constraint).
- Within these constraints, there are limitations on the resulting segments' BPM. The allowed BPM range is [5, 999].
apply_note_modifications
Parameter:
dictionary
Key: "notes" [list of note dictionaries] as returned from
get_notes_extended.
The list of note dictionaries passed to the function can be a subset of notes in
the clip, but will be ignored if it contains any notes that are not present in
the clip.
For MIDI clips only.
Available since Live 11.0. Replaces modifying notes with remove_notes followed by set_notes.
clear_all_envelopes
Removes all automation in the clip.
clear_envelope
Parameter:
device_parameter [id]
Removes the automation of the clip for the given parameter.
crop
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.
deselect_all_notes
Call this before replace_selected_notes if you just want to add some
notes.
Output:
deselect_all_notes id 0
For MIDI clips only.
duplicate_loop
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. Available for MIDI clips only.
duplicate_notes_by_id
Parameter:
list of note IDs.
Or
dictionary
Keys:
note_ids [list of note IDs] as returned from
get_notes_extended
destination_time (optional) [double/int]
transposition_amount (optional) [int]
Duplicates all notes matching the given note IDs.
Provided note IDs must be associated with existing notes in the clip.
Existing notes can be queried with get_notes_extended.
The selection of notes will be duplicated to destination_time, if
provided. Otherwise the new notes will be inserted after the last selected note.
This behavior can be observed when duplicating notes in the Live GUI.
If the transposition_amount is specified, the duplicated notes will be
transposed by the number of semitones.
Available for MIDI clips only.
Available since Live 11.1.2
duplicate_region
Parameter:
region_start [double/int]
region_length [double/int]
destination_time [double/int]
pitch (optional) [int]
transposition_amount (optional) [int]
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.
Available for MIDI clips only.
fire
Same effect as pressing the Clip Launch button.
get_all_notes_extended
Parameter:
dict (optional) [dict]
(See below for a discussion of this argument).
Returns a dictionary of all of the notes in the clip, regardless of where they
are positioned with respect to the start/end markers and the loop start/loop end,
as a list of note dictionaries. Each note dictionary consists of the following
key-value pairs:
note_id: [int] the unique note identifier.
pitch: [int] the MIDI note number, 0...127, 60 is C3.
start_time: [float] the note start time in beats of absolute clip
time.
duration: [float] the note length in beats.
velocity: [float] the note velocity, 0 ... 127.
mute: [bool] 1 = the note is deactivated.
probability: [float] the chance that the note will be played:
1.0 = the note is always played;
0.0 = the note is never played.
velocity_deviation: [float] the range of velocity values at which
the note can be played:
0.0 = no deviation; the note will always play at the velocity specified by the
velocity property
-127.0 to 127.0 = the note will be assigned a velocity value between
velocity and velocity + velocity_deviation, inclusive;
if the resulting range exceeds the limits of MIDI velocity (0 to 127), then
it will be clamped within those limits.
release_velocity: [float] the note release velocity.
It is possible to optionally provide a single [dict] argument to this function,
containing a single key-value pair: the key is "return" and the associated value
is a list of the note properties as listed above in the discussion of the
returned note dictionaries, e.g. ["note_id", "pitch", "velocity"]. The effect of
this will be that the returned note dictionaries will only contain the key-value
pairs for the specified properties, which can be useful to improve patch
performance when processing large notes dictionaries.
For MIDI clips only.
Available since Live 11.1
get_notes_by_id
Parameter:
list of note IDs.
Provided note IDs must be associated with existing notes in the clip.
Existing notes can be queried with get_notes_extended.
Returns a dictionary of notes associated with the provided IDs, as a list of
note dictionaries. Each note dictionary consists of the following key-value
pairs:
note_id: [int] the unique note identifier.
pitch: [int] the MIDI note number, 0...127, 60 is C3.
start_time: [float] the note start time in beats of absolute clip
time.
duration: [float] the note length in beats.
velocity: [float] the note velocity, 0 ... 127.
mute: [bool] 1 = the note is deactivated.
probability: [float] the chance that the note will be played:
1.0 = the note is always played;
0.0 = the note is never played.
velocity_deviation: [float] the range of velocity values at which
the note can be played:
0.0 = no deviation; the note will always play at the velocity specified by the
velocity property
-127.0 to 127.0 = the note will be assigned a velocity value between
velocity and velocity + velocity_deviation, inclusive;
if the resulting range exceeds the limits of MIDI velocity (0 to 127), then
it will be clamped within those limits.
release_velocity: [float] the note release velocity.
It is possible to optionally provide the argument to this function in the form
of a dictionary instead. The dictionary must include the "note_ids" key
associated with a list of [int]s, which are the ID values you would like to pass
to the function.
If you use this method, you can optionally provide an additional key-value pair:
the key is "return" and the associated value is a list of the note properties as
listed above in the discussion of the returned note dictionaries, e.g.
["note_id", "pitch", "velocity"]. The effect of this will be that the returned
note dictionaries will only contain the key-value pairs for the specified
properties, which can be useful to improve patch performance when processing
large notes dictionaries.
For MIDI clips only.
Available since Live 11.0.
get_notes_extended
Parameters:
from_pitch [int]
pitch_span [int]
from_time [float]
time_span [float]
from_time and time_span are given in beats.
Returns a dictionary of notes that have their start times in the given area, as
a list of note dictionaries. Each note dictionary consists of the following
key-value pairs:
note_id: [int] the unique note identifier.
pitch: [int] the MIDI note number, 0...127, 60 is C3.
start_time: [float] the note start time in beats of absolute clip
time.
duration: [float] the note length in beats.
velocity: [float] the note velocity, 0 ... 127.
mute: [bool] 1 = the note is deactivated.
probability: [float] the chance that the note will be played:
1.0 = the note is always played;
0.0 = the note is never played.
velocity_deviation: [float] the range of velocity values at which
the note can be played:
0.0 = no deviation; the note will always play at the velocity specified by the
velocity property
-127.0 to 127.0 = the note will be assigned a velocity value between
velocity and velocity + velocity_deviation, inclusive;
if the resulting range exceeds the limits of MIDI velocity (0 to 127), then
it will be clamped within those limits.
release_velocity: [float] the note release velocity.
It is possible to optionally provide the arguments to this function in the form
of a single dictionary instead. The dictionary must include all of the parameter
names given above as its keys; the associated values are the parameter values
you wish to pass to the function.
If you use this method, you can optionally provide an additional key-value pair:
the key is "return" and the associated value is a list of the note properties as
listed above in the discussion of the returned note dictionaries, e.g.
["note_id", "pitch", "velocity"]. The effect of this will be that the returned
note dictionaries will only contain the key-value pairs for the specified
properties, which can be useful to improve patch performance when processing
large notes dictionaries.
For MIDI clips only.
Available since Live 11.0. Replaces get_notes.
get_selected_notes_extended
Parameter:
dict (optional) [dict]
(See below for a discussion of this argument).
Returns a dictionary of the selected notes in the clip, as a list of note
dictionaries. Each note dictionary consists of the following key-value pairs:
note_id: [int] the unique note identifier.
pitch: [int] the MIDI note number, 0...127, 60 is C3.
start_time: [float] the note start time in beats of absolute clip
time.
duration: [float] the note length in beats.
velocity: [float] the note velocity, 0 ... 127.
mute: [bool] 1 = the note is deactivated.
probability: [float] the chance that the note will be played:
1.0 = the note is always played;
0.0 = the note is never played.
velocity_deviation: [float] the range of velocity values at which
the note can be played:
0.0 = no deviation; the note will always play at the velocity specified by the
velocity property
-127.0 to 127.0 = the note will be assigned a velocity value between
velocity and velocity + velocity_deviation, inclusive;
if the resulting range exceeds the limits of MIDI velocity (0 to 127), then
it will be clamped within those limits.
release_velocity: [float] the note release velocity.
It is possible to optionally provide a single [dict] argument to this function,
containing a single key-value pair: the key is "return" and the associated value
is a list of the note properties as listed above in the discussion of the
returned note dictionaries, e.g. ["note_id", "pitch", "velocity"]. The effect of
this will be that the returned note dictionaries will only contain the key-value
pairs for the specified properties, which can be useful to improve patch
performance when processing large notes dictionaries.
For MIDI clips only.
Available since Live 11.0. Replaces get_selected_notes.
move_playing_pos
Parameter:
beats
beats
[double] relative jump distance in beats. Negative beats jump
backwards.
Jumps by given amount, unquantized.
Unwarped audio clips, recording audio clips and recording non-overdub
MIDI clips cannot jump.
move_warp_marker
Parameters:
beat_time [double]
beat_time_distance [double]
Moves the warp marker specified by beat_time
the specified beat time distance.
quantize
Parameter:
quantization_grid [int]
amount [double]
Quantizes all notes in the clip to the quantization_grid taking the song's
swing_amount into account.
quantize_pitch
Parameter:
pitch [int]
quantization_grid [int]
amount [double]
Same as quantize, but only for notes in the given pitch.
remove_notes_by_id
Parameter:
list of note IDs.
Deletes all notes associated with the provided IDs.
Provided note IDs must be associated with existing notes in the clip.
Existing notes can be queried with get_notes_extended.
Available since Live 11.0.
remove_notes_extended
Parameter:
from_pitch [int]
pitch_span [int]
from_time [float]
time_span [float]
Deletes all notes that start in the given area. from_time and
time_span are given in beats.
Available since Live 11.0. Replaces remove_notes.
remove_warp_marker
Parameter: beat_time [float]
Removes the warp marker at the given beat time.
scrub
Parameter:
beat_time
[double]
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 stop_scrub() is called.
select_all_notes
Use this function to process all notes of a clip,
independent of the current selection.
Output:
select_all_notes id 0
For MIDI clips only.
select_notes_by_id
Parameter:
list of note IDs.
Selects all notes associated with the provided IDs.
Note that this function will not print a warning or error if the list contains nonexistent IDs.
Available since Live 11.0.6
set_fire_button_state
Parameter:
state
[bool]
If the state is set to 1, Live simulates pressing the clip start
button until the state is set to 0, or until the clip is otherwise stopped.
stop
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.
stop_scrub
Stops an active scrub on a clip.
Clip.View
Representing the view aspects of a Clip.
Canonical path
live_set tracks N clip_slots M clip view
Properties
grid_is_triplet
Description
Get/set whether the clip is displayed with a triplet grid.
Functions
hide_envelope
Hide the Envelopes box.
select_envelope_parameter
Parameter: [DeviceParameter]
Select the specified device parameter in the Envelopes box.
show_envelope
Show the Envelopes box.
show_loop
If the clip is visible in Live's Detail View, this function will make the current loop visible there.
Groove
This class represents a groove in Live.
Available since Live 11.0.
All grooves are stored in Live's groove pool.
Canonical path
live_set groove_pool grooves N
Canonical path
live_set tracks N clip_slots M clip groove
Children
base
Description
Get/set the groove's base grid (index based setter).
0 = 1/4
1 = 1/8
2 = 1/8T
3 = 1/16
4 = 1/16T
5 = 1/32
quantization_amount
Description
Get/set/observe the groove's quantization amount.
random_amount
Description
Get/set/observe the groove's random amount.
timing_amount
Description
Get/set/observe the groove's timing amount.
velocity_amount
Description
Get/set/observe the groove's velocity amount.
Device
This class represents a MIDI or audio device in Live.
Canonical path
live_set tracks N devices M
Canonical path
live_set tracks N devices M chains L devices K
Canonical path
live_set tracks N devices M return_chains L devices K
Children
parameters
Description
Only automatable parameters are accessible. See DeviceParameter to learn how to modify them.
Properties
class_display_name
Description
Get the original name of the device (e.g. Operator, Auto Filter).
class_name
Description
Live device type such as MidiChord , Operator , Limiter , MxDeviceAudioEffect , or PluginDevice .
is_active
Description
0 = either the device itself or its enclosing Rack device is off.
name
Description
This is the string shown in the title bar of the device.
type
Description
The type of the device. Possible types are: 0 = undefined, 1 = instrument, 2 = audio_effect, 4 = midi_effect.
Functions
store_chosen_bank
Parameters:
script_index
[int]
bank_index
[int]
(This is related to hardware control surfaces and is usually not
relevant.)
Device.View
Representing the view aspects of a Device.
Canonical path
live_set tracks N devices M view
Canonical path
live_set tracks N devices M chains L devices K view
Canonical path
live_set tracks N devices M return_chains L devices K view
Properties
is_collapsed
Description
1 = the device is shown collapsed in the device chain.
DeviceParameter
This class represents an (automatable) parameter within a MIDI or audio device. To modify a device parameter, set its value property or send its object ID to live.remote~ .
Canonical path
live_set tracks N devices M parameters L
Properties
automation_state
Description
Get the automation state of the parameter.
0 = no automation.
1 = automation active.
2 = automation overridden.
default_value
Description
Get the default value for this parameter.
Only available for parameters that aren't quantized (see is_quantized).
is_enabled
Description
1 = the parameter value can be modified directly by the user, by
sending
set
to a
live.object
, by automation or by an assigned MIDI message or keystroke.
Parameters can be disabled because they are macro-controlled, or they are controlled by a live-remote~ object,
or because Live thinks that they should not be moved.
is_quantized
Description
1 for booleans and enums
0 for int/float parameters
Although parameters like MidiPitch.Pitch appear quantized to the
user, they actually have an is_quantized value of 0.
name
Description
The short parameter name as shown in the (closed) automation chooser.
state
Description
The active state of the parameter.
0 = the parameter is active and can be changed.
1 = the parameter can be changed but isn't active, so changes won't have an audible effect.
2 = the parameter cannot be changed.
value_items
Description
Get a list of the possible values for this parameter.
Only available for parameters that are quantized (see is_quantized).
Functions
re_enable_automation
Re-enable automation for this parameter.
str_for_value
Parameter: value [float] Returns: [symbol] String representation of the specified value.
__str__
Returns: [symbol] String representation of the current parameter value.
RackDevice
This class represents a Live Rack Device.
A RackDevice is a type of Device, meaning that it has all the children, properties and functions that a Device has. Listed below are members unique to RackDevice.
Children
chain_selector
Description
Convenience accessor for the Rack's chain selector.
drum_pads
Description
All 128 Drum Pads for the topmost Drum Rack. Inner Drum Racks return a list of 0 entries.
visible_drum_pads
Description
All 16 visible DrumPads for the topmost Drum Rack. Inner Drum Racks return a list of 0 entries.
Properties
can_show_chains
Description
1 = The Rack contains an instrument device that is capable of showing its chains in Session View.
has_drum_pads
Description
1 = the device is a Drum Rack with pads. A nested Drum Rack is a Drum Rack without pads.
Only available for Drum Racks.
has_macro_mappings
Description
1 = any of a Rack's Macros are mapped to a parameter.
is_showing_chains
Description
1 = The Rack contains an instrument device that is showing its chains in Session View.
variation_count
Description
The number of currently stored macro variations.
Available since Live 11.0.
selected_variation_index
Description
Get/set the currently selected variation.
Available since Live 11.0.
Functions
copy_pad
Parameters:
source_index
[int]
destination_index
[int]
Copies all content of a Drum Rack pad from a source pad to a destination pad.
The source_index and destination_index refer to pad indices inside a
Drum Rack.
add_macro
Increases the number of visible macro controls.
Available since Live 11.0.
remove_macro
Decreases the number of visible macro controls.
Available since Live 11.0.
randomize_macros
Randomizes the values of eligible macro controls.
Available since Live 11.0.
store_variation
Stores a new variation of the values of all currently mapped macros.
Available since Live 11.0.
recall_selected_variation
Recalls the currently selected macro variation.
Available since Live 11.0.
recall_last_used_variation
Recalls the macro variation that was recalled most recently.
Available since Live 11.0.
delete_selected_variation
Deletes the currently selected macro variation.
Does nothing if there is no selected variation.
Available since Live 11.0.
RackDevice.View
Represents the view aspects of a Rack Device.
A RackDevice.View is a type of Device.View, meaning that it has all the properties that a Device.View has. Listed below are the members unique to RackDevice.View.
Children
selected_drum_pad
Description
Currently selected Drum Rack pad.
Only available for Drum Racks.
Properties
drum_pads_scroll_position
Description
Lowest row of pads visible, range: 0 - 28.
Only available for Drum Racks.
is_showing_chain_devices
Description
1 = the devices in the currently selected chain are visible.
DrumPad
This class represents a Drum Rack pad in Live.
Canonical path
live_set tracks N devices M drum_pads L
Children
Properties
solo
Description
1 = soloed (Solo switch on)
Does not automatically turn Solo off in other chains.
Functions
delete_all_chains
Chain
This class represents a group device chain in Live.
Canonical path
live_set tracks N devices M chains L
Canonical path
live_set tracks N devices M return_chains L
Canonical path
live_set tracks N devices M chains L devices K chains P ...
Canonical path
live_set tracks N devices M return_chains L devices K chains P ...
Children
Properties
color
Description
The RGB value of the chain's color in the form
0x00rrggbb
or (2^16 * red) + (2^8) * green + blue, where red, green and blue are
values from 0 (dark) to 255 (light).
When setting the RGB value, the nearest color from the color
chooser is taken.
is_auto_colored
Description
1 = the chain will always have the color of the containing track or chain.
solo
Description
1 = soloed (Solo switch on)
does not automatically turn Solo off in other chains.
Functions
delete_device
Parameter:
index [int]
Delete the device at the given index.
DrumChain
This class represents a Drum Rack device chain in Live.
A DrumChain is a type of Chain, meaning that it has all the children, properties and functions that a Chain has. Listed below are the members unique to DrumChain.
ChainMixerDevice
This class represents a chain's mixer device in Live.
Canonical path
live_set tracks N devices M chains L mixer_device
Canonical path
live_set tracks N devices M return_chains L mixer_device
Children
sends
Description
[in Audio Effect Racks and Instrument Racks only]
For Drum Racks, otherwise empty.
ShifterDevice
This class represents an instance of the Shifter audio effect.
A ShifterDevice is a type of device, meaning that it has all the children, properties and functions that a device has. Listed below are members unique to ShifterDevice.
SimplerDevice
This class represents an instance of Simpler.
A SimplerDevice is a type of device, meaning that it has all the children, properties and functions that a device has. Listed below are members unique to SimplerDevice.
Children
Properties
pad_slicing
Description
1 = slices can be added in Slicing Mode by playing notes which are not yet assigned to existing slices.
playback_mode
Description
Get/set Simpler's playback mode.
0 = Classic Mode
1 = One-Shot Mode
2 = Slicing Mode
playing_position
Description
The current playing position in the sample, expressed as a value between 0. and 1.
playing_position_enabled
Description
1 = Simpler is playing back the sample and showing the playing position.
slicing_playback_mode
Description
Get/set Simpler's Slicing Playback Mode.
0 = Mono
1 = Poly
2 = Thru
Functions
crop
Crop the loaded sample to the active region between the start and end markers.
guess_playback_length
Returns: [float] An estimated beat time for the playback length between the start and end markers.
reverse
Reverse the loaded sample.
warp_as
Parameters: beats [int]
Warp the active region between the start and end markers as the specified number of beats.
warp_double
Double the playback tempo of the active region between the start and end markers.
warp_half
Halve the playback tempo for the active region between the start and end markers.
SimplerDevice.View
Represents the view aspects of a SimplerDevice.
A SimplerDevice.View is a type of Device.View, meaning that it has all the properties that a Device.View has. Listed below are the members unique to SimplerDevice.View.
Properties
selected_slice
Description
The currenctly selected slice, identified by its slice time.
Sample
This class represents a sample file loaded into Simpler.
Canonical path
live_set tracks N devices N sample
Properties
beats_granulation_resolution
Description
Get/set which divisions to preserve in the sample in Beats Mode.
0 = 1 Bar
1 = 1/2
2 = 1/4
3 = 1/8
4 = 1/16
5 = 1/32
6 = Transients
beats_transient_envelope
Description
Get/set the duration of a volume fade applied to each segment of audio in Beats Mode.
0 = fastest decay
100 = no fade
beats_transient_loop_mode
Description
Get/set the Transient Loop Mode applied to each segment of audio in Beats Mode.
0 = Off
1 = Loop Forward
2 = Loop Back-and-Forth
complex_pro_envelope
Description
Get/set the Envelope parameter in Complex Pro Mode.
complex_pro_formants
Description
Get/set the Formants parameter in Complex Pro Mode.
end_marker
Description
Get/set the position of the sample's end marker.
sample_rate
Description
The sample rate of the loaded sample.
Available since Live 11.0.
slices
Description
The positions of all playable slices in the sample, in sample frames. Divide these values by the sample_rate to get the slice times in seconds.
Available since Live 11.0.
slicing_sensitivity
Description
Get/set the slicing sensitivity. Values are between 0.0 and 1.0.
start_marker
Description
Get/set the position of the sample's start marker.
texture_flux
Description
Get/set the Flux parameter in Texture Mode.
texture_grain_size
Description
Get/set the Grain Size parameter in Texture Mode.
tones_grain_size
Description
Get/set the Grain Size parameter in Tones Mode.
warp_markers
Description
The Sample's Warp Markers as a dict. Observing this property bangs when the warp_markers change.
The last Warp Marker in the dict is not visible in the Live interface. This hidden, or "shadow" marker is used to calculate the BPM of the last segment.
Available since Live 11.0.
warp_mode
Description
Get/set the Warp Mode.
0 = Beats Mode
1 = Tones Mode
2 = Texture Mode
3 = Re-Pitch Mode
4 = Complex Mode
6 = Complex Pro Mode
slicing_style
Description
Get/set the Slicing Mode.
0 = Transient
1 = Beat
2 = Region
3 = Manual
slicing_beat_division
Description
Get/set the slice beat division in Beat Slicing Mode.
0 = 1/16
1 = 1/16T
2 = 1/8
3 = 1/8T
4 = 1/4
5 = 1/4T
6 = 1/2
7 = 1/2T
8 = 1 Bar
9 = 2 Bars
10 = 4 Bars
slicing_region_count
Description
Get/set the number of slice regions in Region Slicing Mode.
Functions
gain_display_string
Returns: [list of symbols] The sample's gain value as a string, e.g. "0.0 dB".
insert_slice
Parameters: slice_time [int]
Insert a new slice at the specified time if there is none.
move_slice
Parameters: source_time [int] destination_time [int]
Move an existing slice to a specified time.
remove_slice
Parameters: slice_time [int]
Remove a slice at the specified time if it exists.
clear_slices
Clear all slices created in Manual Slicing Mode.
reset_slices
Reset all edited slices to their original positions.
WavetableDevice
This class represents a Wavetable instrument.
A WavetableDevice shares all of the children, functions and properties that a Device has. Listed below
are members unique to it.
Properties
filter_routing
Description
Access to the current filter routing. 0 = Serial, 1 = Parallel, 2 = Split.
mono_poly
Description
Access to Wavetable's Poly/Mono switch. 0 = Mono, 1 = Poly.
oscillator_1_effect_mode
Description
Access to oscillator 1's effect mode. 0 = None, 1 = Fm, 2 = Classic, 3 = Modern.
oscillator_2_effect_mode
Description
Access to oscillator 2's effect mode.
oscillator_1_wavetable_category
Description
Access to oscillator 1's wavetable category selector.
oscillator_2_wavetable_category
Description
Access to oscillator 2's wavetable category selector.
oscillator_1_wavetable_index
Description
Access to oscillator 1's wavetable index selector.
oscillator_2_wavetable_index
Description
Access to oscillator 2's wavetable index selector.
oscillator_1_wavetables
Description
List of names of the wavetables currently available for oscillator 1. Depends on the current wavetable category selection (see oscillator_1_wavetable_category).
oscillator_2_wavetables
Description
List of names of the wavetables currently available for oscillator 2. Depends on the current wavetable category selection (see oscillator_2_wavetable_category).
oscillator_wavetable_categories
Description
List of the names of the available wavetable categories.
unison_mode
Description
Access to Wavetable's unison mode parameter.
0 = None
1 = Classic
2 = Shimmer
3 = Noise
4 = Phase Sync
5 = Position Spread
6 = Random Note
unison_voice_count
Description
Access to the number of unison voices.
visible_modulation_target_names
Description
List of the names of modulation targets currently visible in the modulation matrix.
Functions
add_parameter_to_modulation_matrix
Parameter: parameter_to_add [DeviceParameter]
Add an instrument parameter to the modulation matrix. Only works for parameters that can be modulated (see is_parameter_modulatable).
get_modulation_target_parameter_name
Parameter: index [int]
Return the modulation target parameter name at index in the modulation matrix as a [symbol].
get_modulation_value
Parameters: modulation_target_index [int] modulation_source_index [int]
Return the amount of the modulation of the parameter at modulation_target_index by the
modulation source at modulation_source_index in Wavetable's modulation matrix.
is_parameter_modulatable
Parameter: parameter [DeviceParameter]
1 = parameter can be modulated. Call this before add_parameter_to_modulation_matrix.
set_modulation_value
Parameters: modulation_target_index [int] modulation_source_index [int]
Set the amount of the modulation of the parameter at modulation_target_index by the
modulation source at modulation_source_index in Wavetable's modulation matrix.
CompressorDevice
This class represents a Compressor device in Live.
A CompressorDevice shares all of the children, functions and properties of a Device; listed below are the
members unique to it.
Properties
available_input_routing_channels
Description
The list of available source channels for the compressor's input routing in the sidechain.
It's represented as a dictionary with the following key:
available_input_routing_channels [list]
The list contains dictionaries as described in input_routing_channel.
available_input_routing_types
Description
The list of available source types for the compressor's input routing in the sidechain.
It's represented as a dictionary with the following key:
available_input_routing_types [list]
The list contains dictionaries as described in input_routing_type.
input_routing_channel
Description
The currently selected source channel for the compressor's input routing in the sidechain.
It's represented as a dictionary with the following keys:
display_name [symbol]
identifier [symbol]
Can be set to all values found in the compressor's
available_input_routing_channels.
input_routing_type
Description
The currently selected source type for the compressor's input routing in the sidechain.
It's represented as a dictionary with the following keys:
display_name [symbol]
identifier [symbol]
Can be set to all values found in the track's available_input_routing_types.
PluginDevice
This class represents a plug-in device.
A PluginDevice is a type of Device, meaning that it has all the children, properties and functions that a Device has. Listed below are the members unique to PluginDevice.
Properties
selected_preset_index
Description
Get/set the index of the currently selected preset.
MaxDevice
This class represents a Max for Live device in Live.
A MaxDevice is a type of Device, meaning that it has all the children, properties and functions that a Device has. Listed below are the members unique to MaxDevice.
Properties
audio_inputs
Description
List of the audio inputs that the MaxDevice offers.
audio_outputs
Description
List of the audio outputs that the MaxDevice offers.
midi_inputs
Description
List of the midi inputs that the MaxDevice offers.
Available since Live 11.0.
midi_outputs
Description
List of the midi outputs that the MaxDevice offers.
Available since Live 11.0.
Functions
get_bank_count
Returns: [int] the number of parameter banks.
get_bank_name
Parameters: bank_index [int]
Returns: [list of symbols] The name of the parameter bank specified by bank_index.
get_bank_parameters
Parameters: bank_index [int]
Returns: [list of ints] The indices of the parameters contained in the bank specified by bank_index. Empty slots are marked as -1. Bank index -1 refers to the "Best of" bank.
MixerDevice
This class represents a mixer device in Live. It provides access to volume, panning and other DeviceParameter objects. See DeviceParameter to learn how to modify them.
Canonical path
live_set tracks N mixer_device
Children
left_split_stereo
Description
The Track's Left Split Stereo Pan Parameter.
right_split_stereo
Description
The Track's Right Split Stereo Pan Parameter.
Properties
crossfade_assign
Description
0 = A, 1 = none, 2 = B [not in master track]
panning_mode
Description
Access to the Track mixer's pan mode: 0 = Stereo, 1 = Split Stereo.
Eq8Device
This class represents an instance of an EQ Eight device in Live.
An Eq8Device has all the properties, functions and children of a Device.
Listed below are members unique to Eq8Device.
Properties
edit_mode
Description
Access to EQ Eight's edit mode, which toggles the channel currently
available for editing. The available edit modes depend on the global mode
(see global_mode) and are encoded as follows:
In L/R mode: 0 = L, 1 = R
In M/S mode: 0 = M, 1 = S
In Stereo mode: 0 = A, 1 = B (inactive)
global_mode
Description
Access to EQ Eight's global mode. The modes are encoded as follows:
0 = Stereo
1 = L/R
2 = M/S
oversample
Description
Access to EQ Eight's Oversampling parameter. 0 = Off, 1 = On.
Eq8Device.View
Represents the view aspects of an Eq8Device.
An Eq8Device.View has all the children, properties and functions of a Device.View.
Listed below are members unique to it.
Properties
selected_band
Description
The index of the currently selected filter band.
DriftDevice
This class represents an instance of a Drift device in Live.
A DriftDevice has all the properties, functions and children of a Device.
Properties
mod_matrix_filter_source_1_index
Description
The index of the available sources for modulating the Filter Frequency for the first modulation slot.
mod_matrix_filter_source_1_list
Description
The list of the available sources for modulating the Filter Frequency for the first modulation slot.
mod_matrix_filter_source_2_index
Description
The index of the available sources for modulating the Filter Frequency for the second modulation slot.
mod_matrix_filter_source_2_list
Description
The list of the available sources for modulating the Filter Frequency for the second modulation slot.
mod_matrix_lfo_source_index
Description
The index of the available sources for modulating the LFO Amount.
mod_matrix_lfo_source_list
Description
The list of the available sources for modulating the LFO Amount.
mod_matrix_pitch_source_1_index
Description
The index of the available sources for modulating the Pitch for the first modulation slot.
mod_matrix_pitch_source_1_list
Description
The list of the available sources for modulating the Pitch for the first modulation slot.
mod_matrix_pitch_source_2_index
Description
The index of the available sources for modulating the Pitch for the second modulation slot.
mod_matrix_pitch_source_2_list
Description
The list of the available sources for modulating the Pitch for the second modulation slot.
mod_matrix_shape_source_index
Description
The index of the available sources for modulating Shape.
mod_matrix_shape_source_list
Description
The list of the available sources for modulating Shape.
mod_matrix_source_1_index
Description
The index of the available sources for the first custom modulation slot.
mod_matrix_source_1_list
Description
The list of the available sources for the first custom modulation slot.
mod_matrix_source_2_index
Description
The index of the available sources for the second custom modulation slot.
mod_matrix_source_2_list
Description
The list of the available sources for the second custom modulation slot.
mod_matrix_source_3_index
Description
The index of the available sources for the third custom modulation slot.
mod_matrix_source_3_list
Description
The list of the available sources for the third custom modulation slot.
mod_matrix_target_1_index
Description
The index of the available targets for the first custom modulation slot.
mod_matrix_target_1_list
Description
The list of the available targets for the first custom modulation slot.
mod_matrix_target_2_index
Description
The index of the available targets for the second custom modulation slot.
mod_matrix_target_2_list
Description
The list of the available targets for the second custom modulation slot.
mod_matrix_target_3_index
Description
The index of the available targets for the third custom modulation slot.
mod_matrix_target_3_list
Description
The list of the available targets for the third custom modulation slot.
pitch_bend_range
Description
The amount for the MIDI Pitch Bend range in semitones.
voice_count_index
Description
The index of the voice count parameter.
voice_mode_index
Description
The index of the voice mode utilized by Drift.
DrumCellDevice
This class represents an instance of a Drum Sampler device in Live.
A DrumCell has all the properties, functions and children of a Device.
Listed below are members unique to DrumCell Device.
Properties
HybridReverbDevice
This class represents an instance of a Hybrid Reverb device in Live.
A HybridReverbDevice has all the properties, functions and children of a Device.
Listed below are members unique to HybridReverbDevice.
Properties
ir_attack_time
Description
The attack time of the amplitude envelope for the impulse response, in seconds.
ir_category_index
Description
The index of the selected impulse response category.
ir_decay_time
Description
The decay time of the amplitude envelope for the impulse response, in seconds.
ir_file_index
Description
The index of the selected impulse response files from the current category.
ir_file_list
Description
The list of impulse response files from the selected category.
ir_size_factor
Description
The relative size of the impulse response, 0.0 to 1.0.
ir_time_shaping_on
Description
Enables transforming the current selected impulse response with an amplitude envelope and size parameter.
1 = enabled.
MeldDevice
This class represents an instance of a Meld device in Live.
A MeldDevice has all the properties, functions and children of a Device.
Properties
selected_engine
Description
Meld's oscillator engine selector. The modes are encoded as follows:
0 = Engine A
1 = Engine B
unison_voices
Description
Selects the Unison voice count. The modes are encoded as follows:
0 = off
1 = two
2 = three
3 = four
mono_poly
Description
Selects the polyphony mode. The modes are encoded as follows:
0 = mono
1 = poly
poly_voices
Description
Selects the polyphony voice count. The modes are encoded as follows:
0 = two
1 = three
2 = four
3 = five
4 = six
5 = eight
6 = twelve
RoarDevice
This class represents an instance of a Roar device in Live.
A RoarDevice has all the properties, functions and children of a Roar Device.
SpectralResonatorDevice
This class represents an instance of a Spectral Resonator device in Live.
An SpectralResonatorDevice has all the properties, functions and children of a Device.
Listed below are members unique to SpectralResonatorDevice.
Properties
frequency_dial_mode
Description
Get, set and observe the Freq control's mode.
0 = Hertz, 1 = MIDI note values.
midi_gate
Description
Get, set and observe the MIDI gate switch's state.
0 = Off, 1 = On.
mod_mode
Description
Get, set and observe the Modulation Mode.
0 = None, 1 = Chorus, 2 = Wander, 3 = Granular.
mono_poly
Description
Get, set and observe the Mono/Poly switch's state.
0 = Mono, 1 = Poly.
pitch_mode
Description
Get, set and observe the Pitch Mode.
0 = Internal, 1 = MIDI.
pitch_bend_range
Description
Get, set and observe the Pitch Bend Range.
polyphony
Description
Get, set and observe the Polyphony.
0 = 2, 1 = 4, 2 = 8, 3 = 16 voices.
LooperDevice
This class represents an instance of a Looper device in Live.
An LooperDevice has all the properties, functions and children of a Device.
Listed below are members unique to LooperDevice.
Properties
overdub_after_record
Description
1 = Looper will switch to overdub after recording, when recording a fixed number of bars. 0 = switch to playback without overdubbing.
record_length_index
Description
Access to the Record Length chooser entry index.
record_length_list
Description
Access to the list of Record Length chooser entry strings.
Functions
clear
Erase Looper's recorded content.
double_speed
Double the speed of Looper's playback.
half_speed
Halve the speed of Looper's playback.
double_length
Double the length of Looper's buffer.
half_length
Halve the length of Looper's buffer.
record
Record incoming audio.
overdub
Play back while adding additional layers of incoming audio.
play
Play back without overdubbing.
stop
Stop Looper's playback.
undo
Erase everything that was recorded since the last time Overdub was enabled. Calling a second time will restore the material erased by the previous undo operation.
export_to_clip_slot
Parameter: clip_slot [ClipSlot]
The target clip slot.
Given a valid LOM ID of an empty clip slot on a non-frozen audio track, will
export Looper's content to a clip in that slot. This is similar to using the
Drag Me! control on the Looper device, and the same restrictions apply: the
audio engine must be turned on, the Looper must actually hold audio content, the
content must have a fixed length (i.e. Looper must not be recording), etc.
DeviceIO
This class represents an input or output bus of a Live device.
Properties
available_routing_channels
Description
The available channels for this input/output bus.
The channels are represented as a dictionary with the following key:
available_routing_channels [list]
The list contains dictionaries as described in routing_channel.
available_routing_types
Description
The available types for this input/output bus.
The types are represented as a dictionary with the following key:
available_routing_types [list]
The list contains dictionaries as described in routing_type.
default_external_routing_channel_is_none
Description
1 = the default routing channel for External routing types is none.
Available since Live 11.0.
routing_channel
Description
The current routing channel for this input/output bus. It is represented as a dictionary
with the following keys:
display_name [symbol]
identifier [symbol]
Can be set to any of the values found in available_routing_channels.
routing_type
Description
The current routing type for this input/output bus. It is represented as a dictionary
with the following keys:
display_name [symbol]
identifier [symbol]
Can be set to any of the values found in available_routing_types.
Scene
This class represents a series of clip slots in Live's Session View matrix.
Canonical path
live_set scenes N
Children
Properties
color
Description
The RGB value of the scene's color in the form
0x00rrggbb
or (2^16 * red) + (2^8) * green + blue, where red, green and blue are
values from 0 (dark) to 255 (light).
When setting the RGB value, the nearest color from the Scene color
chooser is taken.
tempo
Description
The scene's tempo.
Returns -1 if the scene tempo is disabled.
tempo_enabled
Description
The active state of the scene tempo.
When disabled, the scene will use the song's tempo,
and the tempo value returned will be -1.
time_signature_numerator
Description
The scene's time signature numerator.
Returns -1 if the scene time signature is disabled.
time_signature_denominator
Description
The scene's time signature denominator.
Returns -1 if the scene time signature is disabled.
time_signature_enabled
Description
The active state of the scene time signature.
When disabled, the scene will use the song's time signature,
and the time signature values returned will be -1.
Functions
fire
Parameter:
force_legato (optional) [bool]
can_select_scene_on_launch (optional) [bool]
Fire all clip slots contained within the scene and select this scene.
Starts recording of armed and empty tracks within a Group Track in this scene if
Preferences->Launch->Start Recording on Scene Launch is ON.
Calling with force_legato = 1 (default = 0) will launch all clips
immediately in Legato, independent of their launch mode.
When calling with can_select_scene_on_launch = 0 (default = 1) the scene
is fired without selecting it.
fire_as_selected
Parameter:
force_legato (optional) [bool]
Fire the selected scene, then select the next scene.
It doesn't matter on which scene you are calling this function.
Calling with force_legato = 1 (default = 0) will launch all clips
immediately in Legato, independent of their launch mode.
set_fire_button_state
Parameter:
state
[bool]
If the state is set to 1, Live simulates pressing of scene button
until the state is set to 0 or until the scene is stopped otherwise.
CuePoint
Represents a locator in the Arrangement View.
ControlSurface
A ControlSurface can be reached either directly by the root path
control_surfaces N or by getting a list of active control surface IDs,
via calling get control_surfaces on an Application object.
The latter list is in the same order in which control surfaces appear in Live's
Link/MIDI Preferences. Note the same order is not guaranteed when getting a control surface
via the control_surfaces N path.
A control surface can be thought of as a software layer between the Live API and, in this case,
Max for Live. Individiual controls on the surface are represented by objects that can be grabbed
and released via Max for Live, to obtain and give back exclusive control (see grab_control and
release_control). In this way, parts of the hardware can be controlled via Max for Live
while other parts can retain their default functionality.
Additionally, Live offers a special MaxForLive control surface that has a
register_midi_control function. Using this, Max for Live developers can
set up entirely custom control surfaces by adding and grabbing arbitrary controls.
Canonical path
control_surfaces N
Functions
get_control
Parameter:
name
Returns the control with the given name.
get_control_names
Returns the list of all control names.
grab_control
Parameter:
control
Take ownership of the control. This releases all standard functionality of the control,
so that it can be used exclusively via Max for Live.
grab_midi
Forward MIDI messages received from the control surface to Max for Live.
register_midi_control
Parameters:
name [symbol]
status [int]
number [int]
(MaxForLive control surface only) Register a MIDI control defined by status and
number. Supported status codes are 144 (note on), 176 (continuous control)
and 224 (pitchbend).
Returns the LOM ID associated with the control.
Once a control is registered and grabbed via grab_control, Live will forward associated
MIDI messages that it receives to Max for Live. Max for Live can send values to the control (e.g.
to light an LED) by calling send_value on the control object.
release_control
Parameter:
control
Re-establishes the standard functionality for the control.
release_midi
Stop forwarding MIDI messages received from the control surface to Max for Live.
send_midi
Parameter: midi_message [list of int]
Send midi_message to the control surface.
send_receive_sysex
Parameters:
sysex_message [list of int]
timeout [symbol, int]
Send sysex_message to the control surface and await a response.
If the message is followed by the word timeout and a float, this sets
the response timeout accordingly. The default timeout value is 0.2.
If the response times out and MIDI has not been grabbed via grab_midi,
it's not forwarded to Max for Live. If MIDI has been grabbed via Max for Live,
received messages are always forwarded, but the timeout is still reported.
this_device
This root path represents the device containing the live.path object to which the goto this_device message is sent. The class of this object is Device .
Canonical path
live_set tracks N devices M
See Also
| Name | Description |
|---|---|
| Max For Live | Max For Live |