Represents a midi input device. More...
#include <juce_MidiDevices.h>
Public Member Functions | |
~MidiInput () | |
Destructor. | |
void | start () |
Starts the device running. | |
void | stop () |
Stops the device running. | |
MidiDeviceInfo | getDeviceInfo () const noexcept |
Returns the MidiDeviceInfo struct containing some information about this device. | |
String | getIdentifier () const noexcept |
Returns the identifier of this device. | |
String | getName () const noexcept |
Returns the name of this device. | |
void | setName (const String &newName) noexcept |
Sets a custom name for the device. | |
Static Public Member Functions | |
static Array< MidiDeviceInfo > | getAvailableDevices () |
Returns a list of the available midi input devices. | |
static MidiDeviceInfo | getDefaultDevice () |
Returns the MidiDeviceInfo of the default midi input device to use. | |
static std::unique_ptr< MidiInput > | openDevice (const String &deviceIdentifier, MidiInputCallback *callback) |
Tries to open one of the midi input devices. | |
static std::unique_ptr< MidiInput > | createNewDevice (const String &deviceName, MidiInputCallback *callback) |
This will try to create a new midi input device (only available on Linux, macOS and iOS). | |
Represents a midi input device.
To create one of these, use the static getAvailableDevices() method to find out what inputs are available, and then use the openDevice() method to try to open one.
MidiInput::~MidiInput | ( | ) |
Destructor.
|
static |
Returns a list of the available midi input devices.
You can open one of the devices by passing its identifier into the openDevice() method.
|
static |
Returns the MidiDeviceInfo of the default midi input device to use.
|
static |
Tries to open one of the midi input devices.
This will return a MidiInput object if it manages to open it, you can then call start() and stop() on this device.
If the device can't be opened, this will return an empty object.
deviceIdentifier | the ID of the device to open - use the getAvailableDevices() method to find the available devices that can be opened |
callback | the object that will receive the midi messages from this device |
|
static |
This will try to create a new midi input device (only available on Linux, macOS and iOS).
This will attempt to create a new midi input device with the specified name for other apps to connect to.
NB - if you are calling this method on iOS you must have enabled the "Audio Background Capability" setting in the iOS exporter otherwise this method will fail.
Returns an empty object if a device can't be created.
deviceName | the name of the device to create |
callback | the object that will receive the midi messages from this device |
void MidiInput::start | ( | ) |
Starts the device running.
After calling this, the device will start sending midi messages to the MidiInputCallback object that was specified when the openDevice() method was called.
|
noexcept |
Returns the MidiDeviceInfo struct containing some information about this device.
|
noexcept |
Returns the identifier of this device.
|
noexcept |
Returns the name of this device.