Homepage Demos Overview Downloads Tutorials Reference
Credits

Config::sound_config Struct Reference

#include <Config.h>

List of all members.


Detailed Description

sound information

Definition at line 178 of file Config.h.

Public Member Functions

std::string makePath (const std::string &name)
 returns an absolute path if is relative (to root), otherwise just name
 sound_config ()
 constructor

Public Attributes

std::string root
 path to sound clips
unsigned int volume
 volume in decibels - the value is interpreted as a signed short, where 0 is full volume, 0x8000 is mute
unsigned int sample_rate
 sample rate to send to system, currently only 8000 or 16000 supported
unsigned int sample_bits
 sample bit depth, either 8 or 16
std::vector< std::string > preload
 list of sounds to preload at boot


Constructor & Destructor Documentation

Config::sound_config::sound_config  )  [inline]
 

constructor

Definition at line 196 of file Config.h.


Member Function Documentation

std::string Config::sound_config::makePath const std::string &  name  )  [inline]
 

returns an absolute path if is relative (to root), otherwise just name

Definition at line 186 of file Config.h.

Referenced by SoundManager::LoadFile(), and SoundManager::lookupPath().


Member Data Documentation

std::vector<std::string> Config::sound_config::preload
 

list of sounds to preload at boot

Definition at line 183 of file Config.h.

Referenced by SoundPlay::DoDestroy(), SoundPlay::DoInit(), and Config::setValue().

std::string Config::sound_config::root
 

path to sound clips

Definition at line 179 of file Config.h.

Referenced by Config::setValue().

unsigned int Config::sound_config::sample_bits
 

sample bit depth, either 8 or 16

Definition at line 182 of file Config.h.

Referenced by SoundManager::CopyTo(), SoundManager::endPlay(), SoundManager::GetRemainTime(), SoundManager::LoadBuffer(), SoundManager::LoadFile(), SoundPlay::NewSoundVectorData(), SoundPlay::SetPowerAndVolume(), Config::setValue(), and SoundManager::StopPlay().

unsigned int Config::sound_config::sample_rate
 

sample rate to send to system, currently only 8000 or 16000 supported

Definition at line 181 of file Config.h.

Referenced by SoundManager::endPlay(), SoundManager::GetRemainTime(), SoundManager::LoadFile(), SoundPlay::NewSoundVectorData(), SoundPlay::SetPowerAndVolume(), Config::setValue(), and SoundManager::StopPlay().

unsigned int Config::sound_config::volume
 

volume in decibels - the value is interpreted as a signed short, where 0 is full volume, 0x8000 is mute

Definition at line 180 of file Config.h.

Referenced by SoundPlay::SetPowerAndVolume(), and Config::setValue().


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

Tekkotsu v2.2
Generated Tue Oct 19 14:20:15 2004 by Doxygen 1.3.9.1