summaryrefslogtreecommitdiffstats
path: root/ppapi/cpp/audio_config.h
diff options
context:
space:
mode:
authorelijahtaylor@google.com <elijahtaylor@google.com@0039d316-1c4b-4281-b951-d872f2087c98>2011-06-13 19:35:03 +0000
committerelijahtaylor@google.com <elijahtaylor@google.com@0039d316-1c4b-4281-b951-d872f2087c98>2011-06-13 19:35:03 +0000
commit13db2635927d2df7901243ff24f7b4eb1383f63c (patch)
treea7ea88bd2e56e809c3b05ecb92de05d1dd16a1db /ppapi/cpp/audio_config.h
parent0c96308ca3f7a94b8526c754b36297a3e91c7a58 (diff)
downloadchromium_src-13db2635927d2df7901243ff24f7b4eb1383f63c.zip
chromium_src-13db2635927d2df7901243ff24f7b4eb1383f63c.tar.gz
chromium_src-13db2635927d2df7901243ff24f7b4eb1383f63c.tar.bz2
Remove incorrect comments from the audio config headers.
Currently RecommendSampleFrameCount just clamps the value passed in, so passing in 0 returns the min frame count (64) instead of an actual value recommended by the system. As a note, if/when this behavior changes we'll also need to update the NaCl audio walkthrough doc which details the current behavior. BUG=none TEST=none Review URL: http://codereview.chromium.org/7046115 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@88873 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'ppapi/cpp/audio_config.h')
-rw-r--r--ppapi/cpp/audio_config.h4
1 files changed, 1 insertions, 3 deletions
diff --git a/ppapi/cpp/audio_config.h b/ppapi/cpp/audio_config.h
index e1dce23..64a9773 100644
--- a/ppapi/cpp/audio_config.h
+++ b/ppapi/cpp/audio_config.h
@@ -86,11 +86,9 @@ class AudioConfig : public Resource {
/// @param[in] sample_rate A PP_AudioSampleRate which is either
/// PP_AUDIOSAMPLERATE_44100 or PP_AUDIOSAMPLERATE_48000.
/// @param[in] requested_sample_frame_count A uint_32t requested frame count.
- /// If you pass 0 as the requested sample count, the recommended sample for
- /// the local system is returned.
/// @return A uint32_t containing the recommended sample frame count if
/// successful. If the sample frame count or bit rate is not supported,
- /// this function will fail and 0.
+ /// this function will fail and return 0.
static uint32_t RecommendSampleFrameCount(
PP_AudioSampleRate sample_rate,
uint32_t requested_sample_frame_count);