serialMIDI.h File Reference

Detailed Description

MIDI Library for the Arduino - Platform @license MIT - Copyright (c) 2015 Francois Best.

Project Arduino MIDI Library

Author

lathoub, Francois Best

Date

22/03/20

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Definition in file serialMIDI.h.

#include "midi_Namespace.h"

Go to the source code of this file.

Classes
struct	DefaultSerialSettings
class	SerialMIDI< SerialPort, _Settings >

Macros
#define	MIDI_CREATE_INSTANCE(Type, SerialPort, Name)
	Create an instance of the library attached to a serial port. You can use HardwareSerial or SoftwareSerial for the serial port. Example: MIDI_CREATE_INSTANCE(HardwareSerial, Serial2, midi2); Then call midi2.begin(), midi2.read() etc..
#define	MIDI_CREATE_DEFAULT_INSTANCE()    MIDI_CREATE_INSTANCE(HardwareSerial, Serial, MIDI);
	Create an instance of the library with default name, serial port and settings, for compatibility with sketches written with pre-v4.2 MIDI Lib, or if you don't bother using custom names, serial port or settings.
#define	MIDI_CREATE_CUSTOM_INSTANCE(Type, SerialPort, Name, Settings)
	Create an instance of the library attached to a serial port with custom settings.

Macro Definition Documentation

MIDI_CREATE_CUSTOM_INSTANCE

#define MIDI_CREATE_CUSTOM_INSTANCE	(		Type,
			SerialPort,
			Name,
			Settings )

Value:

    MIDI_NAMESPACE::SerialMIDI<Type, Settings> serial##Name(SerialPort);\
    MIDI_NAMESPACE::MidiInterface<MIDI_NAMESPACE::SerialMIDI<Type, Settings>> Name((MIDI_NAMESPACE::SerialMIDI<Type, Settings>&)serial##Name);

Create an instance of the library attached to a serial port with custom settings.

See also

DefaultSettings

MIDI_CREATE_INSTANCE

Definition at line 121 of file serialMIDI.h.

MIDI_CREATE_DEFAULT_INSTANCE

#define MIDI_CREATE_DEFAULT_INSTANCE

(

)

MIDI_CREATE_INSTANCE(HardwareSerial, Serial, MIDI);

Create an instance of the library with default name, serial port and settings, for compatibility with sketches written with pre-v4.2 MIDI Lib, or if you don't bother using custom names, serial port or settings.

Definition at line 112 of file serialMIDI.h.

MIDI_CREATE_INSTANCE

#define MIDI_CREATE_INSTANCE	(		Type,
			SerialPort,
			Name )

Value:

    MIDI_NAMESPACE::SerialMIDI<Type> serial##Name(SerialPort);\
    MIDI_NAMESPACE::MidiInterface<MIDI_NAMESPACE::SerialMIDI<Type>> Name((MIDI_NAMESPACE::SerialMIDI<Type>&)serial##Name);

Create an instance of the library attached to a serial port. You can use HardwareSerial or SoftwareSerial for the serial port. Example: MIDI_CREATE_INSTANCE(HardwareSerial, Serial2, midi2); Then call midi2.begin(), midi2.read() etc..

Definition at line 99 of file serialMIDI.h.