juce::MidiInput Class Reference

#include <juce_MidiDevices.h>

Classes
class	Pimpl

Public Member Functions
	~MidiInput ()
void	start ()
void	stop ()
MidiDeviceInfo	getDeviceInfo () const noexcept
String	getIdentifier () const noexcept
String	getName () const noexcept
void	setName (const String &newName) noexcept

Static Public Member Functions
static Array< MidiDeviceInfo >	getAvailableDevices ()
static MidiDeviceInfo	getDefaultDevice ()
static std::unique_ptr< MidiInput >	openDevice (const String &deviceIdentifier, MidiInputCallback *callback)
static StringArray	getDevices ()
static int	getDefaultDeviceIndex ()
static std::unique_ptr< MidiInput >	openDevice (int, MidiInputCallback *)

Private Member Functions
	MidiInput (const String &, const String &)

Private Attributes
MidiDeviceInfo	deviceInfo
std::unique_ptr< Pimpl >	internal

Detailed Description

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.

See also

MidiOutput

@tags{Audio}

Constructor & Destructor Documentation

~MidiInput()

juce::MidiInput::~MidiInput ( )

default

Destructor.

MidiInput()

juce::MidiInput::MidiInput ( const String & deviceName, const String & deviceID )

explicitprivate

Member Function Documentation

getAvailableDevices()

Array< MidiDeviceInfo > juce::MidiInput::getAvailableDevices ( )

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.

See also

MidiDeviceInfo, getDevices, getDefaultDeviceIndex, openDevice

getDefaultDevice()

MidiDeviceInfo juce::MidiInput::getDefaultDevice ( )

static

Returns the MidiDeviceInfo of the default midi input device to use.

getDefaultDeviceIndex()

int juce::MidiInput::getDefaultDeviceIndex ( )

static

getDeviceInfo()

MidiDeviceInfo juce::MidiInput::getDeviceInfo ( ) const

inlinenoexcept

Returns the MidiDeviceInfo struct containing some information about this device.

getDevices()

StringArray juce::MidiInput::getDevices ( )

static

getIdentifier()

String juce::MidiInput::getIdentifier ( ) const

inlinenoexcept

Returns the identifier of this device.

getName()

String juce::MidiInput::getName ( ) const

inlinenoexcept

Returns the name of this device.

openDevice() [1/2]

std::unique_ptr< MidiInput > juce::MidiInput::openDevice ( const String & deviceIdentifier, MidiInputCallback * callback )

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.

Parameters

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

See also

MidiInputCallback, getDevices

openDevice() [2/2]

std::unique_ptr< MidiInput > juce::MidiInput::openDevice ( int index, MidiInputCallback * callback )

static

setName()

void juce::MidiInput::setName ( const String & newName )

inlinenoexcept

Sets a custom name for the device.

start()

void juce::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.

See also

stop

stop()

void juce::MidiInput::stop

(

)

Stops the device running.

See also

start

Member Data Documentation

deviceInfo

MidiDeviceInfo juce::MidiInput::deviceInfo

private

internal

std::unique_ptr<Pimpl> juce::MidiInput::internal

private

---

The documentation for this class was generated from the following files:

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_audio_devices/midi_io/juce_MidiDevices.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_audio_devices/native/juce_linux_Bela.cpp
• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_audio_devices/native/juce_linux_Midi.cpp
• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_audio_devices/native/juce_win32_Midi.cpp