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

#include <omSoundDeviceID.h>

Public Member Functions
Bool	operator== (const SoundDeviceID &other) const
	Return whether or not this device ID represents the same device as another. More...

Bool	operator!= (const SoundDeviceID &other) const
	Return whether or not this device ID represents a different device than another. More...

Bool	isValid () const
	Return whether or not this SoundDeviceID represents a valid device. More...

Static Public Attributes
static const SoundDeviceID	INVALID_DEVICE
	Define an instance of SoundDeviceID that represents an invalid device. More...

Detailed Description

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

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

Member Function Documentation

Bool om::sound::devices::SoundDeviceID::operator== ( const SoundDeviceID & other ) const

inline

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

Bool om::sound::devices::SoundDeviceID::operator!= ( const SoundDeviceID & other ) const

inline

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

Bool om::sound::devices::SoundDeviceID::isValid ( ) const

inline

Return whether or not this SoundDeviceID represents a valid device.

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

const SoundDeviceID om::sound::devices::SoundDeviceID::INVALID_DEVICE

static

Define an instance of SoundDeviceID that represents an invalid device.

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