MidiMap (Module)

CCFeedbackRule (Class)

Live.MidiMap.CCFeedbackRule

Structure to define feedback properties of MIDI mappings.

Constructor: CCFeedbackRule()

Properties

Property	Type	Supports
cc_no	int	get/set
cc_value_map	tuple[int, Ellipsis]	get/set
channel	int	get/set
delay_in_ms	float	get/set
enabled	bool	get/set

cc_no

• Type: int
• Settable: yes
• Listenable: no

cc_value_map

• Type: tuple[int, Ellipsis]
• Settable: yes
• Listenable: no

channel

• Type: int
• Settable: yes
• Listenable: no

delay_in_ms

• Type: float
• Settable: yes
• Listenable: no

enabled

• Type: bool
• Settable: yes
• Listenable: no

NoteFeedbackRule (Class)

Live.MidiMap.NoteFeedbackRule

Structure to define feedback properties of MIDI mappings.

Constructor: NoteFeedbackRule()

Properties

Property	Type	Supports
channel	int	get/set
delay_in_ms	float	get/set
enabled	bool	get/set
note_no	int	get/set
vel_map	tuple[int, Ellipsis]	get/set

channel

• Type: int
• Settable: yes
• Listenable: no

delay_in_ms

• Type: float
• Settable: yes
• Listenable: no

enabled

• Type: bool
• Settable: yes
• Listenable: no

note_no

• Type: int
• Settable: yes
• Listenable: no

vel_map

• Type: tuple[int, Ellipsis]
• Settable: yes
• Listenable: no

PitchBendFeedbackRule (Class)

Live.MidiMap.PitchBendFeedbackRule

Structure to define feedback properties of MIDI mappings.

Constructor: PitchBendFeedbackRule()

Properties

Property	Type	Supports
channel	int	get/set
delay_in_ms	float	get/set
enabled	bool	get/set
value_pair_map	tuple[tuple, Ellipsis]	get/set

channel

• Type: int
• Settable: yes
• Listenable: no

delay_in_ms

• Type: float
• Settable: yes
• Listenable: no

enabled

• Type: bool
• Settable: yes
• Listenable: no

value_pair_map

• Type: tuple[tuple, Ellipsis]
• Settable: yes
• Listenable: no

Enums

MapMode

Live.MidiMap.MapMode

Value	Name
0	absolute
1	relative_signed_bit
2	relative_binary_offset
3	relative_two_compliment
4	relative_signed_bit2
5	absolute_14_bit
6	relative_smooth_signed_bit
7	relative_smooth_binary_offset
8	relative_smooth_two_compliment
9	relative_smooth_signed_bit2

Module Functions

Function	Returns
forward_midi_cc()	bool
forward_midi_note()	bool
forward_midi_pitchbend()	bool
map_midi_cc()	bool
map_midi_cc_with_feedback_map()	bool
map_midi_note()	bool
map_midi_note_with_feedback_map()	bool
map_midi_pitchbend()	bool
map_midi_pitchbend_with_feedback_map()	bool
send_feedback_for_parameter()	None

forward_midi_cc(script_handle: int, midi_map_handle: int, midi_channel: int, controller_number: int, should_consume_event: bool = True)

• Returns: bool
• Args:
• script_handle: int
• midi_map_handle: int
• midi_channel: int
• controller_number: int
• should_consume_event: bool = True

forward_midi_note(script_handle: int, midi_map_handle: int, midi_channel: int, note: int, should_consume_event: bool = True)

• Returns: bool
• Args:
• script_handle: int
• midi_map_handle: int
• midi_channel: int
• note: int
• should_consume_event: bool = True

forward_midi_pitchbend(script_handle: int, midi_map_handle: int, midi_channel: int)

• Returns: bool
• Args:
• script_handle: int
• midi_map_handle: int
• midi_channel: int

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

• Returns: bool
• Args:
• midi_map_handle: int
• parameter: DeviceParameter
• midi_channel: int
• controller_number: int
• map_mode: MapMode
• avoid_takeover: bool
• sensitivity: float = 1.0

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

• Returns: bool
• Args:
• midi_map_handle: int
• parameter: DeviceParameter
• midi_channel: int
• controller_number: int
• map_mode: MapMode
• feedback_rule: CCFeedbackRule
• avoid_takeover: bool
• sensitivity: float = 1.0

map_midi_note(midi_map_handle: int, device_parameter: DeviceParameter, midi_channel: int, note: int)

• Returns: bool
• Args:
• midi_map_handle: int
• device_parameter: DeviceParameter
• midi_channel: int
• note: int

map_midi_note_with_feedback_map(midi_map_handle: int, device_parameter: DeviceParameter, midi_channel: int, note: int, feedback_rule: NoteFeedbackRule)

• Returns: bool
• Args:
• midi_map_handle: int
• device_parameter: DeviceParameter
• midi_channel: int
• note: int
• feedback_rule: NoteFeedbackRule

map_midi_pitchbend(midi_map_handle: int, device_parameter: DeviceParameter, midi_channel: int, needs_takeover: bool)

• Returns: bool
• Args:
• midi_map_handle: int
• device_parameter: DeviceParameter
• midi_channel: int
• needs_takeover: bool

map_midi_pitchbend_with_feedback_map(midi_map_handle: int, device_parameter: DeviceParameter, midi_channel: int, feedback_rule: PitchBendFeedbackRule, needs_takeover: bool)

• Returns: bool
• Args:
• midi_map_handle: int
• device_parameter: DeviceParameter
• midi_channel: int
• feedback_rule: PitchBendFeedbackRule
• needs_takeover: bool

send_feedback_for_parameter(midi_map_handle: int, device_parameter: DeviceParameter)

• Returns: None
• Args:
• midi_map_handle: int
• device_parameter: DeviceParameter