JUCE API reference
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
juce::MidiDeviceInfo Struct Reference

This struct contains information about a MIDI 1.0 input or output port. More...

Public Member Functions

 MidiDeviceInfo ()=default
 
 MidiDeviceInfo (const String &deviceName, const String &deviceIdentifier)
 
MidiDeviceInfo withName (String x) const
 
MidiDeviceInfo withIdentifier (String x) const
 
bool operator== (const MidiDeviceInfo &other) const noexcept
 
bool operator!= (const MidiDeviceInfo &other) const noexcept
 

Public Attributes

String name
 The name of this device.
 
String identifier
 The identifier for this device.
 

Detailed Description

This struct contains information about a MIDI 1.0 input or output port.

You can get one of these structs by calling the static getAvailableDevices() or getDefaultDevice() methods of MidiInput and MidiOutput or by calling getDeviceInfo() on an instance of these classes. Devices can be opened by passing the identifier to the openDevice() method.

Constructor & Destructor Documentation

◆ MidiDeviceInfo() [1/2]

juce::MidiDeviceInfo::MidiDeviceInfo ( )
default

◆ MidiDeviceInfo() [2/2]

juce::MidiDeviceInfo::MidiDeviceInfo ( const String &  deviceName,
const String &  deviceIdentifier 
)
inline

Member Function Documentation

◆ withName()

MidiDeviceInfo juce::MidiDeviceInfo::withName ( String  x) const
inline

References name, juce::withMember(), and x.

◆ withIdentifier()

MidiDeviceInfo juce::MidiDeviceInfo::withIdentifier ( String  x) const
inline

References identifier, juce::withMember(), and x.

◆ operator==()

bool juce::MidiDeviceInfo::operator== ( const MidiDeviceInfo &  other) const
noexcept

Referenced by operator!=().

◆ operator!=()

bool juce::MidiDeviceInfo::operator!= ( const MidiDeviceInfo &  other) const
inlinenoexcept

References operator==().

Member Data Documentation

◆ name

String juce::MidiDeviceInfo::name

The name of this device.

This will be provided by the OS unless the device has been created with the createNewDevice() method.

Note that the name is not guaranteed to be unique and two devices with the same name will be indistinguishable. If you want to address a specific device it is better to use the identifier.

Referenced by withName().

◆ identifier

String juce::MidiDeviceInfo::identifier

The identifier for this device.

This will be provided by the OS and its format will differ on different systems e.g. on macOS it will be a number whereas on Windows it will be a long alphanumeric string.

Referenced by withIdentifier().


The documentation for this struct was generated from the following file: