Skip to content

Live.TuningSystem (runtime)

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

Classes

class PitchClassAndOctave(instance)

This class represents a PitchClassAndOctave type.

Properties

  • index_in_octave - A PitchClassAndOctave's index within the pseudo octave.
  • octave - A PitchClassAndOctave's octave.

Methods

__init__(...)

init( (object)arg1, (int)index_in_octave, (int)octave) -> None : Create a new pitch class and octave specification.

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

class ReferencePitch(instance)

This class represents a ReferencePitch type.

Properties

  • frequency - A ReferencePitch's frequency in Hz.
  • index_in_octave - A ReferencePitch's index within the pseudo octave.
  • octave - A ReferencePitch's octave.

Methods

__init__(...)

init( (object)arg1, (int)index_in_octave, (int)octave, (float)frequency) -> None : Create a new reference pitch specification.

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

class TuningSystem(LomObject)

Represents a Tuning System and its properties.

Properties

  • _live_ptr
  • canonical_parent - Get the canonical parent of the TuningSystem.
  • highest_note - Get/Set the highest note of the current tuning system, where the first entry is
  • lowest_note - Get/Set the lowest note of the current tuning system, where the first entry is
  • name - Get/Set the name of the currently active tuning system.
  • note_tunings - Get/Set the currently active tuning system's note tunings, specified in Cents, where 100 Cents is one semi-tone in equal temperament.
  • number_of_notes_in_pseudo_octave - Get the number of notes in the pseudo octave.
  • pseudo_octave_in_cents - Get the pseudo octave in cents for the currently active tuning system.
  • reference_pitch - Get/Set the reference pitch the currently active tuning system.

Methods

__init__(...)

Raises an exception This class cannot be instantiated from Python

add_highest_note_listener(...)

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

C++ signature :
    void add_highest_note_listener(TPyHandle<ATuningSystem>,boost::python::api::object)
add_lowest_note_listener(...)

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

C++ signature :
    void add_lowest_note_listener(TPyHandle<ATuningSystem>,boost::python::api::object)
add_name_listener(...)

add_name_listener( (TuningSystem)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<ATuningSystem>,boost::python::api::object)
add_note_tunings_listener(...)

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

C++ signature :
    void add_note_tunings_listener(TPyHandle<ATuningSystem>,boost::python::api::object)
add_reference_pitch_listener(...)

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

C++ signature :
    void add_reference_pitch_listener(TPyHandle<ATuningSystem>,boost::python::api::object)
highest_note_has_listener(...)

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

C++ signature :
    bool highest_note_has_listener(TPyHandle<ATuningSystem>,boost::python::api::object)
lowest_note_has_listener(...)

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

C++ signature :
    bool lowest_note_has_listener(TPyHandle<ATuningSystem>,boost::python::api::object)
name_has_listener(...)

name_has_listener( (TuningSystem)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<ATuningSystem>,boost::python::api::object)
note_tunings_has_listener(...)

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

C++ signature :
    bool note_tunings_has_listener(TPyHandle<ATuningSystem>,boost::python::api::object)
reference_pitch_has_listener(...)

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

C++ signature :
    bool reference_pitch_has_listener(TPyHandle<ATuningSystem>,boost::python::api::object)
remove_highest_note_listener(...)

remove_highest_note_listener( (TuningSystem)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "highest_note".

C++ signature :
    void remove_highest_note_listener(TPyHandle<ATuningSystem>,boost::python::api::object)
remove_lowest_note_listener(...)

remove_lowest_note_listener( (TuningSystem)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "lowest_note".

C++ signature :
    void remove_lowest_note_listener(TPyHandle<ATuningSystem>,boost::python::api::object)
remove_name_listener(...)

remove_name_listener( (TuningSystem)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "name".

C++ signature :
    void remove_name_listener(TPyHandle<ATuningSystem>,boost::python::api::object)
remove_note_tunings_listener(...)

remove_note_tunings_listener( (TuningSystem)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "note_tunings".

C++ signature :
    void remove_note_tunings_listener(TPyHandle<ATuningSystem>,boost::python::api::object)
remove_reference_pitch_listener(...)

remove_reference_pitch_listener( (TuningSystem)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "reference_pitch".

C++ signature :
    void remove_reference_pitch_listener(TPyHandle<ATuningSystem>,boost::python::api::object)