Config::sound_config Class Reference
sound information More...
#include <Config.h>
Detailed Description
sound information
Definition at line 594 of file Config.h.
Classes | |
| class | streaming_config |
| audio streaming configuration More... | |
Public Types | |
| enum | volume_levels { MUTE = ospkvolinfdB, LOW = ospkvol25dB, MID = ospkvol18dB, HIGH = ospkvol10dB } |
Provides some symbolic volume levels, although values are based on actual volume in decibels. More... | |
Public Member Functions | |
| sound_config (Config *c) | |
| constructor | |
| std::string | makePath (const std::string &name) |
| returns an absolute path if is relative (to root), otherwise just name | |
Public Attributes | |
| Config * | thisconfig |
| pointer back to the containing config object | |
| plist::Primitive< std::string > | root |
| path to sound clips | |
| plist::Primitive< int > | verbose |
| Controls diagnostic information on the console. | |
| plist::NamedEnumeration < volume_levels > | volume |
| volume in decibels - the value is interpreted as a signed short, where 0 is full volume, 0x8000 is mute | |
| plist::Primitive< unsigned int > | sample_rate |
| sample rate to send to system, currently only 8000 or 16000 supported | |
| plist::Primitive< unsigned int > | sample_bits |
| sample bit depth, either 8 or 16 | |
| plist::ArrayOf < plist::Primitive < std::string > > | preload |
| list of sounds to preload at boot | |
| plist::Primitive< float > | pitchConfidenceThreshold |
| confidence threshold required to generate a pitch event [0-1] | |
| Config::sound_config::streaming_config | streaming |
| audio streaming configuration | |
Private Member Functions | |
| sound_config (const sound_config &) | |
| don't call | |
| sound_config & | operator= (const sound_config &) |
| don't call | |
Member Enumeration Documentation
Constructor & Destructor Documentation
| Config::sound_config::sound_config | ( | Config * | c | ) |
| Config::sound_config::sound_config | ( | const sound_config & | ) | [private] |
don't call
Member Function Documentation
| std::string Config::sound_config::makePath | ( | const std::string & | name | ) |
returns an absolute path if is relative (to root), otherwise just name
Definition at line 623 of file Config.h.
Referenced by SoundManager::loadFile(), SoundManager::releaseFile(), and SoundManager::speak().
| sound_config& Config::sound_config::operator= | ( | const sound_config & | ) | [private] |
don't call
Member Data Documentation
confidence threshold required to generate a pitch event [0-1]
Definition at line 650 of file Config.h.
Referenced by PitchDetector::is_pitch(), and sound_config().
| plist::ArrayOf<plist::Primitive<std::string> > Config::sound_config::preload |
list of sounds to preload at boot
Definition at line 649 of file Config.h.
Referenced by sound_config().
| plist::Primitive<std::string> Config::sound_config::root |
path to sound clips
Definition at line 633 of file Config.h.
Referenced by makePath(), and sound_config().
| plist::Primitive<unsigned int> Config::sound_config::sample_bits |
sample bit depth, either 8 or 16
Definition at line 648 of file Config.h.
Referenced by SoundManager::CopyTo(), SoundManager::endPlay(), SoundManager::getRemainTime(), SoundManager::loadBuffer(), SoundManager::loadFile(), sound_config(), and SoundManager::stopPlay().
| plist::Primitive<unsigned int> Config::sound_config::sample_rate |
sample rate to send to system, currently only 8000 or 16000 supported
Definition at line 647 of file Config.h.
Referenced by SoundManager::endPlay(), SoundManager::getRemainTime(), SoundManager::loadFile(), sound_config(), and SoundManager::stopPlay().
audio streaming configuration
Referenced by sound_config().
pointer back to the containing config object
Definition at line 632 of file Config.h.
Referenced by makePath().
Controls diagnostic information on the console.
0 - none
1 - report when sounds begin to play
2 - also report when sounds finish playing
3- also report when sounds are preloaded and released
Definition at line 640 of file Config.h.
Referenced by SoundManager::loadFile(), SoundManager::playFile(), SoundManager::release(), sound_config(), and SoundManager::stopPlay().
volume in decibels - the value is interpreted as a signed short, where 0 is full volume, 0x8000 is mute
Definition at line 645 of file Config.h.
Referenced by SoundManager::CopyTo(), and sound_config().
The documentation for this class was generated from the following file:
