juce::MidiInput Class Reference

Represents a midi input device. More...

#include <juce_MidiDevices.h>

Collaboration diagram for juce::MidiInput:

Public Member Functions
	~MidiInput ()
	Destructor. More...
MidiDeviceInfo	getDeviceInfo () const noexcept
	Returns the MidiDeviceInfo struct containing some information about this device. More...
String	getIdentifier () const noexcept
	Returns the identifier of this device. More...
String	getName () const noexcept
	Returns the name of this device. More...
void	setName (const String &newName) noexcept
	Sets a custom name for the device. More...
void	start ()
	Starts the device running. More...
void	stop ()
	Stops the device running. More...

Static Public Member Functions
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). More...
static Array< MidiDeviceInfo >	getAvailableDevices ()
	Returns a list of the available midi input devices. More...
static MidiDeviceInfo	getDefaultDevice ()
	Returns the MidiDeviceInfo of the default midi input device to use. More...
static std::unique_ptr< MidiInput >	openDevice (const String &deviceIdentifier, MidiInputCallback *callback)
	Tries to open one of the midi input devices. More...

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

(

)

Destructor.

MidiInput()

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

explicitprivate

Member Function Documentation

createNewDevice()

static std::unique_ptr<MidiInput> juce::MidiInput::createNewDevice ( const String &  deviceName, MidiInputCallback *  callback  )

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.

Parameters

deviceName	the name of the device to create
callback	the object that will receive the midi messages from this device

getAvailableDevices()

static 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

Referenced by juce::StandalonePluginHolder::timerCallback().

getDefaultDevice()

static MidiDeviceInfo juce::MidiInput::getDefaultDevice ( )

static

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

getDeviceInfo()

MidiDeviceInfo juce::MidiInput::getDeviceInfo ( ) const

inlinenoexcept

Returns the MidiDeviceInfo struct containing some information about this device.

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()

static 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

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 file:

• juce_MidiDevices.h