iPlug2 - C++ Audio Plug-in Framework
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
ISysEx Struct Reference

A struct for dealing with SysEx messages. More...

#include <IPlugMidi.h>

Public Member Functions

 ISysEx (int offset=0, const uint8_t *pData=nullptr, int size=0)
 Create an ISysex. More...
 
void Clear ()
 Clear the data pointer and size (does not modify the external data!)
More...
 
char * SysExStr (char *str, int maxLen, const uint8_t *pData, int size)
 Get the bytes of a sysex message as a CString. More...
 
void LogMsg ()
 Log a message (TRACER BUILDS) More...
 

Public Attributes

int mOffset
 
int mSize
 
const uint8_t * mData
 

Detailed Description

A struct for dealing with SysEx messages.

Does not own the data.

Definition at line 538 of file IPlugMidi.h.

Constructor & Destructor Documentation

◆ ISysEx()

ISysEx::ISysEx ( int  offset = 0,
const uint8_t *  pData = nullptr,
int  size = 0 
)
inline

Create an ISysex.

Parameters
offsetThe sample offset for the sysex message
pDataPtr to the data, which must stay valid while this object is used
sizeSize of the data in bytes

Definition at line 547 of file IPlugMidi.h.

Member Function Documentation

◆ Clear()

void ISysEx::Clear ( )
inline

Clear the data pointer and size (does not modify the external data!)

Definition at line 554 of file IPlugMidi.h.

◆ LogMsg()

void ISysEx::LogMsg ( )
inline

Log a message (TRACER BUILDS)

Definition at line 589 of file IPlugMidi.h.

References SysExStr().

◆ SysExStr()

char * ISysEx::SysExStr ( char *  str,
int  maxLen,
const uint8_t *  pData,
int  size 
)
inline

Get the bytes of a sysex message as a CString.

Parameters
strBuffer for CString
maxLensize of the CString buffer
pDataPtr to the bytes of the sysex message
sizeSize of the data in bytes
Returns
The CString result

Definition at line 566 of file IPlugMidi.h.

Referenced by LogMsg().

Member Data Documentation

◆ mData

const uint8_t* ISysEx::mData

Definition at line 541 of file IPlugMidi.h.

◆ mOffset

int ISysEx::mOffset

Definition at line 540 of file IPlugMidi.h.

◆ mSize

int ISysEx::mSize

Definition at line 540 of file IPlugMidi.h.


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