aboutsummaryrefslogtreecommitdiff
path: root/common
diff options
context:
space:
mode:
authorMax Horn2004-11-27 15:58:18 +0000
committerMax Horn2004-11-27 15:58:18 +0000
commitba74a8e7f657cf795046a5cf6a7ead701fd4194e (patch)
tree0d05c0dfa38e10542ca83ffeeb37ddd782c56ef7 /common
parentb78ac6a18b2cb851718ef84b04557f7fba8d399a (diff)
downloadscummvm-rg350-ba74a8e7f657cf795046a5cf6a7ead701fd4194e.tar.gz
scummvm-rg350-ba74a8e7f657cf795046a5cf6a7ead701fd4194e.tar.bz2
scummvm-rg350-ba74a8e7f657cf795046a5cf6a7ead701fd4194e.zip
Added some more mixer doxygen docs; cleaned up Mixer API a bit, removing some very specialised methods
svn-id: r15914
Diffstat (limited to 'common')
-rw-r--r--common/system.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/common/system.h b/common/system.h
index da2c0fde5c..63e642a34c 100644
--- a/common/system.h
+++ b/common/system.h
@@ -569,6 +569,8 @@ public:
/**
* Determine the output sample rate. Audio data provided by the sound
* callback will be played using this rate.
+ * @note Client code other than the sound mixer should _not_ use this
+ * method. Instead, call SoundMixer::getOutputRate()!
* @return the output sample rate
*/
virtual int getOutputSampleRate() const = 0;