Chromium Code Reviews| Index: ppapi/api/ppb_audio_config.idl |
| =================================================================== |
| --- ppapi/api/ppb_audio_config.idl (revision 97869) |
| +++ ppapi/api/ppb_audio_config.idl (working copy) |
| @@ -1,5 +1,5 @@ |
| /* Copyright (c) 2011 The Chromium Authors. All rights reserved. |
|
dmichael (off chromium)
2011/08/24 15:30:42
ppb_audio_config.idl is in this CL, but ppb_audio_
|
| - * Use of this source code is governed by a BSD-style license that can be |
| + * Use of this source cPP_Trueode is governed by a BSD-style license that can be |
| * found in the LICENSE file. |
| */ |
| @@ -72,13 +72,14 @@ |
| * right channel sample. |
| * Data will always be in the native endian format of the platform. |
| * |
| - * @param[in] instance A <code>PP_Instance indentifying</code> one instance |
| + * @param[in] instance A <code>PP_Instance</code> identifying one instance |
| * of a module. |
| * @param[in] sample_rate A P<code>P_AudioSampleRate</code> which is either |
| * <code>PP_AUDIOSAMPLERATE_44100</code> or |
| * <code>PP_AUDIOSAMPLERATE_48000</code>. |
| * @param[in] sample_frame_count A <code>uint32_t</code> frame count returned |
| * from the <code>RecommendSampleFrameCount</code> function. |
| + * |
| * @return A <code>PP_Resource</code> containing the |
| * <code>PPB_Audio_Config</code> if successful or a null resource if the |
| * sample frame count or bit rate are not supported. |
| @@ -107,6 +108,7 @@ |
| * <code>PP_AUDIOSAMPLERATE_48000.</code> |
| * @param[in] requested_sample_frame_count A <code>uint_32t</code> requested |
| * frame count. |
| + * |
| * @return A <code>uint32_t</code> containing the recommended sample frame |
| * count if successful. |
| */ |
| @@ -118,11 +120,12 @@ |
| * IsAudioConfig() determines if the given resource is a |
| * <code>PPB_Audio_Config</code>. |
| * |
| - * @param[in] resource A <code>PP_Resource</code> containing the audio config |
| - * resource. |
| - * @return A <code>PP_BOOL</code> containing <code>PP_TRUE</code> if the given |
| + * @param[in] resource A <code>PP_Resource</code> corresponding to an audio |
| + * config resource. |
| + * |
| + * @return A <code>PP_Bool</code> containing <code>PP_True</code> if the given |
| * resource is an <code>AudioConfig</code> resource, otherwise |
| - * <code>PP_FALSE</code>. |
| + * <code>PP_False</code>. |
| */ |
| PP_Bool IsAudioConfig( |
| [in] PP_Resource resource); |
| @@ -131,8 +134,9 @@ |
| * GetSampleRate() returns the sample rate for the given |
| * <code>PPB_Audio_Config</code>. |
| * |
| - * @param[in] config A <code>PP_Resource</code> containing the |
| + * @param[in] config A <code>PP_Resource</code> corresponding to an |
| * <code>PPB_Audio_Config</code>. |
| + * |
| * @return A <code>PP_AudioSampleRate</code> containing sample rate or |
| * <code>PP_AUDIOSAMPLERATE_NONE</code> if the resource is invalid. |
| */ |
| @@ -143,11 +147,12 @@ |
| * GetSampleFrameCount() returns the sample frame count for the given |
| * <code>PPB_Audio_Config</code>. |
| * |
| - * @param[in] config A <code>PP_Resource</code> containing the audio config |
| - * resource. |
| + * @param[in] config A <code>PP_Resource</code> corresponding to an audio |
| + * config resource. |
| + * |
| * @return A <code>uint32_t</code> containing sample frame count or |
| - * 0 if the resource is invalid. See <code>RecommendSampleFrameCount</code> |
| - * for more on sample frame counts. |
| + * 0 if the resource is invalid. Refer to |
| + * <code>RecommendSampleFrameCount</code> for more on sample frame counts. |
| */ |
| uint32_t GetSampleFrameCount( |
| [in] PP_Resource config); |