Live.Browser (runtime)¶
Live 10, Live Object Model & framework reference (descriptions and signatures).
Live Object Model, from the Live 10 API XML documentation.
Classes¶
class Browser¶
This class represents the live browser data base.
Properties¶
_live_ptraudio_effects- Returns a browser item with access to all the Audio Effects content.clips- Returns a browser item with access to all the Clips content.colors- Returns a list of browser items containing the configured colors.current_project- Returns a browser item with access to all the Current Project content.drums- Returns a browser item with access to all the Drums content.filter_type- Bang triggered when the hotswap target has changed.hotswap_target- Bang triggered when the hotswap target has changed.instruments- Returns a browser item with access to all the Instruments content.legacy_libraries- Returns a list of browser items containing the installed legacy libraries. The list is always empty as legacy library handling has been removed.max_for_live- Returns a browser item with access to all the Max For Live content.midi_effects- Returns a browser item with access to all the Midi Effects content.packs- Returns a browser item with access to all the Packs content.plugins- Returns a browser item with access to all the Plugins content.samples- Returns a browser item with access to all the Samples content.sounds- Returns a browser item with access to all the Sounds content.user_folders- Returns a list of browser items containing all the user folders.user_library- Returns a browser item with access to all the User Library content.
Methods¶
add_filter_type_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "filter_type" has changed.
add_full_refresh_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "full_refresh" has changed.
add_hotswap_target_listener(arg1,arg2)¶
Add a listener function or method, which will be called as soon as the property "hotswap_target" has changed.
filter_type_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "filter_type".
full_refresh_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "full_refresh".
hotswap_target_has_listener(arg1,arg2)¶
Returns true, if the given listener function or method is connected to the property "hotswap_target".
load_item(arg1,arg2)¶
Loads the provided browser item.
preview_item(arg1,arg2)¶
Previews the provided browser item.
relation_to_hotswap_target(arg1,arg2)¶
Returns the relation between the given browser item and the current hotswap target
remove_filter_type_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "filter_type".
remove_full_refresh_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "full_refresh".
remove_hotswap_target_listener(arg1,arg2)¶
Remove a previously set listener function or method from property "hotswap_target".
stop_preview(arg1)¶
Stop the current preview.
class BrowserItem¶
This class represents an item of the browser hierarchy.
Properties¶
children- Const access to the descendants of this browser item.is_device- Indicates if the browser item represents a device.is_folder- Indicates if the browser item represents folder.is_loadable- True if item can be loaded via the Browser's 'load_item' method.is_selected- True if the item is ancestor of or the actual selection.iter_children- Const iterable access to the descendants of this browser item.name- Const access to the canonical display name of this browser item.source- Specifies where does item come from -- i.e. Live pack, user library...uri- The uri describes a unique identifier for a browser item.
class BrowserItemIterator¶
This class iterates over children of another BrowserItem.
Methods¶
next(arg1)¶
Retrieve next item
class BrowserItemVector¶
A container for returning browser items from Live.