Classes | Public Types | Static Public Member Functions | List of all members
universal_midi_packets::SysEx7 Struct Reference

This struct acts as a single-file namespace for Univeral MIDI Packet functionality related to 7-bit SysEx. More...

Classes

struct  PacketBytes
 Holds the bytes from a single SysEx-7 packet. More...
 

Public Types

enum  Kind : uint8_t { Kind::complete = 0, Kind::begin = 1, Kind::continuation = 2, Kind::end = 3 }
 The different kinds of UMP SysEx-7 message. More...
 

Static Public Member Functions

static uint32_t getNumPacketsRequiredForDataSize (uint32_t)
 Returns the number of 64-bit packets required to hold a series of SysEx bytes. More...
 
static PacketBytes getDataBytes (const PacketX2 &packet)
 Extracts the data bytes from a 64-bit data message. More...
 

Detailed Description

This struct acts as a single-file namespace for Univeral MIDI Packet functionality related to 7-bit SysEx.

Member Enumeration Documentation

◆ Kind

enum universal_midi_packets::SysEx7::Kind : uint8_t
strong

The different kinds of UMP SysEx-7 message.

Enumerator
complete 

The whole message fits in a single 2-word packet.

begin 

The packet begins a SysEx message that will continue in subsequent packets.

continuation 

The packet is a continuation of an ongoing SysEx message.

end 

The packet terminates an ongoing SysEx message.

Member Function Documentation

◆ getNumPacketsRequiredForDataSize()

static uint32_t universal_midi_packets::SysEx7::getNumPacketsRequiredForDataSize ( uint32_t  )
static

Returns the number of 64-bit packets required to hold a series of SysEx bytes.

The number passed to this function should exclude the leading/trailing SysEx bytes used in an old midi bytestream, as these are not required when using Universal MIDI Packets.

Referenced by universal_midi_packets::Conversion::toMidi1().

◆ getDataBytes()

static PacketBytes universal_midi_packets::SysEx7::getDataBytes ( const PacketX2 packet)
static

Extracts the data bytes from a 64-bit data message.


The documentation for this struct was generated from the following file: