Module xMidiMessage

An extended MIDI message.

The syntax expands upon the standard 3 bytes of a MIDI message, making it possible to pass around data with higher resolution

Test

ability to cache a message once turned into raw MIDI, (change it only as message properties are modified via setters)

Requires

xMessage

Functions

get_definition () xMessage
get_message_type () xMidiMessage
create_raw_message () Class Methods
split_mb (val) Static Methods
merge_mb (msb, lsb) provided with a 14-bit value, we return the MSB/LSB parts

Fields

self.message_type xMidiMessage.TYPE (required) default to sysex - a neutral default when converting from OSC
self.channel int, between 0-16 0 should be interpreted as 'undefined'
self.bit_depth xMidiMessage.BIT_DEPTH, indicates a multibyte message (only relevant for CC messages, as they can otherwise be ambivalent)
self.mode xMidiMessage.MODE, more detailed information about message (this property can be set, TODO: auto-detect)
self.port_name string, source/target port
self.nrpn_order xMidiMessage.NRPN_ORDER
self.terminate_nrpns boolean, whether to terminate NRPNs (output)


Functions

get_definition ()
xMessage
get_message_type ()
xMidiMessage
create_raw_message ()
Class Methods produce a raw MIDI message from an xMidiMessage (cached)

Returns:

    table (table, as we might return a multi-byte message)
    split_mb (val)
    Static Methods provided with a 14-bit value, we return the MSB/LSB parts

    Parameters:

    • val
    merge_mb (msb, lsb)
    provided with a 14-bit value, we return the MSB/LSB parts

    Parameters:

    • msb
    • lsb return bit.rshift(msb,7) + lsb

    Fields

    self.message_type
    xMidiMessage.TYPE (required) default to sysex - a neutral default when converting from OSC
    self.channel
    int, between 0-16 0 should be interpreted as 'undefined'
    self.bit_depth
    xMidiMessage.BIT_DEPTH, indicates a multibyte message (only relevant for CC messages, as they can otherwise be ambivalent)
    self.mode
    xMidiMessage.MODE, more detailed information about message (this property can be set, TODO: auto-detect)
    self.port_name
    string, source/target port
    self.nrpn_order
    xMidiMessage.NRPN_ORDER
    self.terminate_nrpns
    boolean, whether to terminate NRPNs (output)
    generated by LDoc 1.4.2