Skip to content

Live.MidiMap (runtime)

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

Functions

forward_midi_cc(...)

forward_midi_cc( (int)arg1, (int)arg2, (int)arg3, (int)arg4 [, (bool)ShouldConsumeEvent=True]) -> bool :

C++ signature :
    bool forward_midi_cc(unsigned int,unsigned int,int,int [,bool=True])

forward_midi_note(...)

forward_midi_note( (int)arg1, (int)arg2, (int)arg3, (int)arg4 [, (bool)ShouldConsumeEvent=True]) -> bool :

C++ signature :
    bool forward_midi_note(unsigned int,unsigned int,int,int [,bool=True])

forward_midi_pitchbend(...)

forward_midi_pitchbend( (int)arg1, (int)arg2, (int)arg3) -> bool :

C++ signature :
    bool forward_midi_pitchbend(unsigned int,unsigned int,int)

map_midi_cc(...)

map_midi_cc( (int)midi_map_handle, (DeviceParameter)parameter, (int)midi_channel, (int)controller_number, (MapMode)map_mode, (bool)avoid_takeover [, (float)sensitivity=1.0]) -> bool :

C++ signature :
    bool map_midi_cc(unsigned int,TPyHandle<ATimeableValue>,int,int,NRemoteMapperTypes::TControllerMapMode,bool [,float=1.0])

map_midi_cc_with_feedback_map(...)

map_midi_cc_with_feedback_map( (int)midi_map_handle, (DeviceParameter)parameter, (int)midi_channel, (int)controller_number, (MapMode)map_mode, (CCFeedbackRule)feedback_rule, (bool)avoid_takeover [, (float)sensitivity=1.0]) -> bool :

C++ signature :
    bool map_midi_cc_with_feedback_map(unsigned int,TPyHandle<ATimeableValue>,int,int,NRemoteMapperTypes::TControllerMapMode,NPythonMidiMap::TCCFeedbackRule,bool [,float=1.0])

map_midi_note(...)

map_midi_note( (int)arg1, (DeviceParameter)arg2, (int)arg3, (int)arg4) -> bool :

C++ signature :
    bool map_midi_note(unsigned int,TPyHandle<ATimeableValue>,int,int)

map_midi_note_with_feedback_map(...)

map_midi_note_with_feedback_map( (int)arg1, (DeviceParameter)arg2, (int)arg3, (int)arg4, (NoteFeedbackRule)arg5) -> bool :

C++ signature :
    bool map_midi_note_with_feedback_map(unsigned int,TPyHandle<ATimeableValue>,int,int,NPythonMidiMap::TNoteFeedbackRule)

map_midi_pitchbend(...)

map_midi_pitchbend( (int)arg1, (DeviceParameter)arg2, (int)arg3, (bool)arg4) -> bool :

C++ signature :
    bool map_midi_pitchbend(unsigned int,TPyHandle<ATimeableValue>,int,bool)

map_midi_pitchbend_with_feedback_map(...)

map_midi_pitchbend_with_feedback_map( (int)arg1, (DeviceParameter)arg2, (int)arg3, (PitchBendFeedbackRule)arg4, (bool)arg5) -> bool :

C++ signature :
    bool map_midi_pitchbend_with_feedback_map(unsigned int,TPyHandle<ATimeableValue>,int,NPythonMidiMap::TPitchBendFeedbackRule,bool)

send_feedback_for_parameter(...)

send_feedback_for_parameter( (int)arg1, (DeviceParameter)arg2) -> None :

C++ signature :
    void send_feedback_for_parameter(unsigned int,TPyHandle<ATimeableValue>)

Classes

class CCFeedbackRule(instance)

Structure to define feedback properties of MIDI mappings.

Properties

  • cc_no
  • cc_value_map
  • channel
  • delay_in_ms
  • enabled

Methods

__init__(...)

init( (object)arg1) -> None :

C++ signature :
    void __init__(_object*)

class MapMode(enum)

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

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

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

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

Methods

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

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

bit_length(self, /)

Number of bits necessary to represent self in binary.

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

conjugate(...)

Returns self, the complex conjugate of any int.

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

Return the integer represented by the given array of bytes.

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

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

Return an array of bytes representing an integer.

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

Attributes

  • absolute = MidiMap.MapMode.absolute
  • absolute_14_bit = MidiMap.MapMode.absolute_14_bit
  • 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 = {'absolute': MidiMap.MapMode.absolute, 'relative_signed_bit': MidiMap.MapMode.relative_signed_bit, 'relative_binary_offset': MidiMap.MapMode.relative_binary_off... - 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
  • relative_binary_offset = MidiMap.MapMode.relative_binary_offset
  • relative_signed_bit = MidiMap.MapMode.relative_signed_bit
  • relative_signed_bit2 = MidiMap.MapMode.relative_signed_bit2
  • relative_smooth_binary_offset = MidiMap.MapMode.relative_smooth_binary_offset
  • relative_smooth_signed_bit = MidiMap.MapMode.relative_smooth_signed_bit
  • relative_smooth_signed_bit2 = MidiMap.MapMode.relative_smooth_signed_bit2
  • relative_smooth_two_compliment = MidiMap.MapMode.relative_smooth_two_compliment
  • relative_two_compliment = MidiMap.MapMode.relative_two_compliment
  • values = {0: MidiMap.MapMode.absolute, 1: MidiMap.MapMode.relative_signed_bit, 2: MidiMap.MapMode.relative_binary_offset, 3: MidiMap.MapMode.relative_two_compliment, 4: ... - dict() -> new empty dictionary

class NoteFeedbackRule(instance)

Structure to define feedback properties of MIDI mappings.

Properties

  • channel
  • delay_in_ms
  • enabled
  • note_no
  • vel_map

Methods

__init__(...)

init( (object)arg1) -> None :

C++ signature :
    void __init__(_object*)

class PitchBendFeedbackRule(instance)

Structure to define feedback properties of MIDI mappings.

Properties

  • channel
  • delay_in_ms
  • enabled
  • value_pair_map

Methods

__init__(...)

init( (object)arg1) -> None :

C++ signature :
    void __init__(_object*)