`Live.Browser` (runtime)¶

Live 11 — Live Object Model & framework reference (descriptions and signatures).

Classes¶

class `Browser(LomObject)`¶

This class represents the live browser data base.

Properties¶

_live_ptr
audio_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¶

`init(...)`¶

Raises an exception This class cannot be instantiated from Python

`add_filter_type_listener(...)`¶

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)

`add_full_refresh_listener(...)`¶

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)

`add_hotswap_target_listener(...)`¶

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)

`filter_type_has_listener(...)`¶

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)

`full_refresh_has_listener(...)`¶

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)

`hotswap_target_has_listener(...)`¶

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 hotswap_target_has_listener(TPyHandle<ABrowserDelegate>,boost::python::api::object)

`load_item(...)`¶

load_item( (Browser)arg1, (BrowserItem)arg2) -> None : Loads the provided browser item.

C++ signature :
    void load_item(TPyHandle<ABrowserDelegate>,NPythonBrowser::TPythonBrowserItem)

`preview_item(...)`¶

preview_item( (Browser)arg1, (BrowserItem)arg2) -> None : Previews the provided browser item.

C++ signature :
    void preview_item(TPyHandle<ABrowserDelegate>,NPythonBrowser::TPythonBrowserItem)

`relation_to_hotswap_target(...)`¶

relation_to_hotswap_target( (Browser)arg1, (BrowserItem)arg2) -> Relation : Returns the relation between the given browser item and the current hotswap target

C++ signature :
    NBrowserUri::TRelation relation_to_hotswap_target(TPyHandle<ABrowserDelegate>,NPythonBrowser::TPythonBrowserItem)

`remove_filter_type_listener(...)`¶

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)

`remove_full_refresh_listener(...)`¶

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)

`remove_hotswap_target_listener(...)`¶

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)

`stop_preview(...)`¶

stop_preview( (Browser)arg1) -> None : Stop the current preview.

C++ signature :
    void stop_preview(TPyHandle<ABrowserDelegate>)

class `BrowserItem(instance)`¶

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.

Methods¶

`init(...)`¶

Raises an exception This class cannot be instantiated from Python

class `BrowserItemIterator(instance)`¶

This class iterates over children of another BrowserItem.

Methods¶

`init(...)`¶

Raises an exception This class cannot be instantiated from Python

class `BrowserItemVector(instance)`¶

A container for returning browser items from Live.

Methods¶

`init(...)`¶

Raises an exception This class cannot be instantiated from Python

`append(...)`¶

append( (BrowserItemVector)arg1, (object)arg2) -> None :

C++ signature :
    void append(std::__1::vector<NPythonBrowser::TPythonBrowserItem, std::__1::allocator<NPythonBrowser::TPythonBrowserItem>> {lvalue},boost::python::api::object)

`extend(...)`¶

extend( (BrowserItemVector)arg1, (object)arg2) -> None :

C++ signature :
    void extend(std::__1::vector<NPythonBrowser::TPythonBrowserItem, std::__1::allocator<NPythonBrowser::TPythonBrowserItem>> {lvalue},boost::python::api::object)

class `FilterType(enum)`¶

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

Methods¶

`init(self, /, *args, **kwargs)`¶

Initialize self. See help(type(self)) for accurate signature.

`bit_length(self, /)`¶

Number of bits necessary to represent self in binary.

bin(37) '0b100101' (37).bit_length() 6

`conjugate(...)`¶

Returns self, the complex conjugate of any int.

`from_bytes(bytes, byteorder, *, signed=False)`¶

Return the integer represented by the given array of bytes.

bytes Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol. byteorder The byte order used to represent the integer. If byteorder is 'big', the most significant byte is at the beginning of the byte array. If byteorder is 'little', the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder' as the byte order value. signed Indicates whether two's complement is used to represent the integer.

`to_bytes(self, /, length, byteorder, *, signed=False)`¶

Return an array of bytes representing an integer.

length Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes. byteorder The byte order used to represent the integer. If byteorder is 'big', the most significant byte is at the beginning of the byte array. If byteorder is 'little', the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder' as the byte order value. signed Determines whether two's complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

Attributes¶

audio_effect_hotswap = Browser.FilterType.audio_effect_hotswap
count = Browser.FilterType.count
denominator = <attribute 'denominator' of 'int' objects> - the denominator of a rational number in lowest terms
disabled = Browser.FilterType.disabled
drum_pad_hotswap = Browser.FilterType.drum_pad_hotswap
hotswap_off = Browser.FilterType.hotswap_off
imag = <attribute 'imag' of 'int' objects> - the imaginary part of a complex number
instrument_hotswap = Browser.FilterType.instrument_hotswap
midi_effect_hotswap = Browser.FilterType.midi_effect_hotswap
midi_track_devices = Browser.FilterType.midi_track_devices
name = <member 'name' of 'Boost.Python.enum' objects>
names = {'disabled': Browser.FilterType.disabled, 'hotswap_off': Browser.FilterType.hotswap_off, 'instrument_hotswap': Browser.FilterType.instrument_hotswap, 'audio_eff... - dict() -> new empty dictionary
numerator = <attribute 'numerator' of 'int' objects> - the numerator of a rational number in lowest terms
real = <attribute 'real' of 'int' objects> - the real part of a complex number
samples = Browser.FilterType.samples
values = {-1: Browser.FilterType.disabled, 0: Browser.FilterType.hotswap_off, 1: Browser.FilterType.instrument_hotswap, 2: Browser.FilterType.audio_effect_hotswap, 3: Br... - dict() -> new empty dictionary

class `Relation(enum)`¶

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

Methods¶

`init(self, /, *args, **kwargs)`¶

Initialize self. See help(type(self)) for accurate signature.

`bit_length(self, /)`¶

Number of bits necessary to represent self in binary.

bin(37) '0b100101' (37).bit_length() 6

`conjugate(...)`¶

Returns self, the complex conjugate of any int.

`from_bytes(bytes, byteorder, *, signed=False)`¶

Return the integer represented by the given array of bytes.

bytes Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol. byteorder The byte order used to represent the integer. If byteorder is 'big', the most significant byte is at the beginning of the byte array. If byteorder is 'little', the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder' as the byte order value. signed Indicates whether two's complement is used to represent the integer.

`to_bytes(self, /, length, byteorder, *, signed=False)`¶

Return an array of bytes representing an integer.

length Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes. byteorder The byte order used to represent the integer. If byteorder is 'big', the most significant byte is at the beginning of the byte array. If byteorder is 'little', the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder' as the byte order value. signed Determines whether two's complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

Attributes¶

ancestor = Browser.Relation.ancestor
denominator = <attribute 'denominator' of 'int' objects> - the denominator of a rational number in lowest terms
descendant = Browser.Relation.descendant
equal = Browser.Relation.equal
imag = <attribute 'imag' of 'int' objects> - the imaginary part of a complex number
name = <member 'name' of 'Boost.Python.enum' objects>
names = {'ancestor': Browser.Relation.ancestor, 'equal': Browser.Relation.equal, 'descendant': Browser.Relation.descendant, 'none': Browser.Relation.none} - dict() -> new empty dictionary
none = Browser.Relation.none
numerator = <attribute 'numerator' of 'int' objects> - the numerator of a rational number in lowest terms
real = <attribute 'real' of 'int' objects> - the real part of a complex number
values = {0: Browser.Relation.ancestor, 1: Browser.Relation.equal, 2: Browser.Relation.descendant, 3: Browser.Relation.none} - dict() -> new empty dictionary

Live.Browser (runtime)¶

Classes¶

class Browser(LomObject)¶

Properties¶

Methods¶

__init__(...)¶

add_filter_type_listener(...)¶

add_full_refresh_listener(...)¶

add_hotswap_target_listener(...)¶

filter_type_has_listener(...)¶

full_refresh_has_listener(...)¶

hotswap_target_has_listener(...)¶

load_item(...)¶

preview_item(...)¶

relation_to_hotswap_target(...)¶

remove_filter_type_listener(...)¶

remove_full_refresh_listener(...)¶

remove_hotswap_target_listener(...)¶

stop_preview(...)¶

class BrowserItem(instance)¶

Properties¶

Methods¶

__init__(...)¶

class BrowserItemIterator(instance)¶

Methods¶

__init__(...)¶

class BrowserItemVector(instance)¶

Methods¶

__init__(...)¶

append(...)¶

extend(...)¶

class FilterType(enum)¶

Methods¶

__init__(self, /, *args, **kwargs)¶

bit_length(self, /)¶

conjugate(...)¶

from_bytes(bytes, byteorder, *, signed=False)¶

to_bytes(self, /, length, byteorder, *, signed=False)¶

Attributes¶

class Relation(enum)¶

Methods¶

__init__(self, /, *args, **kwargs)¶

bit_length(self, /)¶

conjugate(...)¶

from_bytes(bytes, byteorder, *, signed=False)¶

to_bytes(self, /, length, byteorder, *, signed=False)¶

Attributes¶

`Live.Browser` (runtime)¶

class `Browser(LomObject)`¶

`init(...)`¶

`add_filter_type_listener(...)`¶

`add_full_refresh_listener(...)`¶

`add_hotswap_target_listener(...)`¶

`filter_type_has_listener(...)`¶

`full_refresh_has_listener(...)`¶

`hotswap_target_has_listener(...)`¶

`load_item(...)`¶

`preview_item(...)`¶

`relation_to_hotswap_target(...)`¶

`remove_filter_type_listener(...)`¶

`remove_full_refresh_listener(...)`¶

`remove_hotswap_target_listener(...)`¶

`stop_preview(...)`¶

class `BrowserItem(instance)`¶

`init(...)`¶

class `BrowserItemIterator(instance)`¶

`init(...)`¶

class `BrowserItemVector(instance)`¶

`init(...)`¶

`append(...)`¶

`extend(...)`¶

class `FilterType(enum)`¶

`init(self, /, *args, **kwargs)`¶

`bit_length(self, /)`¶

`conjugate(...)`¶

`from_bytes(bytes, byteorder, *, signed=False)`¶

`to_bytes(self, /, length, byteorder, *, signed=False)`¶

class `Relation(enum)`¶

`init(self, /, *args, **kwargs)`¶

`bit_length(self, /)`¶

`conjugate(...)`¶

`from_bytes(bytes, byteorder, *, signed=False)`¶

`to_bytes(self, /, length, byteorder, *, signed=False)`¶