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

A class that is used to encapsulate a unique identifier for a system MIDI device. More...

#include <omSoundMIDIDeviceID.h>

Public Member Functions

Bool operator== (const MIDIDeviceID &other) const
 Return whether or not this device ID represents the same device as another. More...
 
Bool operator!= (const MIDIDeviceID &other) const
 Return whether or not this device ID represents a different device than another. More...
 
Bool isValid () const
 Return whether or not this MIDIDeviceID represents a valid device. More...
 
Bool isInput () const
 Return whether or not this device ID represents a device capable of MIDI input. More...
 
Bool isOutput () const
 Return whether or not this device ID represents a device capable of MIDI output. More...
 

Static Public Attributes

static const MIDIDeviceID INVALID_DEVICE
 Define an instance of MIDIDeviceID that represents an invalid device. More...
 

Detailed Description

A class that is used to encapsulate a unique identifier for a system MIDI device.

This opaque type uses a platform-dependent internal representation which uniquelly identifies a MIDI device.

Member Function Documentation

Bool om::sound::devices::MIDIDeviceID::operator== ( const MIDIDeviceID other) const
inline

Return whether or not this device ID represents the same device as another.

Bool om::sound::devices::MIDIDeviceID::operator!= ( const MIDIDeviceID other) const
inline

Return whether or not this device ID represents a different device than another.

Bool om::sound::devices::MIDIDeviceID::isValid ( ) const
inline

Return whether or not this MIDIDeviceID represents a valid device.

This condition is met whenever the device ID is not equal to INVALID_DEVICE_ID.

Bool om::sound::devices::MIDIDeviceID::isInput ( ) const
inline

Return whether or not this device ID represents a device capable of MIDI input.

Bool om::sound::devices::MIDIDeviceID::isOutput ( ) const
inline

Return whether or not this device ID represents a device capable of MIDI output.

Member Data Documentation

const MIDIDeviceID om::sound::devices::MIDIDeviceID::INVALID_DEVICE
static

Define an instance of MIDIDeviceID that represents an invalid device.


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