Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | List of all members
om::sound::devices::MIDIDeviceManager Class Reference

A class that queries the system for currently connected MIDI devices. More...

#include <omSoundMIDIDeviceManager.h>

Public Member Functions

 MIDIDeviceManager ()
 Create a MIDI device manager. More...
 
 MIDIDeviceManager (const MIDIDeviceManager &other)
 Create a copy of a MIDI device manager. More...
 
 ~MIDIDeviceManager ()
 Destroy this MIDI device manager. More...
 
MIDIDeviceManageroperator= (const MIDIDeviceManager &other)
 Assign the state of one MIDI device manager to another. More...
 
Size getInputDeviceCount () const
 Get the number of connected MIDI input devices. More...
 
MIDIDeviceID getInputDeviceID (Index deviceIndex) const
 Get an identifier for the MIDI input device at the specified index. More...
 
Size getOutputDeviceCount () const
 Get the number of connected MIDI output devices. More...
 
MIDIDeviceID getOutputDeviceID (Index deviceIndex) const
 Get an identifier for the MIDI output device at the specified index. More...
 
MIDIDeviceID getDefaultInputDeviceID () const
 Get an identifier for the default system MIDI input device. More...
 
MIDIDeviceID getDefaultOutputDeviceID () const
 Get an identifier for the default system MIDI output device. More...
 
const MIDIDeviceManagerDelegategetDelegate () const
 Return a reference to the delegate object that is responding to events for this device manager. More...
 
void setDelegate (const MIDIDeviceManagerDelegate &newDelegate)
 Replace the delegate object that is responding to events for this device manager. More...
 

Detailed Description

A class that queries the system for currently connected MIDI devices.

It provides a platform-independent method of determining the number of MIDI input and output devices and accessing those devices. It maintains an internal list of the currently connected MIDI devices. One can query the class for input and output device IDs which can be used to construct device objects.

Constructor & Destructor Documentation

om::sound::devices::MIDIDeviceManager::MIDIDeviceManager ( )

Create a MIDI device manager.

om::sound::devices::MIDIDeviceManager::MIDIDeviceManager ( const MIDIDeviceManager other)

Create a copy of a MIDI device manager.

om::sound::devices::MIDIDeviceManager::~MIDIDeviceManager ( )

Destroy this MIDI device manager.

Member Function Documentation

MIDIDeviceManager& om::sound::devices::MIDIDeviceManager::operator= ( const MIDIDeviceManager other)

Assign the state of one MIDI device manager to another.

Size om::sound::devices::MIDIDeviceManager::getInputDeviceCount ( ) const

Get the number of connected MIDI input devices.

MIDIDeviceID om::sound::devices::MIDIDeviceManager::getInputDeviceID ( Index  deviceIndex) const

Get an identifier for the MIDI input device at the specified index.

If the specified index is out-of-bounds, MIDIDeviceID::INVALID_DEVICE is returned.

Size om::sound::devices::MIDIDeviceManager::getOutputDeviceCount ( ) const

Get the number of connected MIDI output devices.

MIDIDeviceID om::sound::devices::MIDIDeviceManager::getOutputDeviceID ( Index  deviceIndex) const

Get an identifier for the MIDI output device at the specified index.

If the specified index is out-of-bounds, MIDIDeviceID::INVALID_DEVICE is returned.

MIDIDeviceID om::sound::devices::MIDIDeviceManager::getDefaultInputDeviceID ( ) const

Get an identifier for the default system MIDI input device.

If there is no default input device, MIDIDeviceID::INVALID_DEVICE is returned.

MIDIDeviceID om::sound::devices::MIDIDeviceManager::getDefaultOutputDeviceID ( ) const

Get an identifier for the default system MIDI output device.

If there is no default output device, MIDIDeviceID::INVALID_DEVICE is returned.

const MIDIDeviceManagerDelegate& om::sound::devices::MIDIDeviceManager::getDelegate ( ) const
inline

Return a reference to the delegate object that is responding to events for this device manager.

void om::sound::devices::MIDIDeviceManager::setDelegate ( const MIDIDeviceManagerDelegate newDelegate)

Replace the delegate object that is responding to events for this device manager.


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