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

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

#include <omSoundDeviceManager.h>

Public Member Functions

 SoundDeviceManager ()
 Create a sound device manager. More...
 
 SoundDeviceManager (const SoundDeviceManager &other)
 Create a copy of a sound device manager. More...
 
 ~SoundDeviceManager ()
 Destroy this sound device manager. More...
 
SoundDeviceManageroperator= (const SoundDeviceManager &other)
 Assign the state of one sound device manager to another. More...
 
void refresh ()
 Update the device manager so that it has the most recent set of connected devices. More...
 
Size getDeviceCount () const
 Get the number of connected sound devices. More...
 
SoundDeviceID getDeviceID (Index deviceIndex) const
 Get an identifier for the sound device at the specified index. More...
 
SoundDeviceID getDefaultInputDeviceID () const
 Get an identifier for the default system sound input device. More...
 
SoundDeviceID getDefaultOutputDeviceID () const
 Get an identifier for the default system sound output device. More...
 
const SoundDeviceManagerDelegategetDelegate () const
 Return a reference to the delegate object that is responding to events for this device manager. More...
 
void setDelegate (const SoundDeviceManagerDelegate &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 audio devices.

It provides a platform-independent method of determining the number of audio input and output devices and accessing those devices. It maintains an internal list of the currently connected audio 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::SoundDeviceManager::SoundDeviceManager ( )

Create a sound device manager.

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

Create a copy of a sound device manager.

om::sound::devices::SoundDeviceManager::~SoundDeviceManager ( )

Destroy this sound device manager.

Member Function Documentation

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

Assign the state of one sound device manager to another.

void om::sound::devices::SoundDeviceManager::refresh ( )

Update the device manager so that it has the most recent set of connected devices.

It is not necessary to call this method in normal use, but it can be used to force an update of the cached device data.

Size om::sound::devices::SoundDeviceManager::getDeviceCount ( ) const

Get the number of connected sound devices.

SoundDeviceID om::sound::devices::SoundDeviceManager::getDeviceID ( Index  deviceIndex) const

Get an identifier for the sound device at the specified index.

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

SoundDeviceID om::sound::devices::SoundDeviceManager::getDefaultInputDeviceID ( ) const

Get an identifier for the default system sound input device.

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

SoundDeviceID om::sound::devices::SoundDeviceManager::getDefaultOutputDeviceID ( ) const

Get an identifier for the default system sound output device.

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

const SoundDeviceManagerDelegate& om::sound::devices::SoundDeviceManager::getDelegate ( ) const
inline

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

void om::sound::devices::SoundDeviceManager::setDelegate ( const SoundDeviceManagerDelegate 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: