You are on page 1of 51

1 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live API version 9.1.0


Unofficial Live API documentation generated by the "API_MakeDoc" MIDI Remote Script.
This is unofficial documentation. Please do not contact Ableton with questions or problems relating to the use of this
documentation.

Live

Module

Live.Application

Module

Live.Application.combine_apcs() Built-In
combine_apcs() -> bool : Returns true if multiple APCs should be combined. C++ signature : bool combine_apcs()

Live.Application.encrypt_challenge() Built-In
encrypt_challenge( (int)dongle1, (int)dongle2 [, (int)key_index=0]) -> tuple : Returns an encrypted challenge based on the
TEA algortithm C++ signature : boost::python::tuple encrypt_challenge(int,int [,int=0])

Live.Application.encrypt_challenge2() Built-In
encrypt_challenge2( (int)arg1) -> int : Returns the UMAC hash for the given challenge. C++ signature : int
encrypt_challenge2(int)

Live.Application.get_application() Built-In
get_application() -> Application : Returns the application instance. C++ signature :
TWeakPtr<TPyHandle<ASongApp> > get_application()

Live.Application.get_random_int() Built-In
get_random_int( (int)arg1, (int)arg2) -> int : Returns a random integer from the given range. C++ signature : int
get_random_int(int,int)

Live.Application.Application

Class

This class represents the Live application.

Live.Application.Application.browser Property
Returns an interface to the browser.

Live.Application.Application.canonical_parent Property
Returns the canonical parent of the application.

Live.Application.Application.current_dialog_button_count Property
Number of buttons on the current dialog.

Live.Application.Application.current_dialog_message Property
Text of the last dialog that appeared; Empty if all dialogs just disappeared.

Live.Application.Application.open_dialog_count Property
The number of open dialogs in Live. 0 if not dialog is open.

Live.Application.Application.view Property
Returns the applications view component.

Live.Application.Application.add_open_dialog_count_listener() Method
add_open_dialog_count_listener( (Application)arg1, (object)arg2) -> None : Add a listener function or method, which will be
called as soon as the property "open_dialog_count" has changed. C++ signature : void
add_open_dialog_count_listener(TPyHandle<ASongApp>,boost::python::api::object)

Live.Application.Application.get_bugfix_version() Method
get_bugfix_version( (Application)arg1) -> int : Returns an integer representing the bugfix version of Live. C++ signature : int
get_bugfix_version(TPyHandle<ASongApp>)

Live.Application.Application.get_document() Method
get_document( (Application)arg1) -> Song : Returns the current Live Set. C++ signature :
TWeakPtr<TPyHandle<ASong> > get_document(TPyHandle<ASongApp>)

Live.Application.Application.get_major_version() Method
get_major_version( (Application)arg1) -> int : Returns an integer representing the major version of Live. C++ signature : int
get_major_version(TPyHandle<ASongApp>)

Live.Application.Application.get_minor_version() Method

12/09/2014 14:09

2 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

get_minor_version( (Application)arg1) -> int : Returns an integer representing the minor version of Live. C++ signature : int
get_minor_version(TPyHandle<ASongApp>)

Live.Application.Application.open_dialog_count_has_listener() Method
open_dialog_count_has_listener( (Application)arg1, (object)arg2) -> bool : Returns true, if the given listener function or
method is connected to the property "open_dialog_count". C++ signature : bool
open_dialog_count_has_listener(TPyHandle<ASongApp>,boost::python::api::object)

Live.Application.Application.press_current_dialog_button() Method
press_current_dialog_button( (Application)arg1, (int)arg2) -> None : Press a button, by index, on the current message box.
C++ signature : void press_current_dialog_button(TPyHandle<ASongApp>,int)

Live.Application.Application.remove_open_dialog_count_listener() Method
remove_open_dialog_count_listener( (Application)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "open_dialog_count". C++ signature : void
remove_open_dialog_count_listener(TPyHandle<ASongApp>,boost::python::api::object)

Live.Application.Application.View

Class

This class represents the view aspects of the Live application.

Live.Application.Application.View.browse_mode Property
Return true if HotSwap mode is active for any target.

Live.Application.Application.View.canonical_parent Property
Get the canonical parent of the application view.

Live.Application.Application.View.add_browse_mode_listener() Method
add_browse_mode_listener( (View)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "browse_mode" has changed. C++ signature : void
add_browse_mode_listener(TPyViewData<ASongApp>,boost::python::api::object)

Live.Application.Application.View.add_is_view_visible_listener() Method
add_is_view_visible_listener( (View)arg1, (object)arg2, (object)arg3) -> None : Add a listener function or method, which will
be called as soon as the property "is_view_visible" has changed. C++ signature : void
add_is_view_visible_listener(TPyViewData<ASongApp>,TString,boost::python::api::object)

Live.Application.Application.View.add_view_focus_changed_listener() Method
add_view_focus_changed_listener( (View)arg1, (object)arg2) -> None : Add a listener function or method, which will be
called as soon as the property "view_focus_changed" has changed. C++ signature : void
add_view_focus_changed_listener(TPyViewData<ASongApp>,boost::python::api::object)

Live.Application.Application.View.available_main_views() Method
available_main_views( (View)arg1) -> StringVector : Return a list of strings with the available subcomponent views, which is
to be specified, when using the rest of this classes functions. A 'subcomponent view' is a main view component of a document
view, like the Session view, the Arranger or Detailview and so on... C++ signature : std::vector<TString,
std::allocator<TString> > available_main_views(TPyViewData<ASongApp>)

Live.Application.Application.View.browse_mode_has_listener() Method
browse_mode_has_listener( (View)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "browse_mode". C++ signature : bool
browse_mode_has_listener(TPyViewData<ASongApp>,boost::python::api::object)

Live.Application.Application.View.focus_view() Method
focus_view( (View)arg1, (object)arg2) -> None : Show and focus one through the identifier string specified view. C++
signature : void focus_view(TPyViewData<ASongApp>,TString)

Live.Application.Application.View.hide_view() Method
hide_view( (View)arg1, (object)arg2) -> None : Hide one through the identifier string specified view. C++ signature : void
hide_view(TPyViewData<ASongApp>,TString)

Live.Application.Application.View.is_view_visible() Method
is_view_visible( (View)arg1, (object)identifier [, (bool)main_window_only=True]) -> bool : Return true if the through the
identifier string specified view is currently visible. If main_window_only is set to False, this will also check in second window.
Notifications from the second window are not yet supported. C++ signature : bool
is_view_visible(TPyViewData<ASongApp>,TString [,bool=True])

Live.Application.Application.View.is_view_visible_has_listener() Method
is_view_visible_has_listener( (View)arg1, (object)arg2, (object)arg3) -> bool : Returns true, if the given listener function or
method is connected to the property "is_view_visible". C++ signature : bool
is_view_visible_has_listener(TPyViewData<ASongApp>,TString,boost::python::api::object)

12/09/2014 14:09

3 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live.Application.Application.View.remove_browse_mode_listener() Method
remove_browse_mode_listener( (View)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "browse_mode". C++ signature : void
remove_browse_mode_listener(TPyViewData<ASongApp>,boost::python::api::object)

Live.Application.Application.View.remove_is_view_visible_listener() Method
remove_is_view_visible_listener( (View)arg1, (object)arg2, (object)arg3) -> None : Remove a previously set listener function
or method from property "is_view_visible". C++ signature : void
remove_is_view_visible_listener(TPyViewData<ASongApp>,TString,boost::python::api::object)

Live.Application.Application.View.remove_view_focus_changed_listener() Method
remove_view_focus_changed_listener( (View)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "view_focus_changed". C++ signature : void
remove_view_focus_changed_listener(TPyViewData<ASongApp>,boost::python::api::object)

Live.Application.Application.View.scroll_view() Method
scroll_view( (View)arg1, (int)arg2, (object)arg3, (bool)arg4) -> None : Scroll through the identifier string specified view into
the given direction, if possible. Will silently return if the specified view can not perform the requested action. C++ signature :
void scroll_view(TPyViewData<ASongApp>,int,TString,bool)

Live.Application.Application.View.show_view() Method
show_view( (View)arg1, (object)arg2) -> None : Show one through the identifier string specified view. Will throw a runtime
error if this is called in Live's initialization scope. C++ signature : void show_view(TPyViewData<ASongApp>,TString)

Live.Application.Application.View.toggle_browse() Method
toggle_browse( (View)arg1) -> None : Reveals the device chain, the browser and starts hot swap for the selected device.
Calling this function again stops hot swap. C++ signature : void toggle_browse(TPyViewData<ASongApp>)

Live.Application.Application.View.view_focus_changed_has_listener() Method
view_focus_changed_has_listener( (View)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "view_focus_changed". C++ signature : bool
view_focus_changed_has_listener(TPyViewData<ASongApp>,boost::python::api::object)

Live.Application.Application.View.zoom_view() Method
zoom_view( (View)arg1, (int)arg2, (object)arg3, (bool)arg4) -> None : Zoom through the identifier string specified view into
the given direction, if possible. Will silently return if the specified view can not perform the requested action. C++ signature :
void zoom_view(TPyViewData<ASongApp>,int,TString,bool)

Live.Application.Application.View.NavDirection

Sub-Class

Live.Application.Application.View.NavDirection.down Value
Live.Application.Application.View.NavDirection.left Value
Live.Application.Application.View.NavDirection.right Value
Live.Application.Application.View.NavDirection.up Value

Live.Base

Module

Live.Base.IntVector

Class

A simple container for returning integers from Live.

Live.Base.IntVector.append() Method
append( (IntVector)arg1, (object)arg2) -> None : C++ signature : void append(std::vector<int, std::allocator<int> >
{lvalue},boost::python::api::object)

Live.Base.IntVector.extend() Method
extend( (IntVector)arg1, (object)arg2) -> None : C++ signature : void extend(std::vector<int, std::allocator<int> >
{lvalue},boost::python::api::object)

Live.Base.LimitationError
Live.Base.StringVector

Class

Class

A simple container for returning strings from Live.

12/09/2014 14:09

4 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live.Base.StringVector.append() Method
append( (StringVector)arg1, (object)arg2) -> None : C++ signature : void append(std::vector<TString,
std::allocator<TString> > {lvalue},boost::python::api::object)

Live.Base.StringVector.extend() Method
extend( (StringVector)arg1, (object)arg2) -> None : C++ signature : void extend(std::vector<TString,
std::allocator<TString> > {lvalue},boost::python::api::object)

Live.Base.Vector

Class

A simple read only container for returning objects from Live.

Live.Base.Vector.append() Method
append( (Vector)arg1, (object)arg2) -> None : C++ signature : void append(std::vector<TWeakPtr<TPyHandleBase>,
std::allocator<TWeakPtr<TPyHandleBase> > > {lvalue},boost::python::api::object)

Live.Base.Vector.extend() Method
extend( (Vector)arg1, (object)arg2) -> None : C++ signature : void extend(std::vector<TWeakPtr<TPyHandleBase>,
std::allocator<TWeakPtr<TPyHandleBase> > > {lvalue},boost::python::api::object)

Live.Browser

Module

Live.Browser.Browser

Class

This class represents the live browser data base.

Live.Browser.Browser.filter_type Property
Bang triggered when the hotswap target has changed.

Live.Browser.Browser.hotswap_target Property
Bang triggered when the hotswap target has changed.

Live.Browser.Browser.packs Property
Const access to the list of packs of the browser.

Live.Browser.Browser.places Property
Const access to the list of places of the browser.

Live.Browser.Browser.tags Property
Const access to the list of tags of the browser.

Live.Browser.Browser.add_filter_type_listener() Method
add_filter_type_listener( (Browser)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "filter_type" has changed. C++ signature : void
add_filter_type_listener(TPyHandle<ABrowserDelegate>,boost::python::api::object)

Live.Browser.Browser.add_full_refresh_listener() Method
add_full_refresh_listener( (Browser)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "full_refresh" has changed. C++ signature : void
add_full_refresh_listener(TPyHandle<ABrowserDelegate>,boost::python::api::object)

Live.Browser.Browser.add_hotswap_target_listener() Method
add_hotswap_target_listener( (Browser)arg1, (object)arg2) -> None : Add a listener function or method, which will be called
as soon as the property "hotswap_target" has changed. C++ signature : void
add_hotswap_target_listener(TPyHandle<ABrowserDelegate>,boost::python::api::object)

Live.Browser.Browser.filter_type_has_listener() Method
filter_type_has_listener( (Browser)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "filter_type". C++ signature : bool
filter_type_has_listener(TPyHandle<ABrowserDelegate>,boost::python::api::object)

Live.Browser.Browser.full_refresh_has_listener() Method
full_refresh_has_listener( (Browser)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "full_refresh". C++ signature : bool
full_refresh_has_listener(TPyHandle<ABrowserDelegate>,boost::python::api::object)

Live.Browser.Browser.hotswap_target_has_listener() Method
hotswap_target_has_listener( (Browser)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "hotswap_target". C++ signature : bool

12/09/2014 14:09

5 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

hotswap_target_has_listener(TPyHandle<ABrowserDelegate>,boost::python::api::object)

Live.Browser.Browser.load_item() Method
load_item( (Browser)arg1, (BrowserItem)arg2) -> None : Loads the provided browser item. C++ signature : void
load_item(TPyHandle<ABrowserDelegate>,NPythonBrowser::TPythonBrowserItem)

Live.Browser.Browser.remove_filter_type_listener() Method
remove_filter_type_listener( (Browser)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "filter_type". C++ signature : void
remove_filter_type_listener(TPyHandle<ABrowserDelegate>,boost::python::api::object)

Live.Browser.Browser.remove_full_refresh_listener() Method
remove_full_refresh_listener( (Browser)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "full_refresh". C++ signature : void
remove_full_refresh_listener(TPyHandle<ABrowserDelegate>,boost::python::api::object)

Live.Browser.Browser.remove_hotswap_target_listener() Method
remove_hotswap_target_listener( (Browser)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "hotswap_target". C++ signature : void
remove_hotswap_target_listener(TPyHandle<ABrowserDelegate>,boost::python::api::object)

Live.Browser.BrowserItem

Class

This class represents an item of the browser hierarchy.

Live.Browser.BrowserItem.children Property
Const access to the descendants of this browser item.

Live.Browser.BrowserItem.is_device Property
Indicates if the browser item represents a device.

Live.Browser.BrowserItem.is_folder Property
Indicates if the browser item represents folder.

Live.Browser.BrowserItem.is_loadable Property
True if item can be loaded via the Browser's 'load_item' method.

Live.Browser.BrowserItem.is_selected Property
True if the item is ancestor of or the actual selection.

Live.Browser.BrowserItem.name Property
Const access to the canonical display name of this browser item.

Live.Browser.BrowserItem.source Property
Specifies where does item come from -- i.e. Live pack, user library...

Live.Browser.BrowserItemVector

Class

A container for returning browser items from Live.

Live.Browser.BrowserItemVector.append() Method
append( (BrowserItemVector)arg1, (object)arg2) -> None : C++ signature : void
append(std::vector<NPythonBrowser::TPythonBrowserItem, std::allocator<NPythonBrowser::TPythonBrowserItem> >
{lvalue},boost::python::api::object)

Live.Browser.BrowserItemVector.extend() Method
extend( (BrowserItemVector)arg1, (object)arg2) -> None : C++ signature : void
extend(std::vector<NPythonBrowser::TPythonBrowserItem, std::allocator<NPythonBrowser::TPythonBrowserItem> >
{lvalue},boost::python::api::object)

Live.Browser.FilterType

Class

Live.Browser.FilterType.audio_effect_hotswap Value
Live.Browser.FilterType.count Value
Live.Browser.FilterType.disabled Value
Live.Browser.FilterType.drum_pad_hotswap Value

12/09/2014 14:09

6 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live.Browser.FilterType.hotswap_off Value
Live.Browser.FilterType.instrument_hotswap Value
Live.Browser.FilterType.midi_effect_hotswap Value

Live.Chain

Module

Live.Chain.Chain

Class

This class represents a group device chain in Live.

Live.Chain.Chain.canonical_parent Property
Get the canonical parent of the chain.

Live.Chain.Chain.devices Property
Return const access to all available Devices that are present in the chains

Live.Chain.Chain.has_audio_input Property
return True, if this Chain can be feed with an Audio signal. This istrue for all Audio Chains.

Live.Chain.Chain.has_audio_output Property
return True, if this Chain sends out an Audio signal. This istrue for all Audio Chains, and MIDI chains with an Instrument.

Live.Chain.Chain.has_midi_input Property
return True, if this Chain can be feed with an Audio signal. This istrue for all MIDI Chains.

Live.Chain.Chain.has_midi_output Property
return True, if this Chain sends out MIDI events. This istrue for all MIDI Chains with no Instruments.

Live.Chain.Chain.mixer_device Property
Return access to the mixer device that holds the chain's mixer parameters:the Volume, Pan, and Sendamounts.

Live.Chain.Chain.mute Property
Mute/unmute the chain.

Live.Chain.Chain.name Property
Read/write access to the name of the Chain, as visible in the track header.

Live.Chain.Chain.solo Property
Get/Set the solo status of the chain. Note that this will not disable thesolo state of any other Chain in the same rack. If you want
exclusive solo, you have to disable the solo state of the other Chains manually.

Live.Chain.Chain.add_devices_listener() Method
add_devices_listener( (Chain)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as
the property "devices" has changed. C++ signature : void add_devices_listener(TChainPyHandle,boost::python::api::object)

Live.Chain.Chain.add_mute_listener() Method
add_mute_listener( (Chain)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as
the property "mute" has changed. C++ signature : void add_mute_listener(TChainPyHandle,boost::python::api::object)

Live.Chain.Chain.add_name_listener() Method
add_name_listener( (Chain)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as
the property "name" has changed. C++ signature : void add_name_listener(TChainPyHandle,boost::python::api::object)

Live.Chain.Chain.add_solo_listener() Method
add_solo_listener( (Chain)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the
property "solo" has changed. C++ signature : void add_solo_listener(TChainPyHandle,boost::python::api::object)

Live.Chain.Chain.delete_device() Method
delete_device( (Chain)arg1, (int)arg2) -> None : Remove a device identified by its index from the chain. Throws runtime error
if bad index. C++ signature : void delete_device(TChainPyHandle,int)

Live.Chain.Chain.devices_has_listener() Method
devices_has_listener( (Chain)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected
to the property "devices". C++ signature : bool devices_has_listener(TChainPyHandle,boost::python::api::object)

Live.Chain.Chain.mute_has_listener() Method
mute_has_listener( (Chain)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to

12/09/2014 14:09

7 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

the property "mute". C++ signature : bool mute_has_listener(TChainPyHandle,boost::python::api::object)

Live.Chain.Chain.name_has_listener() Method
name_has_listener( (Chain)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to
the property "name". C++ signature : bool name_has_listener(TChainPyHandle,boost::python::api::object)

Live.Chain.Chain.remove_devices_listener() Method
remove_devices_listener( (Chain)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "devices". C++ signature : void remove_devices_listener(TChainPyHandle,boost::python::api::object)

Live.Chain.Chain.remove_mute_listener() Method
remove_mute_listener( (Chain)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "mute". C++ signature : void remove_mute_listener(TChainPyHandle,boost::python::api::object)

Live.Chain.Chain.remove_name_listener() Method
remove_name_listener( (Chain)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "name". C++ signature : void remove_name_listener(TChainPyHandle,boost::python::api::object)

Live.Chain.Chain.remove_solo_listener() Method
remove_solo_listener( (Chain)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "solo". C++ signature : void remove_solo_listener(TChainPyHandle,boost::python::api::object)

Live.Chain.Chain.solo_has_listener() Method
solo_has_listener( (Chain)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to
the property "solo". C++ signature : bool solo_has_listener(TChainPyHandle,boost::python::api::object)

Live.ChainMixerDevice

Module

Live.ChainMixerDevice.ChainMixerDevice

Class

This class represents a Chain's Mixer Device in Live, which gives youaccess to the Volume, Panning, and Send properties of a
Chain.

Live.ChainMixerDevice.ChainMixerDevice.canonical_parent Property
Get the canonical parent of the mixer device.

Live.ChainMixerDevice.ChainMixerDevice.chain_activator Property
Const access to the Chain's Activator Device Parameter.

Live.ChainMixerDevice.ChainMixerDevice.panning Property
Const access to the Chain's Panning Device Parameter.

Live.ChainMixerDevice.ChainMixerDevice.sends Property
Const access to the Chain's list of Send Amount Device Parameters.

Live.ChainMixerDevice.ChainMixerDevice.volume Property
Const access to the Chain's Volume Device Parameter.

Live.ChainMixerDevice.ChainMixerDevice.add_sends_listener() Method
add_sends_listener( (ChainMixerDevice)arg1, (object)arg2) -> None : Add a listener function or method, which will be called
as soon as the property "sends" has changed. C++ signature : void
add_sends_listener(TPyHandle<ABranchMixerDevice>,boost::python::api::object)

Live.ChainMixerDevice.ChainMixerDevice.remove_sends_listener() Method
remove_sends_listener( (ChainMixerDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "sends". C++ signature : void
remove_sends_listener(TPyHandle<ABranchMixerDevice>,boost::python::api::object)

Live.ChainMixerDevice.ChainMixerDevice.sends_has_listener() Method
sends_has_listener( (ChainMixerDevice)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "sends". C++ signature : bool
sends_has_listener(TPyHandle<ABranchMixerDevice>,boost::python::api::object)

Live.Clip

Module

Live.Clip.AutomationEnvelope

Class

Describes parameter automation per clip.

12/09/2014 14:09

8 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live.Clip.AutomationEnvelope.insert_step() Method
insert_step( (AutomationEnvelope)arg1, (float)arg2, (float)arg3, (float)arg4) -> None : C++ signature : void
insert_step(AAutomation {lvalue},double,double,double)

Live.Clip.AutomationEnvelope.value_at_time() Method
value_at_time( (AutomationEnvelope)arg1, (float)arg2) -> float : C++ signature : double value_at_time(AAutomation
{lvalue},double)

Live.Clip.Clip

Class

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.

Live.Clip.Clip.available_warp_modes Property
Avalibale for AudioClips only.Get/Set the available warp modes, that can be used.

Live.Clip.Clip.canonical_parent Property
Get the canonical parent of the Clip.

Live.Clip.Clip.color Property
Get/set access to the color of the Clip (RGB).

Live.Clip.Clip.end_marker Property
Get/Set the Clips end marker pos in beats.

Live.Clip.Clip.file_path Property
Get the path of the file represented by the Audio Clip.

Live.Clip.Clip.gain Property
Avalibale for AudioClips only.Read/write access to the gain setting of theAudio Clip

Live.Clip.Clip.gain_display_string Property
Return a string with the gain as dB value

Live.Clip.Clip.has_envelopes Property
Will notify if the clip gets his first envelope or the last envelope is removed.

Live.Clip.Clip.is_arrangement_clip Property
return true if this Clip is an Arrangement Clip.A Clip can be either a Session or Arrangement Clip.

Live.Clip.Clip.is_audio_clip Property
Return true if this Clip is an Audio Clip.A Clip can be either an Audioclip or a MIDI Clip.

Live.Clip.Clip.is_midi_clip Property
return true if this Clip is a MIDI Clip.A Clip can be either an Audioclip or a MIDI Clip.

Live.Clip.Clip.is_overdubbing Property
returns true if the Clip is recording overdubs

Live.Clip.Clip.is_playing Property
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.

Live.Clip.Clip.is_recording Property
returns true if the Clip was triggered to record or is recording.

Live.Clip.Clip.is_triggered Property
returns true if the Clip was triggered or is playing.

Live.Clip.Clip.length Property
Get to the Clips length in beats.

Live.Clip.Clip.loop_end Property
Get/Set the loop end pos of this Clip in beats.

Live.Clip.Clip.loop_start Property
Get/Set the Clips loopstart pos in beats.

Live.Clip.Clip.looping Property
Get/Set the Clips 'loop is enabled' flag.Only Warped Audio Clips or MIDI Clip can be looped.

12/09/2014 14:09

9 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live.Clip.Clip.muted Property
Read/write access to the mute state of the Clip.

Live.Clip.Clip.name Property
Read/write access to the name of the Clip.

Live.Clip.Clip.pitch_coarse Property
Avalibale for AudioClips only.Read/write access to the pitch (in halftones) setting of theAudio Clip, ranging from -48 to 48

Live.Clip.Clip.pitch_fine Property
Avalibale for AudioClips only.Read/write access to the pitch fine setting of theAudio Clip, ranging from -500 to 500

Live.Clip.Clip.playing_position Property
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.

Live.Clip.Clip.signature_denominator Property
Get/Set access to the global signature denominator of the Clip.

Live.Clip.Clip.signature_numerator Property
Get/Set access to the global signature numerator of the Clip.

Live.Clip.Clip.start_marker Property
Get/Set the Clips start marker pos in beats.

Live.Clip.Clip.start_time Property
Get the clips start time offset.

Live.Clip.Clip.view Property
Get the view of the Clip.

Live.Clip.Clip.warp_mode Property
Avalibale for AudioClips only.Get/Set the warp mode for this audio clip.

Live.Clip.Clip.warping Property
Avalibale for AudioClips only.Get/Set if this Clip is timestreched.

Live.Clip.Clip.will_record_on_start Property
returns true if the Clip will record on being started.

Live.Clip.Clip.add_color_listener() Method
add_color_listener( (Clip)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the
property "color" has changed. C++ signature : void add_color_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.add_end_marker_listener() Method
add_end_marker_listener( (Clip)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon
as the property "end_marker" has changed. C++ signature : void
add_end_marker_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.add_gain_listener() Method
add_gain_listener( (Clip)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the
property "gain" has changed. C++ signature : void add_gain_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.add_has_envelopes_listener() Method
add_has_envelopes_listener( (Clip)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "has_envelopes" has changed. C++ signature : void
add_has_envelopes_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.add_is_overdubbing_listener() Method
add_is_overdubbing_listener( (Clip)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "is_overdubbing" has changed. C++ signature : void
add_is_overdubbing_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.add_is_recording_listener() Method
add_is_recording_listener( (Clip)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon
as the property "is_recording" has changed. C++ signature : void
add_is_recording_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.add_loop_end_listener() Method
add_loop_end_listener( (Clip)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as

12/09/2014 14:09

10 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

the property "loop_end" has changed. C++ signature : void


add_loop_end_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.add_loop_jump_listener() Method
add_loop_jump_listener( (Clip)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon
as the property "loop_jump" has changed. C++ signature : void
add_loop_jump_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.add_loop_start_listener() Method
add_loop_start_listener( (Clip)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as
the property "loop_start" has changed. C++ signature : void
add_loop_start_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.add_looping_listener() Method
add_looping_listener( (Clip)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as
the property "looping" has changed. C++ signature : void
add_looping_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.add_muted_listener() Method
add_muted_listener( (Clip)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the
property "muted" has changed. C++ signature : void add_muted_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.add_name_listener() Method
add_name_listener( (Clip)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the
property "name" has changed. C++ signature : void add_name_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.add_notes_listener() Method
add_notes_listener( (Clip)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the
property "notes" has changed. C++ signature : void add_notes_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.add_pitch_coarse_listener() Method
add_pitch_coarse_listener( (Clip)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon
as the property "pitch_coarse" has changed. C++ signature : void
add_pitch_coarse_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.add_pitch_fine_listener() Method
add_pitch_fine_listener( (Clip)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as
the property "pitch_fine" has changed. C++ signature : void
add_pitch_fine_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.add_playing_position_listener() Method
add_playing_position_listener( (Clip)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "playing_position" has changed. C++ signature : void
add_playing_position_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.add_playing_status_listener() Method
add_playing_status_listener( (Clip)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "playing_status" has changed. C++ signature : void
add_playing_status_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.add_signature_denominator_listener() Method
add_signature_denominator_listener( (Clip)arg1, (object)arg2) -> None : Add a listener function or method, which will be
called as soon as the property "signature_denominator" has changed. C++ signature : void
add_signature_denominator_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.add_signature_numerator_listener() Method
add_signature_numerator_listener( (Clip)arg1, (object)arg2) -> None : Add a listener function or method, which will be called
as soon as the property "signature_numerator" has changed. C++ signature : void
add_signature_numerator_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.add_start_marker_listener() Method
add_start_marker_listener( (Clip)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon
as the property "start_marker" has changed. C++ signature : void
add_start_marker_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.add_warp_mode_listener() Method
add_warp_mode_listener( (Clip)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon
as the property "warp_mode" has changed. C++ signature : void
add_warp_mode_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.add_warping_listener() Method
add_warping_listener( (Clip)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as

12/09/2014 14:09

11 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

the property "warping" has changed. C++ signature : void


add_warping_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.automation_envelope() Method
automation_envelope( (Clip)arg1, (DeviceParameter)arg2) -> AutomationEnvelope : Return the envelope for the given
parameter.Returns None for Arrangement clips.Returns None for parameters from a different track. C++ signature :
TWeakPtr<AAutomation> automation_envelope(TPyHandle<AClip>,TPyHandle<ATimeable>)

Live.Clip.Clip.clear_all_envelopes() Method
clear_all_envelopes( (Clip)arg1) -> None : Clears all envelopes for this clip. C++ signature : void
clear_all_envelopes(TPyHandle<AClip>)

Live.Clip.Clip.clear_envelope() Method
clear_envelope( (Clip)arg1, (DeviceParameter)arg2) -> None : Clears the envelope of this clips given parameter. C++
signature : void clear_envelope(TPyHandle<AClip>,TPyHandle<ATimeable>)

Live.Clip.Clip.color_has_listener() Method
color_has_listener( (Clip)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the
property "color". C++ signature : bool color_has_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.deselect_all_notes() Method
deselect_all_notes( (Clip)arg1) -> None : De-selects all notes present in the clip. C++ signature : void
deselect_all_notes(TPyHandle<AClip>)

Live.Clip.Clip.duplicate_loop() Method
duplicate_loop( (Clip)arg1) -> None : Make the loop two times longer and duplicates notes and envelopes. Duplicates the clip
start/end range if the clip is not looped. C++ signature : void duplicate_loop(TPyHandle<AClip>)

Live.Clip.Clip.end_marker_has_listener() Method
end_marker_has_listener( (Clip)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "end_marker". C++ signature : bool
end_marker_has_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.fire() Method
fire( (Clip)arg1) -> None : (Re)Start playing this Clip. C++ signature : void fire(TPyHandle<AClip>)

Live.Clip.Clip.gain_has_listener() Method
gain_has_listener( (Clip)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the
property "gain". C++ signature : bool gain_has_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.get_notes() Method
get_notes( (Clip)arg1, (float)arg2, (int)arg3, (float)arg4, (int)arg5) -> tuple : 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. C++ signature : boost::python::tuple get_notes(TPyHandle<AClip>,double,int,double,int)

Live.Clip.Clip.get_selected_notes() Method
get_selected_notes( (Clip)arg1) -> tuple : Returns a tuple of tuples where each inner tuple represents a selected note. The
inner tuple contains pitch, time, duration, velocity, and mute state. C++ signature : boost::python::tuple
get_selected_notes(TPyHandle<AClip>)

Live.Clip.Clip.has_envelopes_has_listener() Method
has_envelopes_has_listener( (Clip)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "has_envelopes". C++ signature : bool
has_envelopes_has_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.is_overdubbing_has_listener() Method
is_overdubbing_has_listener( (Clip)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "is_overdubbing". C++ signature : bool
is_overdubbing_has_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.is_recording_has_listener() Method
is_recording_has_listener( (Clip)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "is_recording". C++ signature : bool
is_recording_has_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.loop_end_has_listener() Method
loop_end_has_listener( (Clip)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected
to the property "loop_end". C++ signature : bool loop_end_has_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.loop_jump_has_listener() Method
loop_jump_has_listener( (Clip)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected

12/09/2014 14:09

12 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

to the property "loop_jump". C++ signature : bool loop_jump_has_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.loop_start_has_listener() Method
loop_start_has_listener( (Clip)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected
to the property "loop_start". C++ signature : bool loop_start_has_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.looping_has_listener() Method
looping_has_listener( (Clip)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to
the property "looping". C++ signature : bool looping_has_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.move_playing_pos() Method
move_playing_pos( (Clip)arg1, (float)arg2) -> None : Jump forward or backward by the specified relative amount in beats.
Will do nothing, if the Clip is not playing. C++ signature : void move_playing_pos(TPyHandle<AClip>,double)

Live.Clip.Clip.muted_has_listener() Method
muted_has_listener( (Clip)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to
the property "muted". C++ signature : bool muted_has_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.name_has_listener() Method
name_has_listener( (Clip)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to
the property "name". C++ signature : bool name_has_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.notes_has_listener() Method
notes_has_listener( (Clip)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to
the property "notes". C++ signature : bool notes_has_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.pitch_coarse_has_listener() Method
pitch_coarse_has_listener( (Clip)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "pitch_coarse". C++ signature : bool
pitch_coarse_has_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.pitch_fine_has_listener() Method
pitch_fine_has_listener( (Clip)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected
to the property "pitch_fine". C++ signature : bool pitch_fine_has_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.playing_position_has_listener() Method
playing_position_has_listener( (Clip)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "playing_position". C++ signature : bool
playing_position_has_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.playing_status_has_listener() Method
playing_status_has_listener( (Clip)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "playing_status". C++ signature : bool
playing_status_has_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.quantize() Method
quantize( (Clip)arg1, (int)arg2, (float)arg3) -> None : Quantize all notes in a clip or align warp markers. C++ signature : void
quantize(TPyHandle<AClip>,int,float)

Live.Clip.Clip.quantize_pitch() Method
quantize_pitch( (Clip)arg1, (int)arg2, (int)arg3, (float)arg4) -> None : Quantize all the notes of a given pitch. Raises an error
on audio clips. C++ signature : void quantize_pitch(TPyHandle<AClip>,int,int,float)

Live.Clip.Clip.remove_color_listener() Method
remove_color_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property
"color". C++ signature : void remove_color_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.remove_end_marker_listener() Method
remove_end_marker_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "end_marker". C++ signature : void remove_end_marker_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.remove_gain_listener() Method
remove_gain_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property
"gain". C++ signature : void remove_gain_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.remove_has_envelopes_listener() Method
remove_has_envelopes_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "has_envelopes". C++ signature : void
remove_has_envelopes_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.remove_is_overdubbing_listener() Method

12/09/2014 14:09

13 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

remove_is_overdubbing_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "is_overdubbing". C++ signature : void
remove_is_overdubbing_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.remove_is_recording_listener() Method
remove_is_recording_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "is_recording". C++ signature : void remove_is_recording_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.remove_loop_end_listener() Method
remove_loop_end_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "loop_end". C++ signature : void remove_loop_end_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.remove_loop_jump_listener() Method
remove_loop_jump_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "loop_jump". C++ signature : void remove_loop_jump_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.remove_loop_start_listener() Method
remove_loop_start_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "loop_start". C++ signature : void remove_loop_start_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.remove_looping_listener() Method
remove_looping_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "looping". C++ signature : void remove_looping_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.remove_muted_listener() Method
remove_muted_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "muted". C++ signature : void remove_muted_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.remove_name_listener() Method
remove_name_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "name". C++ signature : void remove_name_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.remove_notes() Method
remove_notes( (Clip)arg1, (float)arg2, (int)arg3, (float)arg4, (int)arg5) -> None : Delete all notes starting in the given pitchand time range. C++ signature : void remove_notes(TPyHandle<AClip>,double,int,double,int)

Live.Clip.Clip.remove_notes_listener() Method
remove_notes_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "notes". C++ signature : void remove_notes_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.remove_pitch_coarse_listener() Method
remove_pitch_coarse_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "pitch_coarse". C++ signature : void remove_pitch_coarse_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.remove_pitch_fine_listener() Method
remove_pitch_fine_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "pitch_fine". C++ signature : void remove_pitch_fine_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.remove_playing_position_listener() Method
remove_playing_position_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "playing_position". C++ signature : void
remove_playing_position_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.remove_playing_status_listener() Method
remove_playing_status_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "playing_status". C++ signature : void
remove_playing_status_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.remove_signature_denominator_listener() Method
remove_signature_denominator_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "signature_denominator". C++ signature : void
remove_signature_denominator_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.remove_signature_numerator_listener() Method
remove_signature_numerator_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "signature_numerator". C++ signature : void
remove_signature_numerator_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.remove_start_marker_listener() Method
remove_start_marker_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "start_marker". C++ signature : void remove_start_marker_listener(TPyHandle<AClip>,boost::python::api::object)

12/09/2014 14:09

14 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live.Clip.Clip.remove_warp_mode_listener() Method
remove_warp_mode_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "warp_mode". C++ signature : void remove_warp_mode_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.remove_warping_listener() Method
remove_warping_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "warping". C++ signature : void remove_warping_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.replace_selected_notes() Method
replace_selected_notes( (Clip)arg1, (tuple)arg2) -> None : 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. C++ signature : void replace_selected_notes(TPyHandle<AClip>,boost::python::tuple)

Live.Clip.Clip.select_all_notes() Method
select_all_notes( (Clip)arg1) -> None : Selects all notes present in the clip. C++ signature : void
select_all_notes(TPyHandle<AClip>)

Live.Clip.Clip.set_fire_button_state() Method
set_fire_button_state( (Clip)arg1, (bool)arg2) -> None : Set the clip's fire button state directly. Supports all launch modes.
C++ signature : void set_fire_button_state(TPyHandle<AClip>,bool)

Live.Clip.Clip.set_notes() Method
set_notes( (Clip)arg1, (tuple)arg2) -> None : 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. C++ signature : void
set_notes(TPyHandle<AClip>,boost::python::tuple)

Live.Clip.Clip.signature_denominator_has_listener() Method
signature_denominator_has_listener( (Clip)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method
is connected to the property "signature_denominator". C++ signature : bool
signature_denominator_has_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.signature_numerator_has_listener() Method
signature_numerator_has_listener( (Clip)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "signature_numerator". C++ signature : bool
signature_numerator_has_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.start_marker_has_listener() Method
start_marker_has_listener( (Clip)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "start_marker". C++ signature : bool
start_marker_has_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.stop() Method
stop( (Clip)arg1) -> None : Stop playing this Clip. C++ signature : void stop(TPyHandle<AClip>)

Live.Clip.Clip.warp_mode_has_listener() Method
warp_mode_has_listener( (Clip)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "warp_mode". C++ signature : bool
warp_mode_has_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.warping_has_listener() Method
warping_has_listener( (Clip)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to
the property "warping". C++ signature : bool warping_has_listener(TPyHandle<AClip>,boost::python::api::object)

Live.Clip.Clip.View

Class

Representing the view aspects of a Clip.

Live.Clip.Clip.View.canonical_parent Property
Get the canonical parent of the clip view.

Live.Clip.Clip.View.grid_is_triplet Property
Get/set wether the grid is showing in triplet mode.

Live.Clip.Clip.View.grid_quantization Property
Get/set clip grid quantization resolution.

Live.Clip.Clip.View.hide_envelope() Method
hide_envelope( (View)arg1) -> None : Hide the envelope view. C++ signature : void
hide_envelope(TPyViewData<AClip>)

12/09/2014 14:09

15 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live.Clip.Clip.View.select_envelope_parameter() Method
select_envelope_parameter( (View)arg1, (DeviceParameter)arg2) -> None : Select the the given device parameter in the
envelope view. C++ signature : void select_envelope_parameter(TPyViewData<AClip>,TPyHandle<ATimeable>)

Live.Clip.Clip.View.show_envelope() Method
show_envelope( (View)arg1) -> None : Show the envelope view. C++ signature : void
show_envelope(TPyViewData<AClip>)

Live.Clip.Clip.View.show_loop() Method
show_loop( (View)arg1) -> None : Show the entire loop in the detail view. C++ signature : void
show_loop(TPyViewData<AClip>)

Live.Clip.GridQuantization

Class

Live.Clip.GridQuantization.count Value
Live.Clip.GridQuantization.g_2_bars Value
Live.Clip.GridQuantization.g_4_bars Value
Live.Clip.GridQuantization.g_8_bars Value
Live.Clip.GridQuantization.g_bar Value
Live.Clip.GridQuantization.g_eighth Value
Live.Clip.GridQuantization.g_half Value
Live.Clip.GridQuantization.g_quarter Value
Live.Clip.GridQuantization.g_sixteenth Value
Live.Clip.GridQuantization.g_thirtysecond Value
Live.Clip.GridQuantization.no_grid Value

Live.Clip.WarpMode

Class

Live.Clip.WarpMode.beats Value
Live.Clip.WarpMode.complex Value
Live.Clip.WarpMode.complex_pro Value
Live.Clip.WarpMode.count Value
Live.Clip.WarpMode.repitch Value
Live.Clip.WarpMode.rex Value
Live.Clip.WarpMode.texture Value
Live.Clip.WarpMode.tones Value

Live.ClipSlot

Module

Live.ClipSlot.ClipSlot

Class

This class represents an entry in Lives Session view matrix.

Live.ClipSlot.ClipSlot.canonical_parent Property
Get the canonical parent of the ClipSlot.

Live.ClipSlot.ClipSlot.clip Property
Returns the Clip which this clipslots currently owns. Might be None.

12/09/2014 14:09

16 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live.ClipSlot.ClipSlot.color Property
Returns the canonical color for the clip slot or None if it does not exist.

Live.ClipSlot.ClipSlot.controls_other_clips Property
Returns true if firing this slot will fire clips in other slots.Can only be true for slots in group tracks.

Live.ClipSlot.ClipSlot.has_clip Property
Returns true if this Clipslot owns a Clip.

Live.ClipSlot.ClipSlot.has_stop_button Property
Get/Set if this Clip has a stop button, which will, if fired, stop anyother Clip that is currently playing the Track we do belong to.

Live.ClipSlot.ClipSlot.is_playing Property
Returns whether the clip associated with the slot is playing.

Live.ClipSlot.ClipSlot.is_recording Property
Returns whether the clip associated with the slot is recording.

Live.ClipSlot.ClipSlot.is_triggered Property
Const access to the triggering state of the clip slot.

Live.ClipSlot.ClipSlot.playing_status Property
Const access to the playing state of the clip slot.Can be either stopped, playing, or recording.

Live.ClipSlot.ClipSlot.will_record_on_start Property
returns true if the clip slot will record on being fired.

Live.ClipSlot.ClipSlot.add_color_listener() Method
add_color_listener( (ClipSlot)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as
the property "color" has changed. C++ signature : void
add_color_listener(TPyHandle<AGroupAndClipSlotBase>,boost::python::api::object)

Live.ClipSlot.ClipSlot.add_controls_other_clips_listener() Method
add_controls_other_clips_listener( (ClipSlot)arg1, (object)arg2) -> None : Add a listener function or method, which will be
called as soon as the property "controls_other_clips" has changed. C++ signature : void
add_controls_other_clips_listener(TPyHandle<AGroupAndClipSlotBase>,boost::python::api::object)

Live.ClipSlot.ClipSlot.add_has_clip_listener() Method
add_has_clip_listener( (ClipSlot)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon
as the property "has_clip" has changed. C++ signature : void
add_has_clip_listener(TPyHandle<AGroupAndClipSlotBase>,boost::python::api::object)

Live.ClipSlot.ClipSlot.add_has_stop_button_listener() Method
add_has_stop_button_listener( (ClipSlot)arg1, (object)arg2) -> None : Add a listener function or method, which will be called
as soon as the property "has_stop_button" has changed. C++ signature : void
add_has_stop_button_listener(TPyHandle<AGroupAndClipSlotBase>,boost::python::api::object)

Live.ClipSlot.ClipSlot.add_is_triggered_listener() Method
add_is_triggered_listener( (ClipSlot)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "is_triggered" has changed. C++ signature : void
add_is_triggered_listener(TPyHandle<AGroupAndClipSlotBase>,boost::python::api::object)

Live.ClipSlot.ClipSlot.add_playing_status_listener() Method
add_playing_status_listener( (ClipSlot)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "playing_status" has changed. C++ signature : void
add_playing_status_listener(TPyHandle<AGroupAndClipSlotBase>,boost::python::api::object)

Live.ClipSlot.ClipSlot.color_has_listener() Method
color_has_listener( (ClipSlot)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to
the property "color". C++ signature : bool
color_has_listener(TPyHandle<AGroupAndClipSlotBase>,boost::python::api::object)

Live.ClipSlot.ClipSlot.controls_other_clips_has_listener() Method
controls_other_clips_has_listener( (ClipSlot)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method
is connected to the property "controls_other_clips". C++ signature : bool
controls_other_clips_has_listener(TPyHandle<AGroupAndClipSlotBase>,boost::python::api::object)

Live.ClipSlot.ClipSlot.create_clip() Method
create_clip( (ClipSlot)arg1, (float)arg2) -> None : Creates an empty clip with the given length in the slot. Throws an error
when called on non-empty slots or slots in non-MIDI tracks. C++ signature : void

12/09/2014 14:09

17 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

create_clip(TPyHandle<AGroupAndClipSlotBase>,double)

Live.ClipSlot.ClipSlot.delete_clip() Method
delete_clip( (ClipSlot)arg1) -> None : Removes the clip contained in the slot. Rises an exception if the slot was empty. C++
signature : void delete_clip(TPyHandle<AGroupAndClipSlotBase>)

Live.ClipSlot.ClipSlot.fire() Method
fire( (ClipSlot)arg1) -> None : Fire a Clip if this Clipslot owns one, else trigger the stop button, if we have one. C++ signature :
void fire(TPyHandle<AGroupAndClipSlotBase>)fire( (ClipSlot)self [, (float)record_length=1.7976931348623157e+308 [,
(int)launch_quantization=-2147483648 [, (bool)force_legato=False]]]) -> None : If 'record_length' is passed, the clip will be
refired after the given recording length. Raises an error if the slot owns a clip. 'launch_quantization' determines the quantization
of global transport that is applied overriding the value in the song. 'force_legato' will make the clip play inmediatelly. The
playhead will be moved to keep the clip synchronized. C++ signature : void fire(TPyHandle<AGroupAndClipSlotBase>
[,double=1.7976931348623157e+308 [,int=-2147483648 [,bool=False]]])

Live.ClipSlot.ClipSlot.has_clip_has_listener() Method
has_clip_has_listener( (ClipSlot)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "has_clip". C++ signature : bool
has_clip_has_listener(TPyHandle<AGroupAndClipSlotBase>,boost::python::api::object)

Live.ClipSlot.ClipSlot.has_stop_button_has_listener() Method
has_stop_button_has_listener( (ClipSlot)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "has_stop_button". C++ signature : bool
has_stop_button_has_listener(TPyHandle<AGroupAndClipSlotBase>,boost::python::api::object)

Live.ClipSlot.ClipSlot.is_triggered_has_listener() Method
is_triggered_has_listener( (ClipSlot)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "is_triggered". C++ signature : bool
is_triggered_has_listener(TPyHandle<AGroupAndClipSlotBase>,boost::python::api::object)

Live.ClipSlot.ClipSlot.playing_status_has_listener() Method
playing_status_has_listener( (ClipSlot)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "playing_status". C++ signature : bool
playing_status_has_listener(TPyHandle<AGroupAndClipSlotBase>,boost::python::api::object)

Live.ClipSlot.ClipSlot.remove_color_listener() Method
remove_color_listener( (ClipSlot)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "color". C++ signature : void
remove_color_listener(TPyHandle<AGroupAndClipSlotBase>,boost::python::api::object)

Live.ClipSlot.ClipSlot.remove_controls_other_clips_listener() Method
remove_controls_other_clips_listener( (ClipSlot)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "controls_other_clips". C++ signature : void
remove_controls_other_clips_listener(TPyHandle<AGroupAndClipSlotBase>,boost::python::api::object)

Live.ClipSlot.ClipSlot.remove_has_clip_listener() Method
remove_has_clip_listener( (ClipSlot)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "has_clip". C++ signature : void
remove_has_clip_listener(TPyHandle<AGroupAndClipSlotBase>,boost::python::api::object)

Live.ClipSlot.ClipSlot.remove_has_stop_button_listener() Method
remove_has_stop_button_listener( (ClipSlot)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "has_stop_button". C++ signature : void
remove_has_stop_button_listener(TPyHandle<AGroupAndClipSlotBase>,boost::python::api::object)

Live.ClipSlot.ClipSlot.remove_is_triggered_listener() Method
remove_is_triggered_listener( (ClipSlot)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "is_triggered". C++ signature : void
remove_is_triggered_listener(TPyHandle<AGroupAndClipSlotBase>,boost::python::api::object)

Live.ClipSlot.ClipSlot.remove_playing_status_listener() Method
remove_playing_status_listener( (ClipSlot)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "playing_status". C++ signature : void
remove_playing_status_listener(TPyHandle<AGroupAndClipSlotBase>,boost::python::api::object)

Live.ClipSlot.ClipSlot.set_fire_button_state() Method
set_fire_button_state( (ClipSlot)arg1, (bool)arg2) -> None : Set the clipslot's fire button state directly. Supports all launch
modes. C++ signature : void set_fire_button_state(TPyHandle<AGroupAndClipSlotBase>,bool)

Live.ClipSlot.ClipSlot.stop() Method
stop( (ClipSlot)arg1) -> None : Stop playing the contained Clip, if there is a Clip and its currently playing. C++ signature : void
stop(TPyHandle<AGroupAndClipSlotBase>)

12/09/2014 14:09

18 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live.Device

Module

Live.Device.Device

Class

This class represents a MIDI or Audio DSP-Device in Live.

Live.Device.Device.can_have_chains Property
Returns true if the device is a rack.

Live.Device.Device.can_have_drum_pads Property
Returns true if the device is a drum rack.

Live.Device.Device.canonical_parent Property
Get the canonical parent of the Device.

Live.Device.Device.chains Property
Return const access to the list of chains in this device. Throws an exception if can_have_chains is false.

Live.Device.Device.class_display_name Property
Return const access to the name of the device's class name as displayed in Live's browser and device chain

Live.Device.Device.class_name Property
Return const access to the name of the device's class.

Live.Device.Device.drum_pads Property
Return const access to the list of drum pads in this device. Throws an exception if can_have_drum_pads is false.

Live.Device.Device.has_drum_pads Property
Returns true if the device is a drum rack which has drum pads. Throws an exception if can_have_drum_pads is false.

Live.Device.Device.name Property
Return access to the name of the device.

Live.Device.Device.parameters Property
Const access to the list of available automatable parameters for this device.

Live.Device.Device.return_chains Property
Return const access to the list of return chains in this device. Throws an exception if can_have_chains is false.

Live.Device.Device.type Property
Return the type of the device.

Live.Device.Device.view Property
Representing the view aspects of a device.

Live.Device.Device.visible_drum_pads Property
Return const access to the list of visible drum pads in this device. Throws an exception if can_have_drum_pads is false.

Live.Device.Device.add_chains_listener() Method
add_chains_listener( (Device)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as
the property "chains" has changed. C++ signature : void
add_chains_listener(TPyHandle<ADevice>,boost::python::api::object)

Live.Device.Device.add_drum_pads_listener() Method
add_drum_pads_listener( (Device)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "drum_pads" has changed. C++ signature : void
add_drum_pads_listener(TPyHandle<ADevice>,boost::python::api::object)

Live.Device.Device.add_has_drum_pads_listener() Method
add_has_drum_pads_listener( (Device)arg1, (object)arg2) -> None : Add a listener function or method, which will be called
as soon as the property "has_drum_pads" has changed. C++ signature : void
add_has_drum_pads_listener(TPyHandle<ADevice>,boost::python::api::object)

Live.Device.Device.add_name_listener() Method
add_name_listener( (Device)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as
the property "name" has changed. C++ signature : void
add_name_listener(TPyHandle<ADevice>,boost::python::api::object)

Live.Device.Device.add_parameters_listener() Method

12/09/2014 14:09

19 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

add_parameters_listener( (Device)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "parameters" has changed. C++ signature : void
add_parameters_listener(TPyHandle<ADevice>,boost::python::api::object)

Live.Device.Device.add_return_chains_listener() Method
add_return_chains_listener( (Device)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "return_chains" has changed. C++ signature : void
add_return_chains_listener(TPyHandle<ADevice>,boost::python::api::object)

Live.Device.Device.add_visible_drum_pads_listener() Method
add_visible_drum_pads_listener( (Device)arg1, (object)arg2) -> None : Add a listener function or method, which will be
called as soon as the property "visible_drum_pads" has changed. C++ signature : void
add_visible_drum_pads_listener(TPyHandle<ADevice>,boost::python::api::object)

Live.Device.Device.chains_has_listener() Method
chains_has_listener( (Device)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected
to the property "chains". C++ signature : bool chains_has_listener(TPyHandle<ADevice>,boost::python::api::object)

Live.Device.Device.drum_pads_has_listener() Method
drum_pads_has_listener( (Device)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "drum_pads". C++ signature : bool
drum_pads_has_listener(TPyHandle<ADevice>,boost::python::api::object)

Live.Device.Device.get_bank_count() Method
get_bank_count( (Device)arg1) -> int : Get the number of parameter banks. This is related to hardware control surfaces. For
Max devices only. C++ signature : int get_bank_count(TPyHandle<ADevice>)

Live.Device.Device.get_bank_name() Method
get_bank_name( (Device)arg1, (int)arg2) -> object : Get the name of a parameter bank given by index. This is related to
hardware control surfaces. For Max devices only. C++ signature : TString get_bank_name(TPyHandle<ADevice>,int)

Live.Device.Device.get_bank_parameters() Method
get_bank_parameters( (Device)arg1, (int)arg2) -> list : Get the indices of parameters of the given bank index. Empty slots
are marked as -1. Bank index -1 refers to the best-of bank. This function is related to hardware control surfaces. For Max
devices only. C++ signature : boost::python::list get_bank_parameters(TPyHandle<ADevice>,int)

Live.Device.Device.has_drum_pads_has_listener() Method
has_drum_pads_has_listener( (Device)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "has_drum_pads". C++ signature : bool
has_drum_pads_has_listener(TPyHandle<ADevice>,boost::python::api::object)

Live.Device.Device.name_has_listener() Method
name_has_listener( (Device)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to
the property "name". C++ signature : bool name_has_listener(TPyHandle<ADevice>,boost::python::api::object)

Live.Device.Device.parameters_has_listener() Method
parameters_has_listener( (Device)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "parameters". C++ signature : bool
parameters_has_listener(TPyHandle<ADevice>,boost::python::api::object)

Live.Device.Device.remove_chains_listener() Method
remove_chains_listener( (Device)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "chains". C++ signature : void remove_chains_listener(TPyHandle<ADevice>,boost::python::api::object)

Live.Device.Device.remove_drum_pads_listener() Method
remove_drum_pads_listener( (Device)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "drum_pads". C++ signature : void remove_drum_pads_listener(TPyHandle<ADevice>,boost::python::api::object)

Live.Device.Device.remove_has_drum_pads_listener() Method
remove_has_drum_pads_listener( (Device)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "has_drum_pads". C++ signature : void
remove_has_drum_pads_listener(TPyHandle<ADevice>,boost::python::api::object)

Live.Device.Device.remove_name_listener() Method
remove_name_listener( (Device)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "name". C++ signature : void remove_name_listener(TPyHandle<ADevice>,boost::python::api::object)

Live.Device.Device.remove_parameters_listener() Method
remove_parameters_listener( (Device)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "parameters". C++ signature : void
remove_parameters_listener(TPyHandle<ADevice>,boost::python::api::object)

12/09/2014 14:09

20 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live.Device.Device.remove_return_chains_listener() Method
remove_return_chains_listener( (Device)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "return_chains". C++ signature : void
remove_return_chains_listener(TPyHandle<ADevice>,boost::python::api::object)

Live.Device.Device.remove_visible_drum_pads_listener() Method
remove_visible_drum_pads_listener( (Device)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "visible_drum_pads". C++ signature : void
remove_visible_drum_pads_listener(TPyHandle<ADevice>,boost::python::api::object)

Live.Device.Device.return_chains_has_listener() Method
return_chains_has_listener( (Device)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "return_chains". C++ signature : bool
return_chains_has_listener(TPyHandle<ADevice>,boost::python::api::object)

Live.Device.Device.store_chosen_bank() Method
store_chosen_bank( (Device)arg1, (int)arg2, (int)arg3) -> None : Set the selected bank in the device for persistency. C++
signature : void store_chosen_bank(TPyHandle<ADevice>,int,int)

Live.Device.Device.visible_drum_pads_has_listener() Method
visible_drum_pads_has_listener( (Device)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "visible_drum_pads". C++ signature : bool
visible_drum_pads_has_listener(TPyHandle<ADevice>,boost::python::api::object)

Live.Device.Device.View

Class

Representing the view aspects of a device.

Live.Device.Device.View.canonical_parent Property
Get the canonical parent of the View.

Live.Device.Device.View.drum_pads_scroll_position Property
Access to the index of the lowest visible row of pads. Throws an exception if can_have_drum_pads is false.

Live.Device.Device.View.selected_chain Property
Return access to the currently selected chain. Throws an exception if can_have_chains is false.

Live.Device.Device.View.selected_drum_pad Property
Return access to the currently selected drum pad. Throws an exception if can_have_drum_pads is false.

Live.Device.Device.View.add_drum_pads_scroll_position_listener() Method
add_drum_pads_scroll_position_listener( (View)arg1, (object)arg2) -> None : Add a listener function or method, which will be
called as soon as the property "drum_pads_scroll_position" has changed. C++ signature : void
add_drum_pads_scroll_position_listener(TPyViewData<ADevice>,boost::python::api::object)

Live.Device.Device.View.add_selected_chain_listener() Method
add_selected_chain_listener( (View)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "selected_chain" has changed. C++ signature : void
add_selected_chain_listener(TPyViewData<ADevice>,boost::python::api::object)

Live.Device.Device.View.add_selected_drum_pad_listener() Method
add_selected_drum_pad_listener( (View)arg1, (object)arg2) -> None : Add a listener function or method, which will be called
as soon as the property "selected_drum_pad" has changed. C++ signature : void
add_selected_drum_pad_listener(TPyViewData<ADevice>,boost::python::api::object)

Live.Device.Device.View.drum_pads_scroll_position_has_listener() Method
drum_pads_scroll_position_has_listener( (View)arg1, (object)arg2) -> bool : Returns true, if the given listener function or
method is connected to the property "drum_pads_scroll_position". C++ signature : bool
drum_pads_scroll_position_has_listener(TPyViewData<ADevice>,boost::python::api::object)

Live.Device.Device.View.remove_drum_pads_scroll_position_listener() Method
remove_drum_pads_scroll_position_listener( (View)arg1, (object)arg2) -> None : Remove a previously set listener function
or method from property "drum_pads_scroll_position". C++ signature : void
remove_drum_pads_scroll_position_listener(TPyViewData<ADevice>,boost::python::api::object)

Live.Device.Device.View.remove_selected_chain_listener() Method
remove_selected_chain_listener( (View)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "selected_chain". C++ signature : void
remove_selected_chain_listener(TPyViewData<ADevice>,boost::python::api::object)

12/09/2014 14:09

21 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live.Device.Device.View.remove_selected_drum_pad_listener() Method
remove_selected_drum_pad_listener( (View)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "selected_drum_pad". C++ signature : void
remove_selected_drum_pad_listener(TPyViewData<ADevice>,boost::python::api::object)

Live.Device.Device.View.selected_chain_has_listener() Method
selected_chain_has_listener( (View)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "selected_chain". C++ signature : bool
selected_chain_has_listener(TPyViewData<ADevice>,boost::python::api::object)

Live.Device.Device.View.selected_drum_pad_has_listener() Method
selected_drum_pad_has_listener( (View)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "selected_drum_pad". C++ signature : bool
selected_drum_pad_has_listener(TPyViewData<ADevice>,boost::python::api::object)

Live.Device.DeviceType

Class

The type of the device.

Live.Device.DeviceType.audio_effect Value
The type of the device.

Live.Device.DeviceType.instrument Value
The type of the device.

Live.Device.DeviceType.midi_effect Value
The type of the device.

Live.Device.DeviceType.undefined Value
The type of the device.

Live.DeviceParameter

Module

Live.DeviceParameter.AutomationState

Class

Live.DeviceParameter.AutomationState.none Value
Live.DeviceParameter.AutomationState.overridden Value
Live.DeviceParameter.AutomationState.playing Value

Live.DeviceParameter.DeviceParameter

Class

This class represents a (automatable) parameter within a MIDI orAudio DSP-Device.

Live.DeviceParameter.DeviceParameter.automation_state Property
Returns state of type AutomationState.

Live.DeviceParameter.DeviceParameter.canonical_parent Property
Get the canonical parent of the device parameter.

Live.DeviceParameter.DeviceParameter.default_value Property
Return the default value for this parameter. A Default value is onlyavailable for non-quantized parameter types (see
'is_quantized').

Live.DeviceParameter.DeviceParameter.is_enabled Property
Returns false if the parameter has been macro mapped or disabled by Max.

Live.DeviceParameter.DeviceParameter.is_quantized Property
Returns True, if this value is a boolean or integer like switch.Non quantized values are continues float values.

Live.DeviceParameter.DeviceParameter.max Property
Returns const access to the upper value of the allowed range forthis parameter

Live.DeviceParameter.DeviceParameter.min Property
Returns const access to the lower value of the allowed range forthis parameter

12/09/2014 14:09

22 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live.DeviceParameter.DeviceParameter.name Property
Returns const access the name of this parameter, as visible in Livesautomation choosers.

Live.DeviceParameter.DeviceParameter.original_name Property
Returns const access the original name of this parameter, unaffected ofany renamings.

Live.DeviceParameter.DeviceParameter.value Property
Get/Set the current value (as visible in the GUI) this parameter.The value must be inside the min/max properties of this device.

Live.DeviceParameter.DeviceParameter.add_automation_state_listener() Method
add_automation_state_listener( (DeviceParameter)arg1, (object)arg2) -> None : Add a listener function or method, which will
be called as soon as the property "automation_state" has changed. C++ signature : void
add_automation_state_listener(TPyHandle<ATimeable>,boost::python::api::object)

Live.DeviceParameter.DeviceParameter.add_value_listener() Method
add_value_listener( (DeviceParameter)arg1, (object)arg2) -> None : Add a listener function or method, which will be called
as soon as the property "value" has changed. C++ signature : void
add_value_listener(TPyHandle<ATimeable>,boost::python::api::object)

Live.DeviceParameter.DeviceParameter.automation_state_has_listener() Method
automation_state_has_listener( (DeviceParameter)arg1, (object)arg2) -> bool : Returns true, if the given listener function or
method is connected to the property "automation_state". C++ signature : bool
automation_state_has_listener(TPyHandle<ATimeable>,boost::python::api::object)

Live.DeviceParameter.DeviceParameter.begin_gesture() Method
begin_gesture( (DeviceParameter)arg1) -> None : Notify the begin of a modification of the parameter, when a sequence of
modifications have to be consider a consistent group -- for Sexample, when recording automation. C++ signature : void
begin_gesture(TPyHandle<ATimeable>)

Live.DeviceParameter.DeviceParameter.end_gesture() Method
end_gesture( (DeviceParameter)arg1) -> None : Notify the end of a modification of the parameter. See begin_gesture. C++
signature : void end_gesture(TPyHandle<ATimeable>)

Live.DeviceParameter.DeviceParameter.re_enable_automation() Method
re_enable_automation( (DeviceParameter)arg1) -> None : Reenable automation for this parameter. C++ signature : void
re_enable_automation(TPyHandle<ATimeable>)

Live.DeviceParameter.DeviceParameter.remove_automation_state_listener() Method
remove_automation_state_listener( (DeviceParameter)arg1, (object)arg2) -> None : Remove a previously set listener
function or method from property "automation_state". C++ signature : void
remove_automation_state_listener(TPyHandle<ATimeable>,boost::python::api::object)

Live.DeviceParameter.DeviceParameter.remove_value_listener() Method
remove_value_listener( (DeviceParameter)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "value". C++ signature : void remove_value_listener(TPyHandle<ATimeable>,boost::python::api::object)

Live.DeviceParameter.DeviceParameter.str_for_value() Method
str_for_value( (DeviceParameter)arg1, (float)arg2) -> object : Return a string representation of the given value. To be used
for display purposes only. This value can include characters like 'db' or 'hz', depending on the type of the parameter. C++
signature : TString str_for_value(TPyHandle<ATimeable>,float)

Live.DeviceParameter.DeviceParameter.value_has_listener() Method
value_has_listener( (DeviceParameter)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "value". C++ signature : bool
value_has_listener(TPyHandle<ATimeable>,boost::python::api::object)

Live.DrumPad

Module

Live.DrumPad.DrumPad

Class

This class represents a drum group device pad in Live.

Live.DrumPad.DrumPad.canonical_parent Property
Get the canonical parent of the drum pad.

Live.DrumPad.DrumPad.chains Property
Return const access to the list of chains in this drum pad.

Live.DrumPad.DrumPad.mute Property

12/09/2014 14:09

23 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Mute/unmute the pad.

Live.DrumPad.DrumPad.name Property
Return const access to the drum pad's name. It depends on the contained chains.

Live.DrumPad.DrumPad.note Property
Get the MIDI note of the drum pad.

Live.DrumPad.DrumPad.solo Property
Solo/unsolo the pad.

Live.DrumPad.DrumPad.add_chains_listener() Method
add_chains_listener( (DrumPad)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon
as the property "chains" has changed. C++ signature : void
add_chains_listener(TPyHandle<ADrumGroupDevicePad>,boost::python::api::object)

Live.DrumPad.DrumPad.add_mute_listener() Method
add_mute_listener( (DrumPad)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon
as the property "mute" has changed. C++ signature : void
add_mute_listener(TPyHandle<ADrumGroupDevicePad>,boost::python::api::object)

Live.DrumPad.DrumPad.add_name_listener() Method
add_name_listener( (DrumPad)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon
as the property "name" has changed. C++ signature : void
add_name_listener(TPyHandle<ADrumGroupDevicePad>,boost::python::api::object)

Live.DrumPad.DrumPad.add_solo_listener() Method
add_solo_listener( (DrumPad)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as
the property "solo" has changed. C++ signature : void
add_solo_listener(TPyHandle<ADrumGroupDevicePad>,boost::python::api::object)

Live.DrumPad.DrumPad.chains_has_listener() Method
chains_has_listener( (DrumPad)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "chains". C++ signature : bool
chains_has_listener(TPyHandle<ADrumGroupDevicePad>,boost::python::api::object)

Live.DrumPad.DrumPad.mute_has_listener() Method
mute_has_listener( (DrumPad)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected
to the property "mute". C++ signature : bool
mute_has_listener(TPyHandle<ADrumGroupDevicePad>,boost::python::api::object)

Live.DrumPad.DrumPad.name_has_listener() Method
name_has_listener( (DrumPad)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected
to the property "name". C++ signature : bool
name_has_listener(TPyHandle<ADrumGroupDevicePad>,boost::python::api::object)

Live.DrumPad.DrumPad.remove_chains_listener() Method
remove_chains_listener( (DrumPad)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "chains". C++ signature : void
remove_chains_listener(TPyHandle<ADrumGroupDevicePad>,boost::python::api::object)

Live.DrumPad.DrumPad.remove_mute_listener() Method
remove_mute_listener( (DrumPad)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "mute". C++ signature : void
remove_mute_listener(TPyHandle<ADrumGroupDevicePad>,boost::python::api::object)

Live.DrumPad.DrumPad.remove_name_listener() Method
remove_name_listener( (DrumPad)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "name". C++ signature : void
remove_name_listener(TPyHandle<ADrumGroupDevicePad>,boost::python::api::object)

Live.DrumPad.DrumPad.remove_solo_listener() Method
remove_solo_listener( (DrumPad)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "solo". C++ signature : void
remove_solo_listener(TPyHandle<ADrumGroupDevicePad>,boost::python::api::object)

Live.DrumPad.DrumPad.solo_has_listener() Method
solo_has_listener( (DrumPad)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected
to the property "solo". C++ signature : bool
solo_has_listener(TPyHandle<ADrumGroupDevicePad>,boost::python::api::object)

12/09/2014 14:09

24 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live.Listener

Module

Live.Listener.ListenerHandle

Class

This class represents a Python listener when connected to a Live property.

Live.Listener.ListenerHandle.name Property
Prints the name of the property that this listener is connected to

Live.Listener.ListenerHandle.disconnect() Method
disconnect( (ListenerHandle)arg1) -> None : Disconnects the listener from its property C++ signature : void
disconnect(LPythonRemote {lvalue})

Live.LomObject

Module

Live.LomObject.LomObject

Class

this is the base class for an object that is accessible via the LOM

Live.MidiMap

Module

Live.MidiMap.forward_midi_cc() Built-In
forward_midi_cc( (int)arg1, (int)arg2, (int)arg3, (int)arg4) -> bool : C++ signature : bool forward_midi_cc(unsigned
int,unsigned int,int,int)

Live.MidiMap.forward_midi_note() Built-In
forward_midi_note( (int)arg1, (int)arg2, (int)arg3, (int)arg4) -> bool : C++ signature : bool forward_midi_note(unsigned
int,unsigned int,int,int)

Live.MidiMap.forward_midi_pitchbend() Built-In
forward_midi_pitchbend( (int)arg1, (int)arg2, (int)arg3) -> bool : C++ signature : bool forward_midi_pitchbend(unsigned
int,unsigned int,int)

Live.MidiMap.map_midi_cc() Built-In
map_midi_cc( (int)midi_map_handle, (DeviceParameter)parameter, (int)midi_channel, (int)controller_number,
(MapMode)map_mode, (bool)avoid_takeover [, (float)sensitivity=1.0]) -> bool : C++ signature : bool map_midi_cc(unsigned
int,TPyHandle<ATimeable>,int,int,NRemoteMapperTypes::TControllerMapMode,bool [,float=1.0])

Live.MidiMap.map_midi_cc_with_feedback_map() Built-In
map_midi_cc_with_feedback_map( (int)midi_map_handle, (DeviceParameter)parameter, (int)midi_channel,
(int)controller_number, (MapMode)map_mode, (CCFeedbackRule)feedback_rule, (bool)avoid_takeover [, (float)sensitivity=1.0])
-> bool : C++ signature : bool map_midi_cc_with_feedback_map(unsigned
int,TPyHandle<ATimeable>,int,int,NRemoteMapperTypes::TControllerMapMode,NPythonMidiMap::TCCFeedbackRule,bool
[,float=1.0])

Live.MidiMap.map_midi_note() Built-In
map_midi_note( (int)arg1, (DeviceParameter)arg2, (int)arg3, (int)arg4) -> bool : C++ signature : bool
map_midi_note(unsigned int,TPyHandle<ATimeable>,int,int)

Live.MidiMap.map_midi_note_with_feedback_map() Built-In
map_midi_note_with_feedback_map( (int)arg1, (DeviceParameter)arg2, (int)arg3, (int)arg4, (object)arg5) -> bool : C++
signature : bool map_midi_note_with_feedback_map(unsigned
int,TPyHandle<ATimeable>,int,int,NPythonMidiMap::TNoteFeedbackRule)

Live.MidiMap.map_midi_pitchbend() Built-In
map_midi_pitchbend( (int)arg1, (DeviceParameter)arg2, (int)arg3, (bool)arg4) -> bool : C++ signature : bool
map_midi_pitchbend(unsigned int,TPyHandle<ATimeable>,int,bool)

Live.MidiMap.map_midi_pitchbend_with_feedback_map() Built-In
map_midi_pitchbend_with_feedback_map( (int)arg1, (DeviceParameter)arg2, (int)arg3, (PitchBendFeedbackRule)arg4,
(bool)arg5) -> bool : C++ signature : bool map_midi_pitchbend_with_feedback_map(unsigned
int,TPyHandle<ATimeable>,int,NPythonMidiMap::TPitchBendFeedbackRule,bool)

Live.MidiMap.send_feedback_for_parameter() Built-In
send_feedback_for_parameter( (int)arg1, (DeviceParameter)arg2) -> None : C++ signature : void
send_feedback_for_parameter(unsigned int,TPyHandle<ATimeable>)

12/09/2014 14:09

25 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live.MidiMap.CCFeedbackRule

Class

Structure to define feedback properties of MIDI mappings.

Live.MidiMap.CCFeedbackRule.cc_no Property
Live.MidiMap.CCFeedbackRule.cc_value_map Property
Live.MidiMap.CCFeedbackRule.channel Property
Live.MidiMap.CCFeedbackRule.delay_in_ms Property

Live.MidiMap.MapMode

Class

Live.MidiMap.MapMode.absolute Value
Live.MidiMap.MapMode.absolute_14_bit Value
Live.MidiMap.MapMode.relative_binary_offset Value
Live.MidiMap.MapMode.relative_signed_bit Value
Live.MidiMap.MapMode.relative_signed_bit2 Value
Live.MidiMap.MapMode.relative_smooth_binary_offset Value
Live.MidiMap.MapMode.relative_smooth_signed_bit Value
Live.MidiMap.MapMode.relative_smooth_signed_bit2 Value
Live.MidiMap.MapMode.relative_smooth_two_compliment Value
Live.MidiMap.MapMode.relative_two_compliment Value

Live.MidiMap.PitchBendFeedbackRule

Class

Structure to define feedback properties of MIDI mappings.

Live.MidiMap.PitchBendFeedbackRule.channel Property
Live.MidiMap.PitchBendFeedbackRule.delay_in_ms Property
Live.MidiMap.PitchBendFeedbackRule.value_pair_map Property

Live.MixerDevice

Module

Live.MixerDevice.MixerDevice

Class

This class represents a Mixer Device in Live, which gives youaccess to the Volume and Panning properties of a Track.

Live.MixerDevice.MixerDevice.canonical_parent Property
Get the canonical parent of the mixer device.

Live.MixerDevice.MixerDevice.crossfade_assign Property
Player- and ReturnTracks only: Const access to the Track's Crossfade Assign State.

Live.MixerDevice.MixerDevice.crossfader Property
MasterTrack only: Const access to the Crossfader.

Live.MixerDevice.MixerDevice.cue_volume Property
MasterTrack only: Const access to the Cue Volume Parameter.

Live.MixerDevice.MixerDevice.panning Property
Const access to the Tracks Panning Device Parameter.

Live.MixerDevice.MixerDevice.sends Property
Const access to the Tracks list of Send Amount Device Parameters.

12/09/2014 14:09

26 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live.MixerDevice.MixerDevice.song_tempo Property
MasterTrack only: Const access to the Song's Tempo.

Live.MixerDevice.MixerDevice.track_activator Property
Const access to the Tracks Activator Device Parameter.

Live.MixerDevice.MixerDevice.volume Property
Const access to the Tracks Volume Device Parameter.

Live.MixerDevice.MixerDevice.add_crossfade_assign_listener() Method
add_crossfade_assign_listener( (MixerDevice)arg1, (object)arg2) -> None : Add a listener function or method, which will be
called as soon as the property "crossfade_assign" has changed. C++ signature : void
add_crossfade_assign_listener(TPyHandle<ATrackDevice>,boost::python::api::object)

Live.MixerDevice.MixerDevice.add_sends_listener() Method
add_sends_listener( (MixerDevice)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "sends" has changed. C++ signature : void
add_sends_listener(TPyHandle<ATrackDevice>,boost::python::api::object)

Live.MixerDevice.MixerDevice.crossfade_assign_has_listener() Method
crossfade_assign_has_listener( (MixerDevice)arg1, (object)arg2) -> bool : Returns true, if the given listener function or
method is connected to the property "crossfade_assign". C++ signature : bool
crossfade_assign_has_listener(TPyHandle<ATrackDevice>,boost::python::api::object)

Live.MixerDevice.MixerDevice.remove_crossfade_assign_listener() Method
remove_crossfade_assign_listener( (MixerDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "crossfade_assign". C++ signature : void
remove_crossfade_assign_listener(TPyHandle<ATrackDevice>,boost::python::api::object)

Live.MixerDevice.MixerDevice.remove_sends_listener() Method
remove_sends_listener( (MixerDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "sends". C++ signature : void remove_sends_listener(TPyHandle<ATrackDevice>,boost::python::api::object)

Live.MixerDevice.MixerDevice.sends_has_listener() Method
sends_has_listener( (MixerDevice)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "sends". C++ signature : bool
sends_has_listener(TPyHandle<ATrackDevice>,boost::python::api::object)

Live.MixerDevice.MixerDevice.crossfade_assignments

Sub-Class

Live.MixerDevice.MixerDevice.crossfade_assignments.A Value
Live.MixerDevice.MixerDevice.crossfade_assignments.B Value
Live.MixerDevice.MixerDevice.crossfade_assignments.NONE Value

Live.Scene

Module

Live.Scene.Scene

Class

This class represents an series of ClipSlots in Lives Sessionview matrix.

Live.Scene.Scene.canonical_parent Property
Get the canonical parent of the scene.

Live.Scene.Scene.clip_slots Property
return a list of clipslots (see class AClipSlot) that this scene covers.

Live.Scene.Scene.color Property
Get/set access to the color of the Scene (RGB).

Live.Scene.Scene.is_empty Property
Returns True if all clip slots of this scene are empty.

Live.Scene.Scene.is_triggered Property
Const access to the scene's trigger state.

Live.Scene.Scene.name Property

12/09/2014 14:09

27 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Get/Set the name of the scene. Might contain the substring BPM, whichidentifies that the scene will change the tempo when
fireed. To Get/Setthe temp, use the 'tempo' property of the scene.

Live.Scene.Scene.tempo Property
Get/Set the the tempo value of the scene.The Song will use the Scenes tempo as soon as the Scene is fired.Returns -1 if the
Scene has no tempo propery.

Live.Scene.Scene.add_clip_slots_listener() Method
add_clip_slots_listener( (Scene)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon
as the property "clip_slots" has changed. C++ signature : void
add_clip_slots_listener(TPyHandle<AScene>,boost::python::api::object)

Live.Scene.Scene.add_color_listener() Method
add_color_listener( (Scene)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as
the property "color" has changed. C++ signature : void add_color_listener(TPyHandle<AScene>,boost::python::api::object)

Live.Scene.Scene.add_is_triggered_listener() Method
add_is_triggered_listener( (Scene)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "is_triggered" has changed. C++ signature : void
add_is_triggered_listener(TPyHandle<AScene>,boost::python::api::object)

Live.Scene.Scene.add_name_listener() Method
add_name_listener( (Scene)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as
the property "name" has changed. C++ signature : void
add_name_listener(TPyHandle<AScene>,boost::python::api::object)

Live.Scene.Scene.clip_slots_has_listener() Method
clip_slots_has_listener( (Scene)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "clip_slots". C++ signature : bool
clip_slots_has_listener(TPyHandle<AScene>,boost::python::api::object)

Live.Scene.Scene.color_has_listener() Method
color_has_listener( (Scene)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to
the property "color". C++ signature : bool color_has_listener(TPyHandle<AScene>,boost::python::api::object)

Live.Scene.Scene.fire() Method
fire( (Scene)arg1 [, (bool)force_legato=False [, (bool)can_select_scene_on_launch=True]]) -> None : Fire the scene directly.
Will fire all clipslots that this scene owns and select the scene itself. C++ signature : void fire(TPyHandle<AScene>
[,bool=False [,bool=True]])

Live.Scene.Scene.fire_as_selected() Method
fire_as_selected( (Scene)arg1 [, (bool)force_legato=False]) -> None : Fire the selected scene. Will fire all clipslots that this
scene owns and select the next scene if necessary. C++ signature : void fire_as_selected(TPyHandle<AScene>
[,bool=False])

Live.Scene.Scene.is_triggered_has_listener() Method
is_triggered_has_listener( (Scene)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "is_triggered". C++ signature : bool
is_triggered_has_listener(TPyHandle<AScene>,boost::python::api::object)

Live.Scene.Scene.name_has_listener() Method
name_has_listener( (Scene)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to
the property "name". C++ signature : bool name_has_listener(TPyHandle<AScene>,boost::python::api::object)

Live.Scene.Scene.remove_clip_slots_listener() Method
remove_clip_slots_listener( (Scene)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "clip_slots". C++ signature : void remove_clip_slots_listener(TPyHandle<AScene>,boost::python::api::object)

Live.Scene.Scene.remove_color_listener() Method
remove_color_listener( (Scene)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "color". C++ signature : void remove_color_listener(TPyHandle<AScene>,boost::python::api::object)

Live.Scene.Scene.remove_is_triggered_listener() Method
remove_is_triggered_listener( (Scene)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "is_triggered". C++ signature : void remove_is_triggered_listener(TPyHandle<AScene>,boost::python::api::object)

Live.Scene.Scene.remove_name_listener() Method
remove_name_listener( (Scene)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "name". C++ signature : void remove_name_listener(TPyHandle<AScene>,boost::python::api::object)

Live.Scene.Scene.set_fire_button_state() Method

12/09/2014 14:09

28 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

set_fire_button_state( (Scene)arg1, (bool)arg2) -> None : Set the scene's fire button state directly. Supports all launch
modes. C++ signature : void set_fire_button_state(TPyHandle<AScene>,bool)

Live.Song

Module

Live.Song.BeatTime

Class

Represents a Time, splitted into Bars, Beats, SubDivision and Ticks.

Live.Song.BeatTime.bars Property
Live.Song.BeatTime.beats Property
Live.Song.BeatTime.sub_division Property
Live.Song.BeatTime.ticks Property

Live.Song.CaptureMode

Class

The capture mode that is used for capture and insert scene.

Live.Song.CaptureMode.all Value
The capture mode that is used for capture and insert scene.

Live.Song.CaptureMode.all_except_selected Value
The capture mode that is used for capture and insert scene.

Live.Song.CuePoint

Class

Represents a 'Marker' in the arrangement.

Live.Song.CuePoint.canonical_parent Property
Get the canonical parent of the cue point.

Live.Song.CuePoint.name Property
Get/Listen to the name of this CuePoint, as visible in the arranger.

Live.Song.CuePoint.time Property
Get/Listen to the CuePoint's time in beats.

Live.Song.CuePoint.add_name_listener() Method
add_name_listener( (CuePoint)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon
as the property "name" has changed. C++ signature : void
add_name_listener(TPyHandle<ACuePoint>,boost::python::api::object)

Live.Song.CuePoint.add_time_listener() Method
add_time_listener( (CuePoint)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as
the property "time" has changed. C++ signature : void
add_time_listener(TPyHandle<ACuePoint>,boost::python::api::object)

Live.Song.CuePoint.jump() Method
jump( (CuePoint)arg1) -> None : When the Song is playing, set the playing-position quantized to this Cuepoint's time. When
not playing, simply move the start playing position. C++ signature : void jump(TPyHandle<ACuePoint>)

Live.Song.CuePoint.name_has_listener() Method
name_has_listener( (CuePoint)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected
to the property "name". C++ signature : bool name_has_listener(TPyHandle<ACuePoint>,boost::python::api::object)

Live.Song.CuePoint.remove_name_listener() Method
remove_name_listener( (CuePoint)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "name". C++ signature : void remove_name_listener(TPyHandle<ACuePoint>,boost::python::api::object)

Live.Song.CuePoint.remove_time_listener() Method
remove_time_listener( (CuePoint)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "time". C++ signature : void remove_time_listener(TPyHandle<ACuePoint>,boost::python::api::object)

Live.Song.CuePoint.time_has_listener() Method
time_has_listener( (CuePoint)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected
to the property "time". C++ signature : bool time_has_listener(TPyHandle<ACuePoint>,boost::python::api::object)

12/09/2014 14:09

29 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live.Song.Quantization

Class

Live.Song.Quantization.q_2_bars Value
Live.Song.Quantization.q_4_bars Value
Live.Song.Quantization.q_8_bars Value
Live.Song.Quantization.q_bar Value
Live.Song.Quantization.q_eight Value
Live.Song.Quantization.q_eight_triplet Value
Live.Song.Quantization.q_half Value
Live.Song.Quantization.q_half_triplet Value
Live.Song.Quantization.q_no_q Value
Live.Song.Quantization.q_quarter Value
Live.Song.Quantization.q_quarter_triplet Value
Live.Song.Quantization.q_sixtenth Value
Live.Song.Quantization.q_sixtenth_triplet Value
Live.Song.Quantization.q_thirtytwoth Value

Live.Song.RecordingQuantization

Class

Live.Song.RecordingQuantization.rec_q_eight Value
Live.Song.RecordingQuantization.rec_q_eight_eight_triplet Value
Live.Song.RecordingQuantization.rec_q_eight_triplet Value
Live.Song.RecordingQuantization.rec_q_no_q Value
Live.Song.RecordingQuantization.rec_q_quarter Value
Live.Song.RecordingQuantization.rec_q_sixtenth Value
Live.Song.RecordingQuantization.rec_q_sixtenth_sixtenth_triplet Value
Live.Song.RecordingQuantization.rec_q_sixtenth_triplet Value
Live.Song.RecordingQuantization.rec_q_thirtysecond Value

Live.Song.SessionRecordStatus

Class

Live.Song.SessionRecordStatus.off Value
Live.Song.SessionRecordStatus.on Value
Live.Song.SessionRecordStatus.transition Value

Live.Song.SmptTime

Class

Represents a Time, split into Hours, Minutes, Seconds and Frames.The frame type must be specified when calling a function
that returnsa SmptTime.

Live.Song.SmptTime.frames Property
Live.Song.SmptTime.hours Property

12/09/2014 14:09

30 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live.Song.SmptTime.minutes Property
Live.Song.SmptTime.seconds Property

Live.Song.Song

Class

This class represents a Live set.

Live.Song.Song.appointed_device Property
Access to the selected Device

Live.Song.Song.arrangement_overdub Property
Get/Set the global arrangement overdub state.

Live.Song.Song.back_to_arranger Property
Get/Set if triggering a Clip in the Session, disabled the playback ofClips in the Arranger.

Live.Song.Song.can_jump_to_next_cue Property
Returns true when there is a cue marker right to the playing pos thatwe could jump to.

Live.Song.Song.can_jump_to_prev_cue Property
Returns true when there is a cue marker left to the playing pos thatwe could jump to.

Live.Song.Song.can_redo Property
Returns true if there is an undone action that we can redo.

Live.Song.Song.can_undo Property
Returns true if there is an action that we can restore.

Live.Song.Song.canonical_parent Property
Get the canonical parent of the song.

Live.Song.Song.clip_trigger_quantization Property
Get/Set access to the quantization settings that are used to fireClips in the Session.

Live.Song.Song.cue_points Property
Const access to a list of all cue points of the Live Song.

Live.Song.Song.current_song_time Property
Get/Set access to the songs current playing position in ms.

Live.Song.Song.exclusive_arm Property
Get if Tracks should be armed exclusively by default.

Live.Song.Song.exclusive_solo Property
Get if Tracks should be soloed exclusively by default.

Live.Song.Song.groove_amount Property
Get/Set the global groove amount, that adjust all setup groovesin all clips.

Live.Song.Song.is_playing Property
Returns true if the Song is currently playing.

Live.Song.Song.last_event_time Property
Return the time of the last set event in the song. In contrary tosong_length, this will not add some extra beats that are mostly
neededfor Display purposes in the Arrangerview.

Live.Song.Song.loop Property
Get/Set the the looping flag that en/disables the usage of the globalloop markers in the song.

Live.Song.Song.loop_length Property
Get/Set the lenght of the global loop marker position in beats.

Live.Song.Song.loop_start Property
Get/Set the start of the global loop marker position in beats.

Live.Song.Song.master_track Property
Access to the Master Track (always available)

12/09/2014 14:09

31 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live.Song.Song.metronome Property
Get/Set if the metronom is audible.

Live.Song.Song.midi_recording_quantization Property
Get/Set access to the settings that are used to quantizeMIDI recordings.

Live.Song.Song.nudge_down Property
Get/Set the status of the nudge down button.

Live.Song.Song.nudge_up Property
Get/Set the status of the nudge up button.

Live.Song.Song.overdub Property
Legacy hook for Live 8 overdub state. Now hooks tosession record.

Live.Song.Song.punch_in Property
Get/Set the flag that will enable recording as soon as the Song playsand hits the global loop start region.

Live.Song.Song.punch_out Property
Get/Set the flag that will disable recording as soon as the Song playsand hits the global loop end region.

Live.Song.Song.re_enable_automation_enabled Property
Returns true if some automated parameter has been overriden

Live.Song.Song.record_mode Property
Get/Set the state of the global recording flag.

Live.Song.Song.return_tracks Property
Const access to the list of available Return Tracks.

Live.Song.Song.scenes Property
Const access to a list of all Scenes in the Live Song.

Live.Song.Song.select_on_launch Property
Get if Scenes and Clips should be selected when fired.

Live.Song.Song.session_automation_record Property
Returns true if automation recording is enabled.

Live.Song.Song.session_record Property
Get/Set the session record state.

Live.Song.Song.session_record_status Property
Get the session slot-recording state.

Live.Song.Song.signature_denominator Property
Get/Set access to the global signature denominator of the Song.

Live.Song.Song.signature_numerator Property
Get/Set access to the global signature numerator of the Song.

Live.Song.Song.song_length Property
Return the time of the last set event in the song, plus som extra beatsthat are usually added for better navigation in the
arrangerview.

Live.Song.Song.swing_amount Property
Get/Set access to the amount of swing that is applied when adding or quantizing notes to MIDI clips

Live.Song.Song.tempo Property
Get/Set the global project tempo.

Live.Song.Song.tracks Property
Const access to a list of all Player Tracks in the Live Song, exludingthe return and Master Track (see also Song.send_tracks
and Song.master_track).At least one MIDI or Audio Track is always available.

Live.Song.Song.view Property
Representing the view aspects of a Live document: The Session and Arrangerview.

Live.Song.Song.visible_tracks Property
Const access to a list of all visible Player Tracks in the Live Song, exludingthe return and Master Track (see also

12/09/2014 14:09

32 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Song.send_tracks and Song.master_track).At least one MIDI or Audio Track is always available.

Live.Song.Song.add_appointed_device_listener() Method
add_appointed_device_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be called
as soon as the property "appointed_device" has changed. C++ signature : void
add_appointed_device_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_arrangement_overdub_listener() Method
add_arrangement_overdub_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be
called as soon as the property "arrangement_overdub" has changed. C++ signature : void
add_arrangement_overdub_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_back_to_arranger_listener() Method
add_back_to_arranger_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be called
as soon as the property "back_to_arranger" has changed. C++ signature : void
add_back_to_arranger_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_can_jump_to_next_cue_listener() Method
add_can_jump_to_next_cue_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be
called as soon as the property "can_jump_to_next_cue" has changed. C++ signature : void
add_can_jump_to_next_cue_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_can_jump_to_prev_cue_listener() Method
add_can_jump_to_prev_cue_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be
called as soon as the property "can_jump_to_prev_cue" has changed. C++ signature : void
add_can_jump_to_prev_cue_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_clip_trigger_quantization_listener() Method
add_clip_trigger_quantization_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be
called as soon as the property "clip_trigger_quantization" has changed. C++ signature : void
add_clip_trigger_quantization_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_cue_points_listener() Method
add_cue_points_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon
as the property "cue_points" has changed. C++ signature : void
add_cue_points_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_current_song_time_listener() Method
add_current_song_time_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be called
as soon as the property "current_song_time" has changed. C++ signature : void
add_current_song_time_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_exclusive_arm_listener() Method
add_exclusive_arm_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "exclusive_arm" has changed. C++ signature : void
add_exclusive_arm_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_groove_amount_listener() Method
add_groove_amount_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "groove_amount" has changed. C++ signature : void
add_groove_amount_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_is_playing_listener() Method
add_is_playing_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon
as the property "is_playing" has changed. C++ signature : void
add_is_playing_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_loop_length_listener() Method
add_loop_length_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon
as the property "loop_length" has changed. C++ signature : void
add_loop_length_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_loop_listener() Method
add_loop_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the
property "loop" has changed. C++ signature : void add_loop_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_loop_start_listener() Method
add_loop_start_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon
as the property "loop_start" has changed. C++ signature : void
add_loop_start_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_metronome_listener() Method

12/09/2014 14:09

33 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

add_metronome_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon
as the property "metronome" has changed. C++ signature : void
add_metronome_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_midi_recording_quantization_listener() Method
add_midi_recording_quantization_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will
be called as soon as the property "midi_recording_quantization" has changed. C++ signature : void
add_midi_recording_quantization_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_nudge_down_listener() Method
add_nudge_down_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "nudge_down" has changed. C++ signature : void
add_nudge_down_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_nudge_up_listener() Method
add_nudge_up_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon
as the property "nudge_up" has changed. C++ signature : void
add_nudge_up_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_overdub_listener() Method
add_overdub_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as
the property "overdub" has changed. C++ signature : void
add_overdub_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_punch_in_listener() Method
add_punch_in_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon
as the property "punch_in" has changed. C++ signature : void
add_punch_in_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_punch_out_listener() Method
add_punch_out_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon
as the property "punch_out" has changed. C++ signature : void
add_punch_out_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_re_enable_automation_enabled_listener() Method
add_re_enable_automation_enabled_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which
will be called as soon as the property "re_enable_automation_enabled" has changed. C++ signature : void
add_re_enable_automation_enabled_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_record_mode_listener() Method
add_record_mode_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "record_mode" has changed. C++ signature : void
add_record_mode_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_return_tracks_listener() Method
add_return_tracks_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "return_tracks" has changed. C++ signature : void
add_return_tracks_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_scenes_listener() Method
add_scenes_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as
the property "scenes" has changed. C++ signature : void
add_scenes_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_session_automation_record_listener() Method
add_session_automation_record_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will
be called as soon as the property "session_automation_record" has changed. C++ signature : void
add_session_automation_record_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_session_record_listener() Method
add_session_record_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "session_record" has changed. C++ signature : void
add_session_record_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_session_record_status_listener() Method
add_session_record_status_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be
called as soon as the property "session_record_status" has changed. C++ signature : void
add_session_record_status_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_signature_denominator_listener() Method
add_signature_denominator_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be
called as soon as the property "signature_denominator" has changed. C++ signature : void

12/09/2014 14:09

34 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

add_signature_denominator_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_signature_numerator_listener() Method
add_signature_numerator_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be
called as soon as the property "signature_numerator" has changed. C++ signature : void
add_signature_numerator_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_song_length_listener() Method
add_song_length_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "song_length" has changed. C++ signature : void
add_song_length_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_swing_amount_listener() Method
add_swing_amount_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "swing_amount" has changed. C++ signature : void
add_swing_amount_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_tempo_listener() Method
add_tempo_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as
the property "tempo" has changed. C++ signature : void
add_tempo_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_tracks_listener() Method
add_tracks_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as
the property "tracks" has changed. C++ signature : void
add_tracks_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.add_visible_tracks_listener() Method
add_visible_tracks_listener( (Song)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "visible_tracks" has changed. C++ signature : void
add_visible_tracks_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.appointed_device_has_listener() Method
appointed_device_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "appointed_device". C++ signature : bool
appointed_device_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.arrangement_overdub_has_listener() Method
arrangement_overdub_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method
is connected to the property "arrangement_overdub". C++ signature : bool
arrangement_overdub_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.back_to_arranger_has_listener() Method
back_to_arranger_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "back_to_arranger". C++ signature : bool
back_to_arranger_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.begin_undo_step() Method
begin_undo_step( (Song)arg1) -> None : C++ signature : void begin_undo_step(TPyHandle<ASong>)

Live.Song.Song.can_jump_to_next_cue_has_listener() Method
can_jump_to_next_cue_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or
method is connected to the property "can_jump_to_next_cue". C++ signature : bool
can_jump_to_next_cue_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.can_jump_to_prev_cue_has_listener() Method
can_jump_to_prev_cue_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or
method is connected to the property "can_jump_to_prev_cue". C++ signature : bool
can_jump_to_prev_cue_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.capture_and_insert_scene() Method
capture_and_insert_scene( (Song)arg1 [, (int)CaptureMode=Song.CaptureMode.all]) -> None : Capture currently playing
clips and insert them as a new scene after the selected scene. Raises a runtime error if creating a new scene would exceed the
limitations. C++ signature : void capture_and_insert_scene(TPyHandle<ASong> [,int=Song.CaptureMode.all])

Live.Song.Song.clip_trigger_quantization_has_listener() Method
clip_trigger_quantization_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or
method is connected to the property "clip_trigger_quantization". C++ signature : bool
clip_trigger_quantization_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.continue_playing() Method
continue_playing( (Song)arg1) -> None : Continue playing the song from the current position C++ signature : void

12/09/2014 14:09

35 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

continue_playing(TPyHandle<ASong>)

Live.Song.Song.create_audio_track() Method
create_audio_track( (Song)arg1, (int)arg2) -> None : Create a new audio track at the given index. If the index is -1, the new
track is added at the end. It will create a default audio track if possible. If the index is invalid or the new track would exceed the
limitations, a limitation error is raised. C++ signature : void create_audio_track(TPyHandle<ASong>,int)

Live.Song.Song.create_midi_track() Method
create_midi_track( (Song)arg1, (int)arg2) -> None : Create a new midi track at the given index. If the index is -1, the new
track is added at the end. It will create a default midi track if possible. If the index is invalid or the new track would exceed the
limitations, a limitation error is raised. C++ signature : void create_midi_track(TPyHandle<ASong>,int)

Live.Song.Song.create_return_track() Method
create_return_track( (Song)arg1) -> None : Create a new return track at the end. If the new track would exceed the
limitations, a limitation error is raised. C++ signature : void create_return_track(TPyHandle<ASong>)

Live.Song.Song.create_scene() Method
create_scene( (Song)arg1, (int)arg2) -> Scene : Create a new scene at the given index. If the index is -1, the new scene is
added at the end. If the index is invalid or the new scene would exceed the limitations, a limitation error is raised. C++ signature
: TWeakPtr<TPyHandle<AScene> > create_scene(TPyHandle<ASong>,int)

Live.Song.Song.cue_points_has_listener() Method
cue_points_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "cue_points". C++ signature : bool
cue_points_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.current_song_time_has_listener() Method
current_song_time_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "current_song_time". C++ signature : bool
current_song_time_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.delete_scene() Method
delete_scene( (Song)arg1, (int)arg2) -> None : Delete the scene with the given index. If no scene with this index exists, an
exception will be raised. C++ signature : void delete_scene(TPyHandle<ASong>,int)

Live.Song.Song.delete_track() Method
delete_track( (Song)arg1, (int)arg2) -> None : Delete the track with the given index. If no track with this index exists, an
exception will be raised. C++ signature : void delete_track(TPyHandle<ASong>,int)

Live.Song.Song.duplicate_scene() Method
duplicate_scene( (Song)arg1, (int)arg2) -> None : Duplicates a scene and selects the new one. Raises a limitation error if
creating a new scene would exceed the limitations. C++ signature : void duplicate_scene(TPyHandle<ASong>,int)

Live.Song.Song.duplicate_track() Method
duplicate_track( (Song)arg1, (int)arg2) -> None : Duplicates a track and selects the new one. Raises a limitation error if
creating a new track would exceed the limitations. C++ signature : void duplicate_track(TPyHandle<ASong>,int)

Live.Song.Song.end_undo_step() Method
end_undo_step( (Song)arg1) -> None : C++ signature : void end_undo_step(TPyHandle<ASong>)

Live.Song.Song.exclusive_arm_has_listener() Method
exclusive_arm_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "exclusive_arm". C++ signature : bool
exclusive_arm_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.get_beats_loop_length() Method
get_beats_loop_length( (Song)arg1) -> BeatTime : Get const access to the songs loop length, using a BeatTime class with
the current global set signature. C++ signature : NPythonSong::TBeatTime get_beats_loop_length(TPyHandle<ASong>)

Live.Song.Song.get_beats_loop_start() Method
get_beats_loop_start( (Song)arg1) -> BeatTime : Get const access to the songs loop start, using a BeatTime class with the
current global set signature. C++ signature : NPythonSong::TBeatTime get_beats_loop_start(TPyHandle<ASong>)

Live.Song.Song.get_current_beats_song_time() Method
get_current_beats_song_time( (Song)arg1) -> BeatTime : Get const access to the songs current playing position, using a
BeatTime class with the current global set signature. C++ signature : NPythonSong::TBeatTime
get_current_beats_song_time(TPyHandle<ASong>)

Live.Song.Song.get_current_smpte_song_time() Method
get_current_smpte_song_time( (Song)arg1, (int)arg2) -> SmptTime : Get const access to the songs current playing position,
by specifying the SMPTE format in which you would like to receive the time. C++ signature : NPythonSong::TSmptTime

12/09/2014 14:09

36 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

get_current_smpte_song_time(TPyHandle<ASong>,int)

Live.Song.Song.groove_amount_has_listener() Method
groove_amount_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "groove_amount". C++ signature : bool
groove_amount_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.is_cue_point_selected() Method
is_cue_point_selected( (Song)arg1) -> bool : Return true if the global playing pos is currently on a cue point. C++ signature :
bool is_cue_point_selected(TPyHandle<ASong>)

Live.Song.Song.is_playing_has_listener() Method
is_playing_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "is_playing". C++ signature : bool
is_playing_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.jump_by() Method
jump_by( (Song)arg1, (float)arg2) -> None : Set a new playing pos, relative to the current one. C++ signature : void
jump_by(TPyHandle<ASong>,double)

Live.Song.Song.jump_to_next_cue() Method
jump_to_next_cue( (Song)arg1) -> None : Jump to the next cue (marker) if possible. C++ signature : void
jump_to_next_cue(TPyHandle<ASong>)

Live.Song.Song.jump_to_prev_cue() Method
jump_to_prev_cue( (Song)arg1) -> None : Jump to the prior cue (marker) if possible. C++ signature : void
jump_to_prev_cue(TPyHandle<ASong>)

Live.Song.Song.loop_has_listener() Method
loop_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to
the property "loop". C++ signature : bool loop_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.loop_length_has_listener() Method
loop_length_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "loop_length". C++ signature : bool
loop_length_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.loop_start_has_listener() Method
loop_start_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected
to the property "loop_start". C++ signature : bool loop_start_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.metronome_has_listener() Method
metronome_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "metronome". C++ signature : bool
metronome_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.midi_recording_quantization_has_listener() Method
midi_recording_quantization_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or
method is connected to the property "midi_recording_quantization". C++ signature : bool
midi_recording_quantization_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.nudge_down_has_listener() Method
nudge_down_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "nudge_down". C++ signature : bool
nudge_down_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.nudge_up_has_listener() Method
nudge_up_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "nudge_up". C++ signature : bool
nudge_up_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.overdub_has_listener() Method
overdub_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected
to the property "overdub". C++ signature : bool overdub_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.play_selection() Method
play_selection( (Song)arg1) -> None : Start playing the current set selection, or do nothing if no selection is set. C++
signature : void play_selection(TPyHandle<ASong>)

Live.Song.Song.punch_in_has_listener() Method
punch_in_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected

12/09/2014 14:09

37 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

to the property "punch_in". C++ signature : bool punch_in_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.punch_out_has_listener() Method
punch_out_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "punch_out". C++ signature : bool
punch_out_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.re_enable_automation() Method
re_enable_automation( (Song)arg1) -> None : Discards overrides of automated parameters. C++ signature : void
re_enable_automation(TPyHandle<ASong>)

Live.Song.Song.re_enable_automation_enabled_has_listener() Method
re_enable_automation_enabled_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function
or method is connected to the property "re_enable_automation_enabled". C++ signature : bool
re_enable_automation_enabled_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.record_mode_has_listener() Method
record_mode_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "record_mode". C++ signature : bool
record_mode_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.redo() Method
redo( (Song)arg1) -> None : Redo the last action that was undone. C++ signature : void redo(TPyHandle<ASong>)

Live.Song.Song.remove_appointed_device_listener() Method
remove_appointed_device_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "appointed_device". C++ signature : void
remove_appointed_device_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_arrangement_overdub_listener() Method
remove_arrangement_overdub_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "arrangement_overdub". C++ signature : void
remove_arrangement_overdub_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_back_to_arranger_listener() Method
remove_back_to_arranger_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "back_to_arranger". C++ signature : void
remove_back_to_arranger_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_can_jump_to_next_cue_listener() Method
remove_can_jump_to_next_cue_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "can_jump_to_next_cue". C++ signature : void
remove_can_jump_to_next_cue_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_can_jump_to_prev_cue_listener() Method
remove_can_jump_to_prev_cue_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "can_jump_to_prev_cue". C++ signature : void
remove_can_jump_to_prev_cue_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_clip_trigger_quantization_listener() Method
remove_clip_trigger_quantization_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "clip_trigger_quantization". C++ signature : void
remove_clip_trigger_quantization_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_cue_points_listener() Method
remove_cue_points_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "cue_points". C++ signature : void remove_cue_points_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_current_song_time_listener() Method
remove_current_song_time_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "current_song_time". C++ signature : void
remove_current_song_time_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_exclusive_arm_listener() Method
remove_exclusive_arm_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "exclusive_arm". C++ signature : void
remove_exclusive_arm_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_groove_amount_listener() Method
remove_groove_amount_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "groove_amount". C++ signature : void
remove_groove_amount_listener(TPyHandle<ASong>,boost::python::api::object)

12/09/2014 14:09

38 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live.Song.Song.remove_is_playing_listener() Method
remove_is_playing_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "is_playing". C++ signature : void remove_is_playing_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_loop_length_listener() Method
remove_loop_length_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "loop_length". C++ signature : void remove_loop_length_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_loop_listener() Method
remove_loop_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "loop". C++ signature : void remove_loop_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_loop_start_listener() Method
remove_loop_start_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "loop_start". C++ signature : void remove_loop_start_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_metronome_listener() Method
remove_metronome_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "metronome". C++ signature : void remove_metronome_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_midi_recording_quantization_listener() Method
remove_midi_recording_quantization_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function
or method from property "midi_recording_quantization". C++ signature : void
remove_midi_recording_quantization_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_nudge_down_listener() Method
remove_nudge_down_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "nudge_down". C++ signature : void
remove_nudge_down_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_nudge_up_listener() Method
remove_nudge_up_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "nudge_up". C++ signature : void remove_nudge_up_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_overdub_listener() Method
remove_overdub_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "overdub". C++ signature : void remove_overdub_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_punch_in_listener() Method
remove_punch_in_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "punch_in". C++ signature : void remove_punch_in_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_punch_out_listener() Method
remove_punch_out_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "punch_out". C++ signature : void remove_punch_out_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_re_enable_automation_enabled_listener() Method
remove_re_enable_automation_enabled_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener
function or method from property "re_enable_automation_enabled". C++ signature : void
remove_re_enable_automation_enabled_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_record_mode_listener() Method
remove_record_mode_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "record_mode". C++ signature : void
remove_record_mode_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_return_tracks_listener() Method
remove_return_tracks_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "return_tracks". C++ signature : void
remove_return_tracks_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_scenes_listener() Method
remove_scenes_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "scenes". C++ signature : void remove_scenes_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_session_automation_record_listener() Method
remove_session_automation_record_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function
or method from property "session_automation_record". C++ signature : void
remove_session_automation_record_listener(TPyHandle<ASong>,boost::python::api::object)

12/09/2014 14:09

39 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live.Song.Song.remove_session_record_listener() Method
remove_session_record_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "session_record". C++ signature : void
remove_session_record_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_session_record_status_listener() Method
remove_session_record_status_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "session_record_status". C++ signature : void
remove_session_record_status_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_signature_denominator_listener() Method
remove_signature_denominator_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "signature_denominator". C++ signature : void
remove_signature_denominator_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_signature_numerator_listener() Method
remove_signature_numerator_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "signature_numerator". C++ signature : void
remove_signature_numerator_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_song_length_listener() Method
remove_song_length_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "song_length". C++ signature : void remove_song_length_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_swing_amount_listener() Method
remove_swing_amount_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "swing_amount". C++ signature : void
remove_swing_amount_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_tempo_listener() Method
remove_tempo_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "tempo". C++ signature : void remove_tempo_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_tracks_listener() Method
remove_tracks_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "tracks". C++ signature : void remove_tracks_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.remove_visible_tracks_listener() Method
remove_visible_tracks_listener( (Song)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "visible_tracks". C++ signature : void
remove_visible_tracks_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.return_tracks_has_listener() Method
return_tracks_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "return_tracks". C++ signature : bool
return_tracks_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.scenes_has_listener() Method
scenes_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to
the property "scenes". C++ signature : bool scenes_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.scrub_by() Method
scrub_by( (Song)arg1, (float)arg2) -> None : Same as jump_by, but does not stop playback. C++ signature : void
scrub_by(TPyHandle<ASong>,double)

Live.Song.Song.session_automation_record_has_listener() Method
session_automation_record_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or
method is connected to the property "session_automation_record". C++ signature : bool
session_automation_record_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.session_record_has_listener() Method
session_record_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "session_record". C++ signature : bool
session_record_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.session_record_status_has_listener() Method
session_record_status_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method
is connected to the property "session_record_status". C++ signature : bool
session_record_status_has_listener(TPyHandle<ASong>,boost::python::api::object)

12/09/2014 14:09

40 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live.Song.Song.set_or_delete_cue() Method
set_or_delete_cue( (Song)arg1) -> None : When a cue is selected, it gets deleted. If no cue is selected, a new cue is created
at the current global songtime. C++ signature : void set_or_delete_cue(TPyHandle<ASong>)

Live.Song.Song.signature_denominator_has_listener() Method
signature_denominator_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method
is connected to the property "signature_denominator". C++ signature : bool
signature_denominator_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.signature_numerator_has_listener() Method
signature_numerator_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "signature_numerator". C++ signature : bool
signature_numerator_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.song_length_has_listener() Method
song_length_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "song_length". C++ signature : bool
song_length_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.start_playing() Method
start_playing( (Song)arg1) -> None : Start playing from the startmarker C++ signature : void
start_playing(TPyHandle<ASong>)

Live.Song.Song.stop_all_clips() Method
stop_all_clips( (Song)arg1 [, (bool)Quantized=True]) -> None : Stop all playing Clips (if any) but continue playing the Song.
C++ signature : void stop_all_clips(TPyHandle<ASong> [,bool=True])

Live.Song.Song.stop_playing() Method
stop_playing( (Song)arg1) -> None : Stop playing the Song. C++ signature : void stop_playing(TPyHandle<ASong>)

Live.Song.Song.swing_amount_has_listener() Method
swing_amount_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "swing_amount". C++ signature : bool
swing_amount_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.tap_tempo() Method
tap_tempo( (Song)arg1) -> None : Trigger the tap tempo function. C++ signature : void tap_tempo(TPyHandle<ASong>)

Live.Song.Song.tempo_has_listener() Method
tempo_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to
the property "tempo". C++ signature : bool tempo_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.tracks_has_listener() Method
tracks_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to
the property "tracks". C++ signature : bool tracks_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.trigger_session_record() Method
trigger_session_record( (Song)self [, (float)record_length=1.7976931348623157e+308]) -> None : Triggers a new session
recording. C++ signature : void trigger_session_record(TPyHandle<ASong> [,double=1.7976931348623157e+308])

Live.Song.Song.undo() Method
undo( (Song)arg1) -> None : Undo the last action that was made. C++ signature : void undo(TPyHandle<ASong>)

Live.Song.Song.visible_tracks_has_listener() Method
visible_tracks_has_listener( (Song)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "visible_tracks". C++ signature : bool
visible_tracks_has_listener(TPyHandle<ASong>,boost::python::api::object)

Live.Song.Song.View

Class

Representing the view aspects of a Live document: The Session and Arrangerview.

Live.Song.Song.View.canonical_parent Property
Get the canonical parent of the song view.

Live.Song.Song.View.detail_clip Property
Get/Set the Clip that is currently visible in Lives Detailview.

Live.Song.Song.View.draw_mode Property
Get/Set if the Envelope/Note draw mode is enabled.

12/09/2014 14:09

41 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live.Song.Song.View.follow_song Property
Get/Set if the Arrangerview should scroll to show the playmarker.

Live.Song.Song.View.highlighted_clip_slot Property
Get/Set the clip slot, defined via the highlighted track and scene in the Session.Will be None for Master- and Sendtracks.

Live.Song.Song.View.selected_parameter Property
Get the currently selected device parameter.

Live.Song.Song.View.selected_scene Property
Get/Set the current selected scene in Lives Sessionview.

Live.Song.Song.View.selected_track Property
Get/Set the current selected Track in Lives Session or Arrangerview.

Live.Song.Song.View.add_detail_clip_listener() Method
add_detail_clip_listener( (View)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon
as the property "detail_clip" has changed. C++ signature : void
add_detail_clip_listener(TPyViewData<ASong>,boost::python::api::object)

Live.Song.Song.View.add_draw_mode_listener() Method
add_draw_mode_listener( (View)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon
as the property "draw_mode" has changed. C++ signature : void
add_draw_mode_listener(TPyViewData<ASong>,boost::python::api::object)

Live.Song.Song.View.add_follow_song_listener() Method
add_follow_song_listener( (View)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon
as the property "follow_song" has changed. C++ signature : void
add_follow_song_listener(TPyViewData<ASong>,boost::python::api::object)

Live.Song.Song.View.add_selected_parameter_listener() Method
add_selected_parameter_listener( (View)arg1, (object)arg2) -> None : Add a listener function or method, which will be called
as soon as the property "selected_parameter" has changed. C++ signature : void
add_selected_parameter_listener(TPyViewData<ASong>,boost::python::api::object)

Live.Song.Song.View.add_selected_scene_listener() Method
add_selected_scene_listener( (View)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "selected_scene" has changed. C++ signature : void
add_selected_scene_listener(TPyViewData<ASong>,boost::python::api::object)

Live.Song.Song.View.add_selected_track_listener() Method
add_selected_track_listener( (View)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "selected_track" has changed. C++ signature : void
add_selected_track_listener(TPyViewData<ASong>,boost::python::api::object)

Live.Song.Song.View.detail_clip_has_listener() Method
detail_clip_has_listener( (View)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected
to the property "detail_clip". C++ signature : bool detail_clip_has_listener(TPyViewData<ASong>,boost::python::api::object)

Live.Song.Song.View.draw_mode_has_listener() Method
draw_mode_has_listener( (View)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "draw_mode". C++ signature : bool
draw_mode_has_listener(TPyViewData<ASong>,boost::python::api::object)

Live.Song.Song.View.follow_song_has_listener() Method
follow_song_has_listener( (View)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "follow_song". C++ signature : bool
follow_song_has_listener(TPyViewData<ASong>,boost::python::api::object)

Live.Song.Song.View.remove_detail_clip_listener() Method
remove_detail_clip_listener( (View)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "detail_clip". C++ signature : void remove_detail_clip_listener(TPyViewData<ASong>,boost::python::api::object)

Live.Song.Song.View.remove_draw_mode_listener() Method
remove_draw_mode_listener( (View)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "draw_mode". C++ signature : void
remove_draw_mode_listener(TPyViewData<ASong>,boost::python::api::object)

Live.Song.Song.View.remove_follow_song_listener() Method
remove_follow_song_listener( (View)arg1, (object)arg2) -> None : Remove a previously set listener function or method from

12/09/2014 14:09

42 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

property "follow_song". C++ signature : void


remove_follow_song_listener(TPyViewData<ASong>,boost::python::api::object)

Live.Song.Song.View.remove_selected_parameter_listener() Method
remove_selected_parameter_listener( (View)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "selected_parameter". C++ signature : void
remove_selected_parameter_listener(TPyViewData<ASong>,boost::python::api::object)

Live.Song.Song.View.remove_selected_scene_listener() Method
remove_selected_scene_listener( (View)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "selected_scene". C++ signature : void
remove_selected_scene_listener(TPyViewData<ASong>,boost::python::api::object)

Live.Song.Song.View.remove_selected_track_listener() Method
remove_selected_track_listener( (View)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "selected_track". C++ signature : void
remove_selected_track_listener(TPyViewData<ASong>,boost::python::api::object)

Live.Song.Song.View.select_device() Method
select_device( (View)arg1, (Device)arg2) -> None : Select the given device. C++ signature : void
select_device(TPyViewData<ASong>,TPyHandle<ADevice>)

Live.Song.Song.View.selected_parameter_has_listener() Method
selected_parameter_has_listener( (View)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "selected_parameter". C++ signature : bool
selected_parameter_has_listener(TPyViewData<ASong>,boost::python::api::object)

Live.Song.Song.View.selected_scene_has_listener() Method
selected_scene_has_listener( (View)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "selected_scene". C++ signature : bool
selected_scene_has_listener(TPyViewData<ASong>,boost::python::api::object)

Live.Song.Song.View.selected_track_has_listener() Method
selected_track_has_listener( (View)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "selected_track". C++ signature : bool
selected_track_has_listener(TPyViewData<ASong>,boost::python::api::object)

Live.Song.TimeFormat

Class

Live.Song.TimeFormat.ms_time Value
Live.Song.TimeFormat.smpte_24 Value
Live.Song.TimeFormat.smpte_25 Value
Live.Song.TimeFormat.smpte_29 Value
Live.Song.TimeFormat.smpte_30 Value
Live.Song.TimeFormat.smpte_30_drop Value

Live.String

Module

Live.Track

Module

Live.Track.DeviceContainer

Class

This class is a common super class of Track and Chain

Live.Track.DeviceInsertMode

Class

Live.Track.DeviceInsertMode.count Value
Live.Track.DeviceInsertMode.default Value
Live.Track.DeviceInsertMode.selected_left Value

12/09/2014 14:09

43 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live.Track.DeviceInsertMode.selected_right Value

Live.Track.Track

Class

This class represents a track in Live. It can be either 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.

Live.Track.Track.arm Property
Arm the track for recording. Not available for Master- and Send Tracks.

Live.Track.Track.can_be_armed Property
return True, if this Track has a valid arm property. Not all trackscan be armed (for example return Tracks or the Master Tracks).

Live.Track.Track.canonical_parent Property
Get the canonical parent of the track.

Live.Track.Track.clip_slots Property
const access to the list of clipslots (see class AClipSlot) for this track.The list will be empty for the master and sendtracks.

Live.Track.Track.color Property
Get/set access to the color of the Track (RGB).

Live.Track.Track.current_input_routing Property
Get/Set the name of the current active input routing.When setting a new routing, the new routing must be one of the available
ones.

Live.Track.Track.current_input_sub_routing Property
Get/Set the current active input sub routing.When setting a new routing, the new routing must be one of the available ones.

Live.Track.Track.current_monitoring_state Property
Get/Set the track's current monitoring state.

Live.Track.Track.current_output_routing Property
Get/Set the current active output routing.When setting a new routing, the new routing must be one of the available ones.

Live.Track.Track.current_output_sub_routing Property
Get/Set the current active output sub routing.When setting a new routing, the new routing must be one of the available ones.

Live.Track.Track.devices Property
Return const access to all available Devices that are present in the TracksDevicechain. This tuple will also include the
'mixer_device' that every Trackalways has.

Live.Track.Track.fired_slot_index Property
const access to the index of the fired (and thus blinking) clipslot in this track.This index is -1 if no slot is fired and -2 if the track's
stop button has been fired.

Live.Track.Track.fold_state Property
Get/Set whether the track is folded or not. Only available if is_foldable is True.

Live.Track.Track.has_audio_input Property
return True, if this Track can be feed with an Audio signal. This istrue for all Audio Tracks.

Live.Track.Track.has_audio_output Property
return True, if this Track sends out an Audio signal. This istrue for all Audio Tracks, and MIDI tracks with an Instrument.

Live.Track.Track.has_midi_input Property
return True, if this Track can be feed with an Audio signal. This istrue for all MIDI Tracks.

Live.Track.Track.has_midi_output Property
return True, if this Track sends out MIDI events. This istrue for all MIDI Tracks with no Instruments.

Live.Track.Track.implicit_arm Property
Arm the track for recording. When The track is implicitly armed, it showsin a weaker color in the live GUI and is not saved in the
set.

Live.Track.Track.input_meter_left Property
Momentary value of left input channel meter, 0.0 to 1.0. For Audio Tracks only.

Live.Track.Track.input_meter_level Property
Return the MIDI or Audio meter value of the Tracks input, depending on thetype of the Track input. Meter values (MIDI or Audio)

12/09/2014 14:09

44 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

are always scaledfrom 0.0 to 1.0.

Live.Track.Track.input_meter_right Property
Momentary value of right input channel meter, 0.0 to 1.0. For Audio Tracks only.

Live.Track.Track.input_routings Property
Const access to the list of available input routings.

Live.Track.Track.input_sub_routings Property
Return a list of all available input sub routings.

Live.Track.Track.is_foldable Property
return True if the track can be (un)folded to hide/reveal contained tracks.

Live.Track.Track.is_part_of_selection Property
return False if the track is not selected.

Live.Track.Track.is_visible Property
return False if the track is hidden within a folded group track.

Live.Track.Track.mixer_device Property
Return access to the special Device that every Track has: This Device containsthe Volume, Pan, Sendamounts, and Crossfade
assignment parameters.

Live.Track.Track.mute Property
Mute/unmute the track.

Live.Track.Track.name Property
Read/write access to the name of the Track, as visible in the track header.

Live.Track.Track.output_meter_left Property
Momentary value of left output channel meter, 0.0 to 1.0.For tracks with audio output only.

Live.Track.Track.output_meter_level Property
Return the MIDI or Audio meter value of the Track output (behind themixer_device), depending on the type of the Track input,
this can be a MIDIor Audio meter. Meter values (MIDI or Audio) are always scaled from 0.0 to 1.0.

Live.Track.Track.output_meter_right Property
Momentary value of right output channel meter, 0.0 to 1.0.For tracks with audio output only.

Live.Track.Track.output_routings Property
Const access to the list of all available output routings.

Live.Track.Track.output_sub_routings Property
Return a list of all available output sub routings.

Live.Track.Track.playing_slot_index Property
const access to the index of the currently playing clip in the track.Will be -1 when no clip is playing.

Live.Track.Track.solo Property
Get/Set the solo status of the track. Note that this will not disable thesolo state of any other track. If you want exclusive solo,
you have to disable the solo state of the other Tracks manually.

Live.Track.Track.view Property
Representing the view aspects of a Track.

Live.Track.Track.add_arm_listener() Method
add_arm_listener( (Track)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the
property "arm" has changed. C++ signature : void add_arm_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.add_clip_slots_listener() Method
add_clip_slots_listener( (Track)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon
as the property "clip_slots" has changed. C++ signature : void
add_clip_slots_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.add_color_listener() Method
add_color_listener( (Track)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as
the property "color" has changed. C++ signature : void add_color_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.add_current_input_routing_listener() Method
add_current_input_routing_listener( (Track)arg1, (object)arg2) -> None : Add a listener function or method, which will be

12/09/2014 14:09

45 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

called as soon as the property "current_input_routing" has changed. C++ signature : void
add_current_input_routing_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.add_current_input_sub_routing_listener() Method
add_current_input_sub_routing_listener( (Track)arg1, (object)arg2) -> None : Add a listener function or method, which will be
called as soon as the property "current_input_sub_routing" has changed. C++ signature : void
add_current_input_sub_routing_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.add_current_monitoring_state_listener() Method
add_current_monitoring_state_listener( (Track)arg1, (object)arg2) -> None : Add a listener function or method, which will be
called as soon as the property "current_monitoring_state" has changed. C++ signature : void
add_current_monitoring_state_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.add_current_output_routing_listener() Method
add_current_output_routing_listener( (Track)arg1, (object)arg2) -> None : Add a listener function or method, which will be
called as soon as the property "current_output_routing" has changed. C++ signature : void
add_current_output_routing_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.add_current_output_sub_routing_listener() Method
add_current_output_sub_routing_listener( (Track)arg1, (object)arg2) -> None : Add a listener function or method, which will
be called as soon as the property "current_output_sub_routing" has changed. C++ signature : void
add_current_output_sub_routing_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.add_devices_listener() Method
add_devices_listener( (Track)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as
the property "devices" has changed. C++ signature : void add_devices_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.add_fired_slot_index_listener() Method
add_fired_slot_index_listener( (Track)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "fired_slot_index" has changed. C++ signature : void
add_fired_slot_index_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.add_has_audio_input_listener() Method
add_has_audio_input_listener( (Track)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "has_audio_input" has changed. C++ signature : void
add_has_audio_input_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.add_has_audio_output_listener() Method
add_has_audio_output_listener( (Track)arg1, (object)arg2) -> None : Add a listener function or method, which will be called
as soon as the property "has_audio_output" has changed. C++ signature : void
add_has_audio_output_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.add_has_midi_input_listener() Method
add_has_midi_input_listener( (Track)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "has_midi_input" has changed. C++ signature : void
add_has_midi_input_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.add_has_midi_output_listener() Method
add_has_midi_output_listener( (Track)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "has_midi_output" has changed. C++ signature : void
add_has_midi_output_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.add_implicit_arm_listener() Method
add_implicit_arm_listener( (Track)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "implicit_arm" has changed. C++ signature : void
add_implicit_arm_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.add_input_meter_left_listener() Method
add_input_meter_left_listener( (Track)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "input_meter_left" has changed. C++ signature : void
add_input_meter_left_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.add_input_meter_level_listener() Method
add_input_meter_level_listener( (Track)arg1, (object)arg2) -> None : Add a listener function or method, which will be called
as soon as the property "input_meter_level" has changed. C++ signature : void
add_input_meter_level_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.add_input_meter_right_listener() Method
add_input_meter_right_listener( (Track)arg1, (object)arg2) -> None : Add a listener function or method, which will be called
as soon as the property "input_meter_right" has changed. C++ signature : void
add_input_meter_right_listener(TTrackPyHandle,boost::python::api::object)

12/09/2014 14:09

46 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live.Track.Track.add_mute_listener() Method
add_mute_listener( (Track)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as
the property "mute" has changed. C++ signature : void add_mute_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.add_name_listener() Method
add_name_listener( (Track)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as
the property "name" has changed. C++ signature : void add_name_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.add_output_meter_left_listener() Method
add_output_meter_left_listener( (Track)arg1, (object)arg2) -> None : Add a listener function or method, which will be called
as soon as the property "output_meter_left" has changed. C++ signature : void
add_output_meter_left_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.add_output_meter_level_listener() Method
add_output_meter_level_listener( (Track)arg1, (object)arg2) -> None : Add a listener function or method, which will be called
as soon as the property "output_meter_level" has changed. C++ signature : void
add_output_meter_level_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.add_output_meter_right_listener() Method
add_output_meter_right_listener( (Track)arg1, (object)arg2) -> None : Add a listener function or method, which will be called
as soon as the property "output_meter_right" has changed. C++ signature : void
add_output_meter_right_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.add_playing_slot_index_listener() Method
add_playing_slot_index_listener( (Track)arg1, (object)arg2) -> None : Add a listener function or method, which will be called
as soon as the property "playing_slot_index" has changed. C++ signature : void
add_playing_slot_index_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.add_solo_listener() Method
add_solo_listener( (Track)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the
property "solo" has changed. C++ signature : void add_solo_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.arm_has_listener() Method
arm_has_listener( (Track)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to
the property "arm". C++ signature : bool arm_has_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.clip_slots_has_listener() Method
clip_slots_has_listener( (Track)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected
to the property "clip_slots". C++ signature : bool clip_slots_has_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.color_has_listener() Method
color_has_listener( (Track)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to
the property "color". C++ signature : bool color_has_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.current_input_routing_has_listener() Method
current_input_routing_has_listener( (Track)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method
is connected to the property "current_input_routing". C++ signature : bool
current_input_routing_has_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.current_input_sub_routing_has_listener() Method
current_input_sub_routing_has_listener( (Track)arg1, (object)arg2) -> bool : Returns true, if the given listener function or
method is connected to the property "current_input_sub_routing". C++ signature : bool
current_input_sub_routing_has_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.current_monitoring_state_has_listener() Method
current_monitoring_state_has_listener( (Track)arg1, (object)arg2) -> bool : Returns true, if the given listener function or
method is connected to the property "current_monitoring_state". C++ signature : bool
current_monitoring_state_has_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.current_output_routing_has_listener() Method
current_output_routing_has_listener( (Track)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method
is connected to the property "current_output_routing". C++ signature : bool
current_output_routing_has_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.current_output_sub_routing_has_listener() Method
current_output_sub_routing_has_listener( (Track)arg1, (object)arg2) -> bool : Returns true, if the given listener function or
method is connected to the property "current_output_sub_routing". C++ signature : bool
current_output_sub_routing_has_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.delete_device() Method

12/09/2014 14:09

47 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

delete_device( (Track)arg1, (int)arg2) -> None : Delete a device identified by the index in the 'devices' list. C++ signature :
void delete_device(TTrackPyHandle,int)

Live.Track.Track.devices_has_listener() Method
devices_has_listener( (Track)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected
to the property "devices". C++ signature : bool devices_has_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.duplicate_clip_slot() Method
duplicate_clip_slot( (Track)arg1, (int)arg2) -> int : Duplicate a clip and put it into the next free slot and return the index of the
destination slot. A new scene is created if no free slot is available. If creating the new scene would exceed the limitations, a
runtime error is raised. C++ signature : int duplicate_clip_slot(TTrackPyHandle,int)

Live.Track.Track.fired_slot_index_has_listener() Method
fired_slot_index_has_listener( (Track)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "fired_slot_index". C++ signature : bool
fired_slot_index_has_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.has_audio_input_has_listener() Method
has_audio_input_has_listener( (Track)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "has_audio_input". C++ signature : bool
has_audio_input_has_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.has_audio_output_has_listener() Method
has_audio_output_has_listener( (Track)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "has_audio_output". C++ signature : bool
has_audio_output_has_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.has_midi_input_has_listener() Method
has_midi_input_has_listener( (Track)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "has_midi_input". C++ signature : bool
has_midi_input_has_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.has_midi_output_has_listener() Method
has_midi_output_has_listener( (Track)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "has_midi_output". C++ signature : bool
has_midi_output_has_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.implicit_arm_has_listener() Method
implicit_arm_has_listener( (Track)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "implicit_arm". C++ signature : bool
implicit_arm_has_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.input_meter_left_has_listener() Method
input_meter_left_has_listener( (Track)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "input_meter_left". C++ signature : bool
input_meter_left_has_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.input_meter_level_has_listener() Method
input_meter_level_has_listener( (Track)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "input_meter_level". C++ signature : bool
input_meter_level_has_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.input_meter_right_has_listener() Method
input_meter_right_has_listener( (Track)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "input_meter_right". C++ signature : bool
input_meter_right_has_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.jump_in_running_session_clip() Method
jump_in_running_session_clip( (Track)arg1, (float)arg2) -> None : Jump forward or backward in the currently running
Sessionclip (if any) by the specified relative amount in beats. Does nothing if no Session Clip is currently running. C++
signature : void jump_in_running_session_clip(TTrackPyHandle,double)

Live.Track.Track.mute_has_listener() Method
mute_has_listener( (Track)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to
the property "mute". C++ signature : bool mute_has_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.name_has_listener() Method
name_has_listener( (Track)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to
the property "name". C++ signature : bool name_has_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.output_meter_left_has_listener() Method
output_meter_left_has_listener( (Track)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is

12/09/2014 14:09

48 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

connected to the property "output_meter_left". C++ signature : bool


output_meter_left_has_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.output_meter_level_has_listener() Method
output_meter_level_has_listener( (Track)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "output_meter_level". C++ signature : bool
output_meter_level_has_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.output_meter_right_has_listener() Method
output_meter_right_has_listener( (Track)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "output_meter_right". C++ signature : bool
output_meter_right_has_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.playing_slot_index_has_listener() Method
playing_slot_index_has_listener( (Track)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "playing_slot_index". C++ signature : bool
playing_slot_index_has_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.remove_arm_listener() Method
remove_arm_listener( (Track)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property
"arm". C++ signature : void remove_arm_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.remove_clip_slots_listener() Method
remove_clip_slots_listener( (Track)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "clip_slots". C++ signature : void remove_clip_slots_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.remove_color_listener() Method
remove_color_listener( (Track)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "color". C++ signature : void remove_color_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.remove_current_input_routing_listener() Method
remove_current_input_routing_listener( (Track)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "current_input_routing". C++ signature : void
remove_current_input_routing_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.remove_current_input_sub_routing_listener() Method
remove_current_input_sub_routing_listener( (Track)arg1, (object)arg2) -> None : Remove a previously set listener function
or method from property "current_input_sub_routing". C++ signature : void
remove_current_input_sub_routing_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.remove_current_monitoring_state_listener() Method
remove_current_monitoring_state_listener( (Track)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "current_monitoring_state". C++ signature : void
remove_current_monitoring_state_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.remove_current_output_routing_listener() Method
remove_current_output_routing_listener( (Track)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "current_output_routing". C++ signature : void
remove_current_output_routing_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.remove_current_output_sub_routing_listener() Method
remove_current_output_sub_routing_listener( (Track)arg1, (object)arg2) -> None : Remove a previously set listener function
or method from property "current_output_sub_routing". C++ signature : void
remove_current_output_sub_routing_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.remove_devices_listener() Method
remove_devices_listener( (Track)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "devices". C++ signature : void remove_devices_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.remove_fired_slot_index_listener() Method
remove_fired_slot_index_listener( (Track)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "fired_slot_index". C++ signature : void
remove_fired_slot_index_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.remove_has_audio_input_listener() Method
remove_has_audio_input_listener( (Track)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "has_audio_input". C++ signature : void
remove_has_audio_input_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.remove_has_audio_output_listener() Method
remove_has_audio_output_listener( (Track)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "has_audio_output". C++ signature : void

12/09/2014 14:09

49 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

remove_has_audio_output_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.remove_has_midi_input_listener() Method
remove_has_midi_input_listener( (Track)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "has_midi_input". C++ signature : void
remove_has_midi_input_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.remove_has_midi_output_listener() Method
remove_has_midi_output_listener( (Track)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "has_midi_output". C++ signature : void
remove_has_midi_output_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.remove_implicit_arm_listener() Method
remove_implicit_arm_listener( (Track)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "implicit_arm". C++ signature : void remove_implicit_arm_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.remove_input_meter_left_listener() Method
remove_input_meter_left_listener( (Track)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "input_meter_left". C++ signature : void
remove_input_meter_left_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.remove_input_meter_level_listener() Method
remove_input_meter_level_listener( (Track)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "input_meter_level". C++ signature : void
remove_input_meter_level_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.remove_input_meter_right_listener() Method
remove_input_meter_right_listener( (Track)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "input_meter_right". C++ signature : void
remove_input_meter_right_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.remove_mute_listener() Method
remove_mute_listener( (Track)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "mute". C++ signature : void remove_mute_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.remove_name_listener() Method
remove_name_listener( (Track)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "name". C++ signature : void remove_name_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.remove_output_meter_left_listener() Method
remove_output_meter_left_listener( (Track)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "output_meter_left". C++ signature : void
remove_output_meter_left_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.remove_output_meter_level_listener() Method
remove_output_meter_level_listener( (Track)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "output_meter_level". C++ signature : void
remove_output_meter_level_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.remove_output_meter_right_listener() Method
remove_output_meter_right_listener( (Track)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "output_meter_right". C++ signature : void
remove_output_meter_right_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.remove_playing_slot_index_listener() Method
remove_playing_slot_index_listener( (Track)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "playing_slot_index". C++ signature : void
remove_playing_slot_index_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.remove_solo_listener() Method
remove_solo_listener( (Track)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "solo". C++ signature : void remove_solo_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.solo_has_listener() Method
solo_has_listener( (Track)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to
the property "solo". C++ signature : bool solo_has_listener(TTrackPyHandle,boost::python::api::object)

Live.Track.Track.stop_all_clips() Method
stop_all_clips( (Track)arg1 [, (bool)Quantized=True]) -> None : Stop running and triggered clip and slots on this track. C++
signature : void stop_all_clips(TTrackPyHandle [,bool=True])

12/09/2014 14:09

50 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live.Track.Track.monitoring_states

Sub-Class

Live.Track.Track.monitoring_states.AUTO Value
Live.Track.Track.monitoring_states.IN Value
Live.Track.Track.monitoring_states.OFF Value

Live.Track.Track.View

Class

Representing the view aspects of a Track.

Live.Track.Track.View.canonical_parent Property
Get the canonical parent of the track view.

Live.Track.Track.View.device_insert_mode Property
Get/Listen the device insertion mode of the track. By default, it will insert devices at the end, but it can be changed to make it
relative to current selection.

Live.Track.Track.View.is_collapsed Property
Get/Set/Listen if the track is shown collapsed in the arranger view.

Live.Track.Track.View.selected_device Property
Get/Set/Listen the insertion mode of the device. While in insertion mode, loading new devices from the browser will place
devices at the selected position.

Live.Track.Track.View.add_device_insert_mode_listener() Method
add_device_insert_mode_listener( (View)arg1, (object)arg2) -> None : Add a listener function or method, which will be called
as soon as the property "device_insert_mode" has changed. C++ signature : void
add_device_insert_mode_listener(TPyViewData<ATrack>,boost::python::api::object)

Live.Track.Track.View.add_is_collapsed_listener() Method
add_is_collapsed_listener( (View)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "is_collapsed" has changed. C++ signature : void
add_is_collapsed_listener(TPyViewData<ATrack>,boost::python::api::object)

Live.Track.Track.View.add_selected_device_listener() Method
add_selected_device_listener( (View)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as
soon as the property "selected_device" has changed. C++ signature : void
add_selected_device_listener(TPyViewData<ATrack>,boost::python::api::object)

Live.Track.Track.View.device_insert_mode_has_listener() Method
device_insert_mode_has_listener( (View)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "device_insert_mode". C++ signature : bool
device_insert_mode_has_listener(TPyViewData<ATrack>,boost::python::api::object)

Live.Track.Track.View.is_collapsed_has_listener() Method
is_collapsed_has_listener( (View)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "is_collapsed". C++ signature : bool
is_collapsed_has_listener(TPyViewData<ATrack>,boost::python::api::object)

Live.Track.Track.View.remove_device_insert_mode_listener() Method
remove_device_insert_mode_listener( (View)arg1, (object)arg2) -> None : Remove a previously set listener function or
method from property "device_insert_mode". C++ signature : void
remove_device_insert_mode_listener(TPyViewData<ATrack>,boost::python::api::object)

Live.Track.Track.View.remove_is_collapsed_listener() Method
remove_is_collapsed_listener( (View)arg1, (object)arg2) -> None : Remove a previously set listener function or method from
property "is_collapsed". C++ signature : void
remove_is_collapsed_listener(TPyViewData<ATrack>,boost::python::api::object)

Live.Track.Track.View.remove_selected_device_listener() Method
remove_selected_device_listener( (View)arg1, (object)arg2) -> None : Remove a previously set listener function or method
from property "selected_device". C++ signature : void
remove_selected_device_listener(TPyViewData<ATrack>,boost::python::api::object)

Live.Track.Track.View.select_instrument() Method
select_instrument( (View)arg1) -> bool : Selects the track's instrument if it has one. C++ signature : bool
select_instrument(TPyViewData<ATrack>)

12/09/2014 14:09

51 di 51

http://julienbayle.net/PythonLiveAPI_documentation/Live9.1.xml

Live.Track.Track.View.selected_device_has_listener() Method
selected_device_has_listener( (View)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is
connected to the property "selected_device". C++ signature : bool
selected_device_has_listener(TPyViewData<ATrack>,boost::python::api::object)

12/09/2014 14:09

You might also like