irrklang::ISoundDeviceList Class Reference

A list of sound devices for a sound driver. Use irrklang::createSoundDeviceList() to create this list. More...

#include <ik_ISoundDeviceList.h>

Inheritance diagram for irrklang::ISoundDeviceList:
irrklang::IRefCounted

List of all members.

Public Member Functions

virtual ik_s32 getDeviceCount ()=0
 Returns amount of enumerated devices in the list.
virtual const char * getDeviceID (ik_s32 index)=0
 Returns the ID of the device. Use this string to identify this device in createIrrKlangDevice().
virtual const char * getDeviceDescription (ik_s32 index)=0
 Returns description of the device.

Detailed Description

A list of sound devices for a sound driver. Use irrklang::createSoundDeviceList() to create this list.

The function createIrrKlangDevice() has a parameter 'deviceID' which takes the value returned by ISoundDeviceList::getDeviceID() and uses that device then. The list of devices in ISoundDeviceList usually also includes the default device which is the first entry and has an empty deviceID string ("") and the description "default device". There is some example code on how to use the ISoundDeviceList in Enumerating sound devices.


Member Function Documentation

virtual ik_s32 irrklang::ISoundDeviceList::getDeviceCount (  )  [pure virtual]

Returns amount of enumerated devices in the list.

virtual const char* irrklang::ISoundDeviceList::getDeviceDescription ( ik_s32  index  )  [pure virtual]

Returns description of the device.

Parameters:
index Index of the device, a value between 0 and ISoundDeviceList::getDeviceCount()-1.
virtual const char* irrklang::ISoundDeviceList::getDeviceID ( ik_s32  index  )  [pure virtual]

Returns the ID of the device. Use this string to identify this device in createIrrKlangDevice().

Parameters:
index Index of the device, a value between 0 and ISoundDeviceList::getDeviceCount()-1.
Returns:
Returns a pointer to a string identifying the device. The string will only as long valid as long as the ISoundDeviceList exists.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines

irrKlang Audio Library
The irrKlang Engine Documentation © 2003-2014 by Nikolaus Gebhardt. Generated by Doxygen (1.6.1)