`Live.ClipSlot` (runtime)¶

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

Classes¶

class `ClipSlot(LomObject)`¶

This class represents an entry in Lives Session view matrix.

Properties¶

_live_ptr
canonical_parent - Get the canonical parent of the ClipSlot.
clip - Returns the Clip which this clipslots currently owns. Might be None.
color - Returns the canonical color for the clip slot or None if it does not exist.
color_index - Returns the canonical color index for the clip slot or None if it does not exist.
controls_other_clips - Returns true if firing this slot will fire clips in other slots.
has_clip - Returns true if this Clipslot owns a Clip.
has_stop_button - Get/Set if this Clip has a stop button, which will, if fired, stop any
is_group_slot - Returns whether this clip slot is a group track slot (group slot).
is_playing - Returns whether the clip associated with the slot is playing.
is_recording - Returns whether the clip associated with the slot is recording.
is_triggered - Const access to the triggering state of the clip slot.
playing_status - Const access to the playing state of the clip slot.
will_record_on_start - returns true if the clip slot will record on being fired.

Methods¶

`init(...)`¶

Raises an exception This class cannot be instantiated from Python

`add_color_index_listener(...)`¶

add_color_index_listener( (ClipSlot)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "color_index" has changed.

C++ signature :
    void add_color_index_listener(TPyHandle<AGroupAndClipSlotBase>,boost::python::api::object)

`add_color_listener(...)`¶

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)

`add_controls_other_clips_listener(...)`¶

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)

`add_has_clip_listener(...)`¶

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)

`add_has_stop_button_listener(...)`¶

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)

`add_is_triggered_listener(...)`¶

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)

`add_playing_status_listener(...)`¶

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)

`color_has_listener(...)`¶

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)

`color_index_has_listener(...)`¶

color_index_has_listener( (ClipSlot)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "color_index".

C++ signature :
    bool color_index_has_listener(TPyHandle<AGroupAndClipSlotBase>,boost::python::api::object)

`controls_other_clips_has_listener(...)`¶

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)

`create_audio_clip(...)`¶

create_audio_clip( (ClipSlot)arg1, (object)arg2) -> Clip : Creates an audio clip referencing the file at the given absolute path in the slot. Throws an error when called on non-empty slots or slots in non-audio or frozen tracks, or when the path doesn't point at a valid audio file.

C++ signature :
    TWeakPtr<TPyHandle<AClip>> create_audio_clip(TPyHandle<AGroupAndClipSlotBase>,TString)

`create_clip(...)`¶

create_clip( (ClipSlot)arg1, (float)arg2) -> Clip : 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 :
    TWeakPtr<TPyHandle<AClip>> create_clip(TPyHandle<AGroupAndClipSlotBase>,double)

`delete_clip(...)`¶

delete_clip( (ClipSlot)arg1) -> None : Removes the clip contained in the slot. Raises an exception if the slot was empty.

C++ signature :
    void delete_clip(TPyHandle<AGroupAndClipSlotBase>)

`duplicate_clip_to(...)`¶

duplicate_clip_to( (ClipSlot)arg1, (ClipSlot)arg2) -> None : Duplicates the slot's clip to the passed in target slot. Overrides the target's clip if it's not empty. Raises an exception if the (source) slot itself is empty, or if source and target have different track types (audio vs. MIDI). Also raises if the source or target slot is in a group track (so called group slot).

C++ signature :
    void duplicate_clip_to(TPyHandle<AGroupAndClipSlotBase>,TPyHandle<AGroupAndClipSlotBase>)

`fire(...)`¶

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]]])

`has_clip_has_listener(...)`¶

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)

`has_stop_button_has_listener(...)`¶

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)

`is_triggered_has_listener(...)`¶

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)

`playing_status_has_listener(...)`¶

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)

`remove_color_index_listener(...)`¶

remove_color_index_listener( (ClipSlot)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "color_index".

C++ signature :
    void remove_color_index_listener(TPyHandle<AGroupAndClipSlotBase>,boost::python::api::object)

`remove_color_listener(...)`¶

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)

`remove_controls_other_clips_listener(...)`¶

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)

`remove_has_clip_listener(...)`¶

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)

`remove_has_stop_button_listener(...)`¶

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)

`remove_is_triggered_listener(...)`¶

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)

`remove_playing_status_listener(...)`¶

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)

`set_fire_button_state(...)`¶

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)

`stop(...)`¶

stop( (ClipSlot)arg1) -> None : Stop playing the contained Clip, if there is a Clip and its currently playing.

C++ signature :
    void stop(TPyHandle<AGroupAndClipSlotBase>)

class `ClipSlotPlayingState(enum)`¶

Methods¶

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

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

`as_integer_ratio(self, /)`¶

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

(10).as_integer_ratio() (10, 1) (-10).as_integer_ratio() (-10, 1) (0).as_integer_ratio() (0, 1)

`bit_count(self, /)`¶

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

bin(13) '0b1101' (13).bit_count() 3

`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='big', *, 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. Default is to use 'big'. signed Indicates whether two's complement is used to represent the integer.

`to_bytes(self, /, length=1, byteorder='big', *, 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. Default is length 1. 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. Default is to use 'big'. 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¶

denominator = <attribute 'denominator' of 'int' objects> - the denominator of a rational number in lowest terms
imag = <attribute 'imag' of 'int' objects> - the imaginary part of a complex number
name = <member 'name' of 'Boost.Python.enum' objects>
names = {'stopped': ClipSlot.ClipSlotPlayingState.stopped, 'started': ClipSlot.ClipSlotPlayingState.started, 'recording': ClipSlot.ClipSlotPlayingState.recording} - 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
recording = ClipSlot.ClipSlotPlayingState.recording
started = ClipSlot.ClipSlotPlayingState.started
stopped = ClipSlot.ClipSlotPlayingState.stopped
values = {0: ClipSlot.ClipSlotPlayingState.stopped, 1: ClipSlot.ClipSlotPlayingState.started, 2: ClipSlot.ClipSlotPlayingState.recording} - dict() -> new empty dictionary

Live.ClipSlot (runtime)¶

Classes¶

class ClipSlot(LomObject)¶

Properties¶

Methods¶

__init__(...)¶

add_color_index_listener(...)¶

add_color_listener(...)¶

add_controls_other_clips_listener(...)¶

add_has_clip_listener(...)¶

add_has_stop_button_listener(...)¶

add_is_triggered_listener(...)¶

add_playing_status_listener(...)¶

color_has_listener(...)¶

color_index_has_listener(...)¶

controls_other_clips_has_listener(...)¶

create_audio_clip(...)¶

create_clip(...)¶

delete_clip(...)¶

duplicate_clip_to(...)¶

fire(...)¶

has_clip_has_listener(...)¶

has_stop_button_has_listener(...)¶

is_triggered_has_listener(...)¶

playing_status_has_listener(...)¶

remove_color_index_listener(...)¶

remove_color_listener(...)¶

remove_controls_other_clips_listener(...)¶

remove_has_clip_listener(...)¶

remove_has_stop_button_listener(...)¶

remove_is_triggered_listener(...)¶

remove_playing_status_listener(...)¶

set_fire_button_state(...)¶

stop(...)¶

class ClipSlotPlayingState(enum)¶

Methods¶

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

as_integer_ratio(self, /)¶

bit_count(self, /)¶

bit_length(self, /)¶

conjugate(...)¶

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

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

Attributes¶

`Live.ClipSlot` (runtime)¶

class `ClipSlot(LomObject)`¶

`init(...)`¶

`add_color_index_listener(...)`¶

`add_color_listener(...)`¶

`add_controls_other_clips_listener(...)`¶

`add_has_clip_listener(...)`¶

`add_has_stop_button_listener(...)`¶

`add_is_triggered_listener(...)`¶

`add_playing_status_listener(...)`¶

`color_has_listener(...)`¶

`color_index_has_listener(...)`¶

`controls_other_clips_has_listener(...)`¶

`create_audio_clip(...)`¶

`create_clip(...)`¶

`delete_clip(...)`¶

`duplicate_clip_to(...)`¶

`fire(...)`¶

`has_clip_has_listener(...)`¶

`has_stop_button_has_listener(...)`¶

`is_triggered_has_listener(...)`¶

`playing_status_has_listener(...)`¶

`remove_color_index_listener(...)`¶

`remove_color_listener(...)`¶

`remove_controls_other_clips_listener(...)`¶

`remove_has_clip_listener(...)`¶

`remove_has_stop_button_listener(...)`¶

`remove_is_triggered_listener(...)`¶

`remove_playing_status_listener(...)`¶

`set_fire_button_state(...)`¶

`stop(...)`¶

class `ClipSlotPlayingState(enum)`¶

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

`as_integer_ratio(self, /)`¶

`bit_count(self, /)`¶

`bit_length(self, /)`¶

`conjugate(...)`¶

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

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