Vuo  2.3.2
Classes | Macros | Functions
VuoMidiNote

Description

A music note event sent via MIDI.

Classes

struct  VuoMidiNote
 A music note event sent via MIDI. More...
 

Functions

VuoMidiNote VuoMidiNote_makeFromJson (json_object *js)
 Decodes the JSON object js to create a new value. More...
 
json_objectVuoMidiNote_getJson (const VuoMidiNote mn)
 Encodes value as a JSON object. More...
 
char * VuoMidiNote_getSummary (const VuoMidiNote mn)
 Returns a compact string representation of value (comma-separated coordinates). More...
 
bool VuoMidiNote_areEqual (const VuoMidiNote value1, const VuoMidiNote value2)
 Returns true if the channel, note status (on/off), velocity, and note number all match. More...
 
bool VuoMidiNote_isLessThan (const VuoMidiNote a, const VuoMidiNote b)
 Returns true if a < b. More...
 
static VuoMidiNote VuoMidiNote_make (unsigned char channel, bool isNoteOn, unsigned char velocity, unsigned char noteNumber) __attribute__((const))
 Returns a note event with the specified values. More...
 
VuoMidiNote VuoMidiNote_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoMidiNote_getString (const VuoMidiNote value)
 Automatically generated function. More...
 
void VuoMidiNote_retain (VuoMidiNote value)
 Automatically generated function. More...
 
void VuoMidiNote_release (VuoMidiNote value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoMidiNote

struct VuoMidiNote
Class Members
unsigned char channel Permitted values: 1 through 16.
bool isNoteOn Is this a Note On or Note Off event?
unsigned char noteNumber Permitted values: 0 through 127.
unsigned char velocity Permitted values: 0 through 127.

Function Documentation

◆ VuoMidiNote_areEqual()

bool VuoMidiNote_areEqual ( const VuoMidiNote  value1,
const VuoMidiNote  value2 
)

Returns true if the channel, note status (on/off), velocity, and note number all match.

Definition at line 96 of file VuoMidiNote.c.

◆ VuoMidiNote_getJson()

struct json_object * VuoMidiNote_getJson ( const VuoMidiNote  mn)

Encodes value as a JSON object.

Definition at line 56 of file VuoMidiNote.c.

◆ VuoMidiNote_getString()

char* VuoMidiNote_getString ( const VuoMidiNote  value)

Automatically generated function.

◆ VuoMidiNote_getSummary()

char * VuoMidiNote_getSummary ( const VuoMidiNote  mn)

Returns a compact string representation of value (comma-separated coordinates).

Includes the note name with the ASA 1939 octave designator (e.g., noteNumber 60, middle C, is "C4"). Journal of the Acoustical Society of America, Volume 11, Issue 1, pp. 134-139 (1939).

Definition at line 82 of file VuoMidiNote.c.

◆ VuoMidiNote_isLessThan()

bool VuoMidiNote_isLessThan ( const VuoMidiNote  a,
const VuoMidiNote  b 
)

Returns true if a < b.

Changed in Vuo 2.0.0:
New.

Definition at line 108 of file VuoMidiNote.c.

◆ VuoMidiNote_make()

static VuoMidiNote VuoMidiNote_make ( unsigned char  channel,
bool  isNoteOn,
unsigned char  velocity,
unsigned char  noteNumber 
) const
inlinestatic

Returns a note event with the specified values.

Definition at line 43 of file VuoMidiNote.h.

◆ VuoMidiNote_makeFromJson()

VuoMidiNote VuoMidiNote_makeFromJson ( json_object js)

Decodes the JSON object js to create a new value.

Example:
{
"channel" : 1,
"isNoteOn" : true,
"velocity" : 127,
"noteNumber" : 60
}

Definition at line 42 of file VuoMidiNote.c.

◆ VuoMidiNote_makeFromString()

VuoMidiNote VuoMidiNote_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoMidiNote_release()

void VuoMidiNote_release ( VuoMidiNote  value)

Automatically generated function.

◆ VuoMidiNote_retain()

void VuoMidiNote_retain ( VuoMidiNote  value)

Automatically generated function.