`Live.Clip` (runtime)¶

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

Classes¶

class `Clip(LomObject)`¶

This class represents a Clip in Live. It can be either an Audio Clip or a MIDI Clip, in an Arrangement or the Session, depending on the Track (Slot) it lives in.

Properties¶

_live_ptr
automation_envelopes - Const access to a list of all automation envelopes for this clip.
available_warp_modes - Available for AudioClips only.
canonical_parent - Get the canonical parent of the Clip.
color - Get/set access to the color of the Clip (RGB).
color_index - Get/set access to the color index of the Clip.
end_marker - Get/Set the Clips end marker pos in beats/seconds (unit depends on warping).
end_time - Get the clip's end time.
file_path - Get the path of the file represented by the Audio Clip.
gain - Available for AudioClips only.
gain_display_string - Return a string with the gain as dB value
groove - Get the groove associated with this clip.
has_envelopes - Will notify if the clip gets his first envelope or the last envelope is removed.
has_groove - Returns true if a groove is associated with this clip.
is_arrangement_clip - return true if this Clip is an Arrangement Clip.
is_audio_clip - Return true if this Clip is an Audio Clip.
is_midi_clip - return true if this Clip is a MIDI Clip.
is_overdubbing - returns true if the Clip is recording overdubs
is_playing - Get/Set if this Clip is currently playing. If the Clips trigger mode
is_recording - returns true if the Clip was triggered to record or is recording.
is_session_clip - return true if this Clip is a Session Clip.
is_take_lane_clip - return true if this Clip is a Take Lane Clip.
is_triggered - returns true if the Clip was triggered or is playing.
launch_mode - Get/Set access to the launch mode setting of the Clip.
launch_quantization - Get/Set access to the launch quantization setting of the Clip.
legato - Get/Set access to the legato setting of the Clip
length - Get to the Clips length in beats/seconds (unit depends on warping).
loop_end - Get/Set the loop end pos of this Clip in beats/seconds (unit depends on warping).
loop_start - Get/Set the Clips loopstart pos in beats/seconds (unit depends on warping).
looping - Get/Set the Clips 'loop is enabled' flag
muted - Read/write access to the mute state of the Clip.
name - Read/write access to the name of the Clip.
pitch_coarse - Available for AudioClips only.
pitch_fine - Available for AudioClips only.
playing_position - Constant access to the current playing position of the clip.
position - Get/Set the loop position of this Clip in beats/seconds (unit depends on warping).
ram_mode - Available for AudioClips only.
sample_length - Available for AudioClips only.
sample_rate - Available for AudioClips only.
signature_denominator - Get/Set access to the global signature denominator of the Clip.
signature_numerator - Get/Set access to the global signature numerator of the Clip.
start_marker - Get/Set the Clips start marker pos in beats/seconds (unit depends on warping).
start_time - Get the clip's start time offset. For Session View clips, this is the time the clip was started. For Arrangement View clips, this is the offset within the arrangement.
velocity_amount - Get/Set access to the velocity to volume amount of the Clip.
view - Get the view of the Clip.
warp_markers - Available for AudioClips only.
warp_mode - Available for AudioClips only.
warping - Available for AudioClips only.
will_record_on_start - returns true if the Clip will record on being started.

Methods¶

`View(...)`¶

Representing the view aspects of a Clip.

`init(...)`¶

Raises an exception This class cannot be instantiated from Python

`add_color_index_listener(...)`¶

add_color_index_listener( (Clip)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<AClip>,boost::python::api::object)

`add_color_listener(...)`¶

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)

`add_end_marker_listener(...)`¶

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)

`add_end_time_listener(...)`¶

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

C++ signature :
    void add_end_time_listener(TPyHandle<AClip>,boost::python::api::object)

`add_file_path_listener(...)`¶

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

C++ signature :
    void add_file_path_listener(TPyHandle<AClip>,boost::python::api::object)

`add_gain_listener(...)`¶

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)

`add_groove_listener(...)`¶

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

C++ signature :
    void add_groove_listener(TPyHandle<AClip>,boost::python::api::object)

`add_has_envelopes_listener(...)`¶

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)

`add_is_overdubbing_listener(...)`¶

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)

`add_is_recording_listener(...)`¶

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)

`add_launch_mode_listener(...)`¶

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

C++ signature :
    void add_launch_mode_listener(TPyHandle<AClip>,boost::python::api::object)

`add_launch_quantization_listener(...)`¶

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

C++ signature :
    void add_launch_quantization_listener(TPyHandle<AClip>,boost::python::api::object)

`add_legato_listener(...)`¶

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

C++ signature :
    void add_legato_listener(TPyHandle<AClip>,boost::python::api::object)

`add_loop_end_listener(...)`¶

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

C++ signature :
    void add_loop_end_listener(TPyHandle<AClip>,boost::python::api::object)

`add_loop_jump_listener(...)`¶

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)

`add_loop_start_listener(...)`¶

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)

`add_looping_listener(...)`¶

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)

`add_muted_listener(...)`¶

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)

`add_name_listener(...)`¶

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)

`add_new_notes(...)`¶

add_new_notes( (Clip)arg1, (object)arg2) -> IntU64Vector : Expects a Python iterable holding a number of Live.Clip.MidiNoteSpecification objects. The objects will be used to construct new notes in the clip.

C++ signature :
    std::__1::vector<unsigned long long, std::__1::allocator<unsigned long long>> add_new_notes(TPyHandle<AClip>,boost::python::api::object)

`add_notes_listener(...)`¶

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)

`add_pitch_coarse_listener(...)`¶

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)

`add_pitch_fine_listener(...)`¶

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)

`add_playing_position_listener(...)`¶

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)

`add_playing_status_listener(...)`¶

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)

`add_position_listener(...)`¶

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

C++ signature :
    void add_position_listener(TPyHandle<AClip>,boost::python::api::object)

`add_ram_mode_listener(...)`¶

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

C++ signature :
    void add_ram_mode_listener(TPyHandle<AClip>,boost::python::api::object)

`add_signature_denominator_listener(...)`¶

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)

`add_signature_numerator_listener(...)`¶

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)

`add_start_marker_listener(...)`¶

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)

`add_start_time_listener(...)`¶

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

C++ signature :
    void add_start_time_listener(TPyHandle<AClip>,boost::python::api::object)

`add_velocity_amount_listener(...)`¶

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

C++ signature :
    void add_velocity_amount_listener(TPyHandle<AClip>,boost::python::api::object)

`add_warp_marker(...)`¶

add_warp_marker( (Clip)self, (object)warp_marker) -> None : Available for AudioClips only. Adds the specified warp marker, if possible.

C++ signature :
    void add_warp_marker(TPyHandle<AClip>,boost::python::api::object)

`add_warp_markers_listener(...)`¶

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

C++ signature :
    void add_warp_markers_listener(TPyHandle<AClip>,boost::python::api::object)

`add_warp_mode_listener(...)`¶

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)

`add_warping_listener(...)`¶

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

C++ signature :
    void add_warping_listener(TPyHandle<AClip>,boost::python::api::object)

`apply_note_modifications(...)`¶

apply_note_modifications( (Clip)arg1, (MidiNoteVector)arg2) -> None : Expects a list of notes as returned from get_notes_extended. The content of the list will be used to modify existing notes in the clip, based on matching note IDs. This function should be used when modifying existing notes, e.g. changing the velocity or start time. The function ensures that per-note events attached to the modified notes are preserved. This is NOT the case when replacing notes via a combination of remove_notes_extended and add_new_notes. The given list can be a subset of the notes in the clip, but it must not contain any notes that are not present in the clip.

C++ signature :
    void apply_note_modifications(TPyHandle<AClip>,std::__1::vector<NClipApi::TNoteInfo, std::__1::allocator<NClipApi::TNoteInfo>>)

`automation_envelope(...)`¶

automation_envelope( (Clip)arg1, (DeviceParameter)arg2) -> Envelope : Return the envelope for the given parameter.Returns None if the envelope doesn't exist.Returns None for Arrangement clips.Returns None for parameters from a different track.

C++ signature :
    TWeakPtr<TPyHandle<AAutomation>> automation_envelope(TPyHandle<AClip>,TPyHandle<ATimeableValue>)

`beat_to_sample_time(...)`¶

beat_to_sample_time( (Clip)self, (float)beat_time) -> float : Available for AudioClips only. Converts the given beat time to sample time. Raises an error if the sample is not warped.

C++ signature :
    double beat_to_sample_time(TPyHandle<AClip>,double)

`clear_all_envelopes(...)`¶

clear_all_envelopes( (Clip)arg1) -> None : Clears all envelopes for this clip.

C++ signature :
    void clear_all_envelopes(TPyHandle<AClip>)

`clear_envelope(...)`¶

clear_envelope( (Clip)arg1, (DeviceParameter)arg2) -> None : Clears the envelope of this clips given parameter.

C++ signature :
    void clear_envelope(TPyHandle<AClip>,TPyHandle<ATimeableValue>)

`color_has_listener(...)`¶

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)

`color_index_has_listener(...)`¶

color_index_has_listener( (Clip)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<AClip>,boost::python::api::object)

`create_automation_envelope(...)`¶

create_automation_envelope( (Clip)arg1, (DeviceParameter)arg2) -> Envelope : Creates an envelope for a given parameter and returns it.This should only be used if the envelope doesn't exist.Raises an error if the envelope can't be created.

C++ signature :
    TWeakPtr<TPyHandle<AAutomation>> create_automation_envelope(TPyHandle<AClip>,TPyHandle<ATimeableValue>)

`crop(...)`¶

crop( (Clip)arg1) -> None : Crops the clip. The region that is cropped depends on whether the clip is looped or not. If looped, the region outside of the loop is removed. If not looped, the region outside the start and end markers is removed.

C++ signature :
    void crop(TPyHandle<AClip>)

`deselect_all_notes(...)`¶

deselect_all_notes( (Clip)arg1) -> None : De-selects all notes present in the clip.

C++ signature :
    void deselect_all_notes(TPyHandle<AClip>)

`duplicate_loop(...)`¶

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

`duplicate_notes_by_id(...)`¶

duplicate_notes_by_id( (Clip)self, (object)note_ids [, (object)destination_time=None [, (int)transposition_amount=0]]) -> IntU64Vector : Duplicate all notes matching the given note IDs. If the optional destination_time is not provided, new notes will be inserted after the last selected note. This behavior can be observed when duplicating notes in the Live GUI. If the transposition_amount is specified, the notes in the region will be transposed by the number of semitones. Raises an error on audio clips.

C++ signature :
    std::__1::vector<unsigned long long, std::__1::allocator<unsigned long long>> duplicate_notes_by_id(TPyHandle<AClip>,boost::python::api::object [,boost::python::api::object=None [,int=0]])

`duplicate_region(...)`¶

duplicate_region( (Clip)self, (float)region_start, (float)region_length, (float)destination_time [, (int)pitch=-1 [, (int)transposition_amount=0]]) -> None : Duplicate the notes in the specified region to the destination_time. Only notes of the specified pitch are duplicated or all if pitch is -1. If the transposition_amount is not 0, the notes in the region will be transposed by the transpose_amount of semitones.Raises an error on audio clips.

C++ signature :
    void duplicate_region(TPyHandle<AClip>,double,double,double [,int=-1 [,int=0]])

`end_marker_has_listener(...)`¶

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)

`end_time_has_listener(...)`¶

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

C++ signature :
    bool end_time_has_listener(TPyHandle<AClip>,boost::python::api::object)

`file_path_has_listener(...)`¶

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

C++ signature :
    bool file_path_has_listener(TPyHandle<AClip>,boost::python::api::object)

`fire(...)`¶

fire( (Clip)arg1) -> None : (Re)Start playing this Clip.

C++ signature :
    void fire(TPyHandle<AClip>)

`gain_has_listener(...)`¶

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)

`get_all_notes_extended(...)`¶

get_all_notes_extended( (Clip)arg1) -> MidiNoteVector : Returns a list of all MIDI notes from the clip, regardless of their position relative to the start and end markers/loop start and loop end. Each note is represented by a Live.Clip.MidiNote object. The returned list can be modified freely, but modifications will not be reflected in the MIDI clip until apply_note_modifications is called.

C++ signature :
    std::__1::vector<NClipApi::TNoteInfo, std::__1::allocator<NClipApi::TNoteInfo>> get_all_notes_extended(TPyHandle<AClip>)

`get_notes(...)`¶

get_notes( (Clip)self, (float)from_time, (int)from_pitch, (float)time_span, (int)pitch_span) -> 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)

`get_notes_by_id(...)`¶

get_notes_by_id( (Clip)arg1, (object)note_ids) -> MidiNoteVector : Return a list of MIDI notes matching the given note IDs.

C++ signature :
    std::__1::vector<NClipApi::TNoteInfo, std::__1::allocator<NClipApi::TNoteInfo>> get_notes_by_id(TPyHandle<AClip>,boost::python::api::object)

`get_notes_extended(...)`¶

get_notes_extended( (Clip)arg1, (int)from_pitch, (int)pitch_span, (float)from_time, (float)time_span) -> MidiNoteVector : Returns a list of MIDI notes from the given pitch and time range. Each note is represented by a Live.Clip.MidiNote object. The returned list can be modified freely, but modifications will not be reflected in the MIDI clip until apply_note_modifications is called.

C++ signature :
    std::__1::vector<NClipApi::TNoteInfo, std::__1::allocator<NClipApi::TNoteInfo>> get_notes_extended(TPyHandle<AClip>,int,int,double,double)

`get_selected_notes(...)`¶

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

`get_selected_notes_extended(...)`¶

get_selected_notes_extended( (Clip)arg1) -> MidiNoteVector : Returns a list of all MIDI notes from the clip that are currently selected. Each note is represented by a Live.Clip.MidiNote object. The returned list can be modified freely, but modifications will not be reflected in the MIDI clip until apply_note_modifications is called.

C++ signature :
    std::__1::vector<NClipApi::TNoteInfo, std::__1::allocator<NClipApi::TNoteInfo>> get_selected_notes_extended(TPyHandle<AClip>)

`groove_has_listener(...)`¶

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

C++ signature :
    bool groove_has_listener(TPyHandle<AClip>,boost::python::api::object)

`has_envelopes_has_listener(...)`¶

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)

`is_overdubbing_has_listener(...)`¶

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)

`is_recording_has_listener(...)`¶

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)

`launch_mode_has_listener(...)`¶

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

C++ signature :
    bool launch_mode_has_listener(TPyHandle<AClip>,boost::python::api::object)

`launch_quantization_has_listener(...)`¶

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

C++ signature :
    bool launch_quantization_has_listener(TPyHandle<AClip>,boost::python::api::object)

`legato_has_listener(...)`¶

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

C++ signature :
    bool legato_has_listener(TPyHandle<AClip>,boost::python::api::object)

`loop_end_has_listener(...)`¶

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)

`loop_jump_has_listener(...)`¶

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

C++ signature :
    bool loop_jump_has_listener(TPyHandle<AClip>,boost::python::api::object)

`loop_start_has_listener(...)`¶

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)

`looping_has_listener(...)`¶

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)

`move_playing_pos(...)`¶

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)

`move_warp_marker(...)`¶

move_warp_marker( (Clip)self, (float)marker_beat_time, (float)beat_time_distance) -> None : Available for AudioClips only. Moves the specified warp marker by the specified beat time amount, if possible.

C++ signature :
    void move_warp_marker(TPyHandle<AClip>,double,double)

`muted_has_listener(...)`¶

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)

`name_has_listener(...)`¶

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)

`note_number_to_name(...)`¶

note_number_to_name( (Clip)self, (int)midi_pitch) -> str : Return a human-readable name for the given MIDI note number. Takes into account the scale and tonal spelling settings of the clip, as well as the current tuning system (if any)

C++ signature :
    TString note_number_to_name(TPyHandle<AClip>,int)

`notes_has_listener(...)`¶

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)

`pitch_coarse_has_listener(...)`¶

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)

`pitch_fine_has_listener(...)`¶

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)

`playing_position_has_listener(...)`¶

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)

`playing_status_has_listener(...)`¶

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)

`position_has_listener(...)`¶

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

C++ signature :
    bool position_has_listener(TPyHandle<AClip>,boost::python::api::object)

`quantize(...)`¶

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)

`quantize_pitch(...)`¶

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)

`ram_mode_has_listener(...)`¶

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

C++ signature :
    bool ram_mode_has_listener(TPyHandle<AClip>,boost::python::api::object)

`remove_color_index_listener(...)`¶

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

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

`remove_color_listener(...)`¶

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)

`remove_end_marker_listener(...)`¶

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)

`remove_end_time_listener(...)`¶

remove_end_time_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "end_time".

C++ signature :
    void remove_end_time_listener(TPyHandle<AClip>,boost::python::api::object)

`remove_file_path_listener(...)`¶

remove_file_path_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "file_path".

C++ signature :
    void remove_file_path_listener(TPyHandle<AClip>,boost::python::api::object)

`remove_gain_listener(...)`¶

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)

`remove_groove_listener(...)`¶

remove_groove_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "groove".

C++ signature :
    void remove_groove_listener(TPyHandle<AClip>,boost::python::api::object)

`remove_has_envelopes_listener(...)`¶

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)

`remove_is_overdubbing_listener(...)`¶

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)

`remove_is_recording_listener(...)`¶

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)

`remove_launch_mode_listener(...)`¶

remove_launch_mode_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "launch_mode".

C++ signature :
    void remove_launch_mode_listener(TPyHandle<AClip>,boost::python::api::object)

`remove_launch_quantization_listener(...)`¶

remove_launch_quantization_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "launch_quantization".

C++ signature :
    void remove_launch_quantization_listener(TPyHandle<AClip>,boost::python::api::object)

`remove_legato_listener(...)`¶

remove_legato_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "legato".

C++ signature :
    void remove_legato_listener(TPyHandle<AClip>,boost::python::api::object)

`remove_loop_end_listener(...)`¶

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)

`remove_loop_jump_listener(...)`¶

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)

`remove_loop_start_listener(...)`¶

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)

`remove_looping_listener(...)`¶

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)

`remove_muted_listener(...)`¶

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)

`remove_name_listener(...)`¶

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)

`remove_notes(...)`¶

remove_notes( (Clip)arg1, (float)arg2, (int)arg3, (float)arg4, (int)arg5) -> None : Delete all notes starting in the given pitch- and time range.

C++ signature :
    void remove_notes(TPyHandle<AClip>,double,int,double,int)

`remove_notes_by_id(...)`¶

remove_notes_by_id( (Clip)arg1, (object)arg2) -> None : Delete all notes matching the given note IDs. This function should NOT be used to implement modification of existing notes (i.e. in combination with add_new_notes), as that leads to loss of per-note events. apply_note_modifications must be used instead for modifying existing notes.

C++ signature :
    void remove_notes_by_id(TPyHandle<AClip>,boost::python::api::object)

`remove_notes_extended(...)`¶

remove_notes_extended( (Clip)arg1, (int)from_pitch, (int)pitch_span, (float)from_time, (float)time_span) -> None : Delete all notes starting in the given pitch and time range. This function should NOT be used to implement modification of existing notes (i.e. in combination with add_new_notes), as that leads to loss of per-note events. apply_note_modifications must be used instead for modifying existing notes.

C++ signature :
    void remove_notes_extended(TPyHandle<AClip>,int,int,double,double)

`remove_notes_listener(...)`¶

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)

`remove_pitch_coarse_listener(...)`¶

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)

`remove_pitch_fine_listener(...)`¶

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)

`remove_playing_position_listener(...)`¶

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)

`remove_playing_status_listener(...)`¶

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)

`remove_position_listener(...)`¶

remove_position_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "position".

C++ signature :
    void remove_position_listener(TPyHandle<AClip>,boost::python::api::object)

`remove_ram_mode_listener(...)`¶

remove_ram_mode_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "ram_mode".

C++ signature :
    void remove_ram_mode_listener(TPyHandle<AClip>,boost::python::api::object)

`remove_signature_denominator_listener(...)`¶

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)

`remove_signature_numerator_listener(...)`¶

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)

`remove_start_marker_listener(...)`¶

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)

`remove_start_time_listener(...)`¶

remove_start_time_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "start_time".

C++ signature :
    void remove_start_time_listener(TPyHandle<AClip>,boost::python::api::object)

`remove_velocity_amount_listener(...)`¶

remove_velocity_amount_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "velocity_amount".

C++ signature :
    void remove_velocity_amount_listener(TPyHandle<AClip>,boost::python::api::object)

`remove_warp_marker(...)`¶

remove_warp_marker( (Clip)self, (float)beat_time) -> None : Available for AudioClips only. Removes the specified warp marker, if possible.

C++ signature :
    void remove_warp_marker(TPyHandle<AClip>,double)

`remove_warp_markers_listener(...)`¶

remove_warp_markers_listener( (Clip)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "warp_markers".

C++ signature :
    void remove_warp_markers_listener(TPyHandle<AClip>,boost::python::api::object)

`remove_warp_mode_listener(...)`¶

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)

`remove_warping_listener(...)`¶

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)

`replace_selected_notes(...)`¶

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)

`sample_to_beat_time(...)`¶

sample_to_beat_time( (Clip)self, (float)sample_time) -> float : Available for AudioClips only. Converts the given sample time to beat time. Raises an error if the sample is not warped.

C++ signature :
    double sample_to_beat_time(TPyHandle<AClip>,double)

`scrub(...)`¶

scrub( (Clip)self, (float)scrub_position) -> None : Scrubs inside a clip. scrub_position defines the position in beats that the scrub will start from. The scrub will continue until stop_scrub is called. Global quantization applies to the scrub's position and length.

C++ signature :
    void scrub(TPyHandle<AClip>,double)

`seconds_to_sample_time(...)`¶

seconds_to_sample_time( (Clip)self, (float)seconds) -> float : Available for AudioClips only. Converts the given seconds to sample time. Raises an error if the sample is warped.

C++ signature :
    double seconds_to_sample_time(TPyHandle<AClip>,double)

`select_all_notes(...)`¶

select_all_notes( (Clip)arg1) -> None : Selects all notes present in the clip.

C++ signature :
    void select_all_notes(TPyHandle<AClip>)

`select_notes_by_id(...)`¶

select_notes_by_id( (Clip)arg1, (object)arg2) -> None : Selects all notes matching the given note IDs.

C++ signature :
    void select_notes_by_id(TPyHandle<AClip>,boost::python::api::object)

`set_fire_button_state(...)`¶

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)

`set_notes(...)`¶

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)

`signature_denominator_has_listener(...)`¶

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)

`signature_numerator_has_listener(...)`¶

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)

`start_marker_has_listener(...)`¶

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)

`start_time_has_listener(...)`¶

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

C++ signature :
    bool start_time_has_listener(TPyHandle<AClip>,boost::python::api::object)

`stop(...)`¶

stop( (Clip)arg1) -> None : Stop playing this Clip.

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

`stop_scrub(...)`¶

stop_scrub( (Clip)arg1) -> None : Stops the current scrub.

C++ signature :
    void stop_scrub(TPyHandle<AClip>)

`velocity_amount_has_listener(...)`¶

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

C++ signature :
    bool velocity_amount_has_listener(TPyHandle<AClip>,boost::python::api::object)

`warp_markers_has_listener(...)`¶

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

C++ signature :
    bool warp_markers_has_listener(TPyHandle<AClip>,boost::python::api::object)

`warp_mode_has_listener(...)`¶

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)

`warping_has_listener(...)`¶

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)

class `ClipLaunchQuantization(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.

`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 = {'q_global': Clip.ClipLaunchQuantization.q_global, 'q_none': Clip.ClipLaunchQuantization.q_none, 'q_8_bars': Clip.ClipLaunchQuantization.q_8_bars, 'q_4_bars': C... - dict() -> new empty dictionary
numerator = <attribute 'numerator' of 'int' objects> - the numerator of a rational number in lowest terms
q_2_bars = Clip.ClipLaunchQuantization.q_2_bars
q_4_bars = Clip.ClipLaunchQuantization.q_4_bars
q_8_bars = Clip.ClipLaunchQuantization.q_8_bars
q_bar = Clip.ClipLaunchQuantization.q_bar
q_eighth = Clip.ClipLaunchQuantization.q_eighth
q_eighth_triplet = Clip.ClipLaunchQuantization.q_eighth_triplet
q_global = Clip.ClipLaunchQuantization.q_global
q_half = Clip.ClipLaunchQuantization.q_half
q_half_triplet = Clip.ClipLaunchQuantization.q_half_triplet
q_none = Clip.ClipLaunchQuantization.q_none
q_quarter = Clip.ClipLaunchQuantization.q_quarter
q_quarter_triplet = Clip.ClipLaunchQuantization.q_quarter_triplet
q_sixteenth = Clip.ClipLaunchQuantization.q_sixteenth
q_sixteenth_triplet = Clip.ClipLaunchQuantization.q_sixteenth_triplet
q_thirtysecond = Clip.ClipLaunchQuantization.q_thirtysecond
real = <attribute 'real' of 'int' objects> - the real part of a complex number
values = {0: Clip.ClipLaunchQuantization.q_global, 1: Clip.ClipLaunchQuantization.q_none, 2: Clip.ClipLaunchQuantization.q_8_bars, 3: Clip.ClipLaunchQuantization.q_4_bar... - dict() -> new empty dictionary

class `GridQuantization(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.

`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¶

count = Clip.GridQuantization.count
denominator = <attribute 'denominator' of 'int' objects> - the denominator of a rational number in lowest terms
g_2_bars = Clip.GridQuantization.g_2_bars
g_4_bars = Clip.GridQuantization.g_4_bars
g_8_bars = Clip.GridQuantization.g_8_bars
g_bar = Clip.GridQuantization.g_bar
g_eighth = Clip.GridQuantization.g_eighth
g_half = Clip.GridQuantization.g_half
g_quarter = Clip.GridQuantization.g_quarter
g_sixteenth = Clip.GridQuantization.g_sixteenth
g_thirtysecond = Clip.GridQuantization.g_thirtysecond
imag = <attribute 'imag' of 'int' objects> - the imaginary part of a complex number
name = <member 'name' of 'Boost.Python.enum' objects>
names = {'no_grid': Clip.GridQuantization.no_grid, 'g_8_bars': Clip.GridQuantization.g_8_bars, 'g_4_bars': Clip.GridQuantization.g_4_bars, 'g_2_bars': Clip.GridQuantiza... - dict() -> new empty dictionary
no_grid = Clip.GridQuantization.no_grid
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: Clip.GridQuantization.no_grid, 1: Clip.GridQuantization.g_8_bars, 2: Clip.GridQuantization.g_4_bars, 3: Clip.GridQuantization.g_2_bars, 4: Clip.GridQuantiza... - dict() -> new empty dictionary

class `LaunchMode(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.

`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
gate = Clip.LaunchMode.gate
imag = <attribute 'imag' of 'int' objects> - the imaginary part of a complex number
name = <member 'name' of 'Boost.Python.enum' objects>
names = {'trigger': Clip.LaunchMode.trigger, 'gate': Clip.LaunchMode.gate, 'toggle': Clip.LaunchMode.toggle, 'repeat': Clip.LaunchMode.repeat} - 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
repeat = Clip.LaunchMode.repeat
toggle = Clip.LaunchMode.toggle
trigger = Clip.LaunchMode.trigger
values = {0: Clip.LaunchMode.trigger, 1: Clip.LaunchMode.gate, 2: Clip.LaunchMode.toggle, 3: Clip.LaunchMode.repeat} - dict() -> new empty dictionary

class `MidiNote(instance)`¶

An object representing a MIDI Note

Properties¶

duration
mute
note_id - A numerical ID that's unique within the originating clip of the note. Not to be
pitch
probability
release_velocity
start_time
velocity
velocity_deviation

Methods¶

`init(...)`¶

Raises an exception This class cannot be instantiated from Python

class `MidiNoteSpecification(instance)`¶

An object specifying the data for creating a MIDI note. To be used with the add_new_notes function.

Methods¶

`init(...)`¶

init( (object)arg1, (int)pitch, (float)start_time, (float)duration [, (float)velocity=100.0 [, (bool)mute=False [, (float)probability=1.0 [, (float)velocity_deviation=0.0 [, (float)release_velocity=64.0]]]]]) -> None : Create a new note specification. Only pitch, start_time and duration are mandatory. All other arguments will take on default values if not specified.

C++ signature :
    void __init__(_object*,int,double,double [,float=100.0 [,bool=False [,float=1.0 [,float=0.0 [,float=64.0]]]]])

class `MidiNoteVector(instance)`¶

A container for holding MIDI notes from Live.

Methods¶

`init(...)`¶

Raises an exception This class cannot be instantiated from Python

`append(...)`¶

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

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

`extend(...)`¶

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

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

class `WarpMarker(instance)`¶

This class represents a WarpMarker type.

Properties¶

beat_time - A WarpMarker's beat time.
sample_time - A WarpMarker's sample time.

Methods¶

`init(...)`¶

init( (object)arg1, (float)sample_time, (float)beat_time) -> None : Create a new warp marker specification.

C++ signature :
    void __init__(_object*,double,double)

class `WarpMarkerVector(instance)`¶

A container for returning warp markers from Live.

Methods¶

`init(...)`¶

Raises an exception This class cannot be instantiated from Python

`append(...)`¶

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

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

`extend(...)`¶

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

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

class `WarpMode(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.

`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¶

beats = Clip.WarpMode.beats
complex = Clip.WarpMode.complex
complex_pro = Clip.WarpMode.complex_pro
count = Clip.WarpMode.count
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 = {'beats': Clip.WarpMode.beats, 'complex': Clip.WarpMode.complex, 'complex_pro': Clip.WarpMode.complex_pro, 'repitch': Clip.WarpMode.repitch, 'rex': Clip.WarpMod... - 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
repitch = Clip.WarpMode.repitch
rex = Clip.WarpMode.rex
texture = Clip.WarpMode.texture
tones = Clip.WarpMode.tones
values = {0: Clip.WarpMode.beats, 4: Clip.WarpMode.complex, 6: Clip.WarpMode.complex_pro, 3: Clip.WarpMode.repitch, 5: Clip.WarpMode.rex, 2: Clip.WarpMode.texture, 1: Cl... - dict() -> new empty dictionary

Live.Clip (runtime)¶

Classes¶

class Clip(LomObject)¶

Properties¶

Methods¶

View(...)¶

__init__(...)¶

add_color_index_listener(...)¶

add_color_listener(...)¶

add_end_marker_listener(...)¶

add_end_time_listener(...)¶

add_file_path_listener(...)¶

add_gain_listener(...)¶

add_groove_listener(...)¶

add_has_envelopes_listener(...)¶

add_is_overdubbing_listener(...)¶

add_is_recording_listener(...)¶

add_launch_mode_listener(...)¶

add_launch_quantization_listener(...)¶

add_legato_listener(...)¶

add_loop_end_listener(...)¶

add_loop_jump_listener(...)¶

add_loop_start_listener(...)¶

add_looping_listener(...)¶

add_muted_listener(...)¶

add_name_listener(...)¶

add_new_notes(...)¶

add_notes_listener(...)¶

add_pitch_coarse_listener(...)¶

add_pitch_fine_listener(...)¶

add_playing_position_listener(...)¶

add_playing_status_listener(...)¶

add_position_listener(...)¶

add_ram_mode_listener(...)¶

add_signature_denominator_listener(...)¶

add_signature_numerator_listener(...)¶

add_start_marker_listener(...)¶

add_start_time_listener(...)¶

add_velocity_amount_listener(...)¶

add_warp_marker(...)¶

add_warp_markers_listener(...)¶

add_warp_mode_listener(...)¶

add_warping_listener(...)¶

apply_note_modifications(...)¶

automation_envelope(...)¶

beat_to_sample_time(...)¶

clear_all_envelopes(...)¶

clear_envelope(...)¶

color_has_listener(...)¶

color_index_has_listener(...)¶

create_automation_envelope(...)¶

crop(...)¶

deselect_all_notes(...)¶

duplicate_loop(...)¶

duplicate_notes_by_id(...)¶

duplicate_region(...)¶

end_marker_has_listener(...)¶

end_time_has_listener(...)¶

file_path_has_listener(...)¶

fire(...)¶

gain_has_listener(...)¶

get_all_notes_extended(...)¶

get_notes(...)¶

get_notes_by_id(...)¶

get_notes_extended(...)¶

get_selected_notes(...)¶

get_selected_notes_extended(...)¶

groove_has_listener(...)¶

has_envelopes_has_listener(...)¶

is_overdubbing_has_listener(...)¶

is_recording_has_listener(...)¶

launch_mode_has_listener(...)¶

launch_quantization_has_listener(...)¶

legato_has_listener(...)¶

loop_end_has_listener(...)¶

loop_jump_has_listener(...)¶

loop_start_has_listener(...)¶

looping_has_listener(...)¶

move_playing_pos(...)¶

move_warp_marker(...)¶

`Live.Clip` (runtime)¶

class `Clip(LomObject)`¶

`View(...)`¶

`init(...)`¶

`add_color_index_listener(...)`¶

`add_color_listener(...)`¶

`add_end_marker_listener(...)`¶

`add_end_time_listener(...)`¶

`add_file_path_listener(...)`¶

`add_gain_listener(...)`¶

`add_groove_listener(...)`¶

`add_has_envelopes_listener(...)`¶

`add_is_overdubbing_listener(...)`¶

`add_is_recording_listener(...)`¶

`add_launch_mode_listener(...)`¶

`add_launch_quantization_listener(...)`¶

`add_legato_listener(...)`¶

`add_loop_end_listener(...)`¶

`add_loop_jump_listener(...)`¶

`add_loop_start_listener(...)`¶

`add_looping_listener(...)`¶

`add_muted_listener(...)`¶

`add_name_listener(...)`¶

`add_new_notes(...)`¶

`add_notes_listener(...)`¶

`add_pitch_coarse_listener(...)`¶

`add_pitch_fine_listener(...)`¶

`add_playing_position_listener(...)`¶

`add_playing_status_listener(...)`¶

`add_position_listener(...)`¶

`add_ram_mode_listener(...)`¶

`add_signature_denominator_listener(...)`¶

`add_signature_numerator_listener(...)`¶

`add_start_marker_listener(...)`¶

`add_start_time_listener(...)`¶

`add_velocity_amount_listener(...)`¶

`add_warp_marker(...)`¶

`add_warp_markers_listener(...)`¶

`add_warp_mode_listener(...)`¶

`add_warping_listener(...)`¶

`apply_note_modifications(...)`¶

`automation_envelope(...)`¶

`beat_to_sample_time(...)`¶

`clear_all_envelopes(...)`¶

`clear_envelope(...)`¶

`color_has_listener(...)`¶

`color_index_has_listener(...)`¶

`create_automation_envelope(...)`¶

`crop(...)`¶

`deselect_all_notes(...)`¶

`duplicate_loop(...)`¶

`duplicate_notes_by_id(...)`¶

`duplicate_region(...)`¶

`end_marker_has_listener(...)`¶

`end_time_has_listener(...)`¶

`file_path_has_listener(...)`¶

`fire(...)`¶

`gain_has_listener(...)`¶

`get_all_notes_extended(...)`¶

`get_notes(...)`¶

`get_notes_by_id(...)`¶

`get_notes_extended(...)`¶

`get_selected_notes(...)`¶

`get_selected_notes_extended(...)`¶

`groove_has_listener(...)`¶

`has_envelopes_has_listener(...)`¶

`is_overdubbing_has_listener(...)`¶

`is_recording_has_listener(...)`¶

`launch_mode_has_listener(...)`¶

`launch_quantization_has_listener(...)`¶

`legato_has_listener(...)`¶

`loop_end_has_listener(...)`¶

`loop_jump_has_listener(...)`¶

`loop_start_has_listener(...)`¶

`looping_has_listener(...)`¶

`move_playing_pos(...)`¶

`move_warp_marker(...)`¶

`muted_has_listener(...)`¶

`name_has_listener(...)`¶

`note_number_to_name(...)`¶