Live.Clip (runtime)¶
Live 9, Live Object Model & framework reference (descriptions and signatures).
Live Object Model, from the Live 9 API XML documentation.
Classes¶
class AutomationEnvelope¶
Describes parameter automation per clip.
Methods¶
insert_step(arg1,arg2,arg3,arg4)¶
value_at_time(arg1,arg2)¶
class Clip¶
This class represents a Clip in Live. It can be either an AudioClip or a MIDI Clip, in an Arrangement or the Session, dependingon the Track (Slot) it lives in.
Properties¶
_live_ptravailable_warp_modes- Available for AudioClips only.Get/Set the available warp modes, that can be used.canonical_parent- Get the canonical parent of the Clip.color- Get/set access to the color of the Clip (RGB).color_index- Get/set access to the color index of the Clip.end_marker- Get/Set the Clips end marker pos in beats/seconds (unit depends on warping).file_path- Get the path of the file represented by the Audio Clip.gain- Available for AudioClips only.Read/write access to the gain setting of theAudio Clipgain_display_string- Return a string with the gain as dB valuehas_envelopes- Will notify if the clip gets his first envelope or the last envelope is removed.is_arrangement_clip- return true if this Clip is an Arrangement Clip.A Clip can be either a Session or Arrangement Clip.is_audio_clip- Return true if this Clip is an Audio Clip.A Clip can be either an Audioclip or a MIDI Clip.is_midi_clip- return true if this Clip is a MIDI Clip.A Clip can be either an Audioclip or a MIDI Clip.is_overdubbing- returns true if the Clip is recording overdubsis_playing- Get/Set if this Clip is currently playing. If the Clips trigger modeis set to a quantization value, the Clip will not start playing immediately.If you need to know wether the Clip was triggered, use the is_triggered property.is_recording- returns true if the Clip was triggered to record or is recording.is_triggered- returns true if the Clip was triggered or is playing.length- Get to the Clips length in beats/seconds (unit depends on warping).loop_end- Get/Set the loop end pos of this Clip in beats/seconds (unit depends on warping).loop_start- Get/Set the Clips loopstart pos in beats/seconds (unit depends on warping).looping- Get/Set the Clips 'loop is enabled' flag.Only Warped Audio Clips or MIDI Clip can be looped.muted- Read/write access to the mute state of the Clip.name- Read/write access to the name of the Clip.pitch_coarse- Available for AudioClips only.Read/write access to the pitch (in halftones) setting of theAudio Clip, ranging from -48 to 48pitch_fine- Available for AudioClips only.Read/write access to the pitch fine setting of theAudio Clip, ranging from -500 to 500playing_position- Constant access to the current playing position of the clip.The returned value is the position in beats for midi and warped audio clips,or in seconds for unwarped audio clips. Stopped clips will return 0.position- Get/Set the loop position of this Clip in beats/seconds (unit depends on warping).ram_mode- Available for AudioClips only.Read/write access to the Ram mode setting of the Audio Clipsignature_denominator- Get/Set access to the global signature denominator of the Clip.signature_numerator- Get/Set access to the global signature numerator of the Clip.start_marker- Get/Set the Clips start marker pos in beats/seconds (unit depends on warping).start_time- Get the clips start time offset.view- Get the view of the Clip.warp_mode- Available for AudioClips only.Get/Set the warp mode for this audio clip.warping- Available for AudioClips only.Get/Set if this Clip is timestreched.will_record_on_start- returns true if the Clip will record on being started.
Methods¶
add_color_index_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "color_index" has changed.
add_color_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "color" has changed.
add_end_marker_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "end_marker" has changed.
add_file_path_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "file_path" has changed.
add_gain_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "gain" has changed.
add_has_envelopes_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "has_envelopes" has changed.
add_is_overdubbing_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "is_overdubbing" has changed.
add_is_recording_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "is_recording" has changed.
add_loop_end_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "loop_end" has changed.
add_loop_jump_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "loop_jump" has changed.
add_loop_start_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "loop_start" has changed.
add_looping_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "looping" has changed.
add_muted_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "muted" has changed.
add_name_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "name" has changed.
add_notes_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "notes" has changed.
add_pitch_coarse_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "pitch_coarse" has changed.
add_pitch_fine_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "pitch_fine" has changed.
add_playing_position_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "playing_position" has changed.
add_playing_status_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "playing_status" has changed.
add_position_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "position" has changed.
add_ram_mode_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "ram_mode" has changed.
add_signature_denominator_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "signature_denominator" has changed.
add_signature_numerator_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "signature_numerator" has changed.
add_start_marker_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "start_marker" has changed.
add_warp_mode_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "warp_mode" has changed.
add_warping_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "warping" has changed.
automation_envelope(arg1,arg2)¶
Return the envelope for the given parameter.Returns None for Arrangement clips.Returns None for parameters from a different track.
clear_all_envelopes(arg1)¶
Clears all envelopes for this clip.
clear_envelope(arg1,arg2)¶
Clears the envelope of this clips given parameter.
color_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "color".
color_index_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "color_index".
deselect_all_notes(arg1)¶
De-selects all notes present in the clip.
duplicate_loop(arg1)¶
Make the loop two times longer and duplicates notes and envelopes. Duplicates the clip start/end range if the clip is not looped.
end_marker_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "end_marker".
file_path_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "file_path".
fire(arg1)¶
(Re)Start playing this Clip.
gain_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "gain".
get_notes(arg1,arg2,arg3,arg4,arg5)¶
Returns a tuple of tuples where each inner tuple represents a note starting in the given pitch- and time range. The inner tuple contains pitch, time, duration, velocity, and mute state.
get_selected_notes(arg1)¶
Returns a tuple of tuples where each inner tuple represents a selected note. The inner tuple contains pitch, time, duration, velocity, and mute state.
has_envelopes_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "has_envelopes".
is_overdubbing_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "is_overdubbing".
is_recording_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "is_recording".
loop_end_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "loop_end".
loop_jump_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "loop_jump".
loop_start_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "loop_start".
looping_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "looping".
move_playing_pos(arg1,arg2)¶
Jump forward or backward by the specified relative amount in beats. Will do nothing, if the Clip is not playing.
muted_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "muted".
name_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "name".
notes_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "notes".
pitch_coarse_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "pitch_coarse".
pitch_fine_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "pitch_fine".
playing_position_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "playing_position".
playing_status_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "playing_status".
position_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "position".
quantize(arg1,arg2,arg3)¶
Quantize all notes in a clip or align warp markers.
quantize_pitch(arg1,arg2,arg3,arg4)¶
Quantize all the notes of a given pitch. Raises an error on audio clips.
ram_mode_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "ram_mode".
remove_color_index_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "color_index".
remove_color_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "color".
remove_end_marker_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "end_marker".
remove_file_path_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "file_path".
remove_gain_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "gain".
remove_has_envelopes_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "has_envelopes".
remove_is_overdubbing_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "is_overdubbing".
remove_is_recording_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "is_recording".
remove_loop_end_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "loop_end".
remove_loop_jump_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "loop_jump".
remove_loop_start_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "loop_start".
remove_looping_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "looping".
remove_muted_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "muted".
remove_name_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "name".
remove_notes(arg1,arg2,arg3,arg4,arg5)¶
Delete all notes starting in the given pitch- and time range.
remove_notes_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "notes".
remove_pitch_coarse_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "pitch_coarse".
remove_pitch_fine_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "pitch_fine".
remove_playing_position_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "playing_position".
remove_playing_status_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "playing_status".
remove_position_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "position".
remove_ram_mode_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "ram_mode".
remove_signature_denominator_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "signature_denominator".
remove_signature_numerator_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "signature_numerator".
remove_start_marker_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "start_marker".
remove_warp_mode_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "warp_mode".
remove_warping_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "warping".
replace_selected_notes(arg1,arg2)¶
Called with a tuple of tuples where each inner tuple represents a note in the same format as returned by get_selected_notes. The notes described that way will then be used to replace the old selection.
scrub(self,scrub_position)¶
Scrubs inside a clip. scrub_position defines the position in beats that the scrub will start from. The scrub will continue until stop_scrub is called. Global quantization applies to the scrub's position and length.
select_all_notes(arg1)¶
Selects all notes present in the clip.
set_fire_button_state(arg1,arg2)¶
Set the clip's fire button state directly. Supports all launch modes.
set_notes(arg1,arg2)¶
Called with a tuple of tuples where each inner tuple represents a note in the same format as returned by get_notes. The notes described that way will then be added to the clip.
signature_denominator_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "signature_denominator".
signature_numerator_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "signature_numerator".
start_marker_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "start_marker".
stop(arg1)¶
Stop playing this Clip.
stop_scrub(arg1)¶
Stops the current scrub.
warp_mode_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "warp_mode".
warping_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "warping".
class Clip.View¶
Representing the view aspects of a Clip.
Properties¶
_live_ptrcanonical_parent- Get the canonical parent of the clip view.grid_is_triplet- Get/set wether the grid is showing in triplet mode.grid_quantization- Get/set clip grid quantization resolution.sample_end_marker- Get the clips end marker in sample time or -1 if there is no sample available.sample_length- Get the sample length in sample time or -1 if there is no sample available.sample_loop_end- Get the clips loop end marker in sample time or -1 if there is no sample available.sample_loop_start- Get the clips loop start in sample time or -1 if there is no sample available.sample_start_marker- Get the clips start marker in sample time or -1 if there is no sample available.
Methods¶
add_sample_end_marker_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "sample_end_marker" has changed.
add_sample_loop_end_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "sample_loop_end" has changed.
add_sample_loop_start_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "sample_loop_start" has changed.
add_sample_start_marker_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "sample_start_marker" has changed.
hide_envelope(arg1)¶
Hide the envelope view.
remove_sample_end_marker_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "sample_end_marker".
remove_sample_loop_end_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "sample_loop_end".
remove_sample_loop_start_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "sample_loop_start".
remove_sample_start_marker_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "sample_start_marker".
sample_end_marker_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "sample_end_marker".
sample_loop_end_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "sample_loop_end".
sample_loop_start_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "sample_loop_start".
sample_start_marker_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "sample_start_marker".
select_envelope_parameter(arg1,arg2)¶
Select the the given device parameter in the envelope view.
show_envelope(arg1)¶
Show the envelope view.
show_loop(arg1)¶
Show the entire loop in the detail view.