Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(336)

Side by Side Diff: ppapi/api/ppb_audio_config.idl

Issue 9288006: Minor changes as per Christians most-recent review of the docs. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src/
Patch Set: '' Created 8 years, 11 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
OLDNEW
1 /* Copyright (c) 2012 The Chromium Authors. All rights reserved. 1 /* Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 * Use of this source code is governed by a BSD-style license that can be 2 * Use of this source code is governed by a BSD-style license that can be
3 * found in the LICENSE file. 3 * found in the LICENSE file.
4 */ 4 */
5 5
6 /** 6 /**
7 * This file defines the PPB_AudioConfig interface for establishing an 7 * This file defines the PPB_AudioConfig interface for establishing an
8 * audio configuration resource within the browser. 8 * audio configuration resource within the browser.
9 */ 9 */
10 10
(...skipping 23 matching lines...) Expand all
34 enum PP_AudioSampleRate { 34 enum PP_AudioSampleRate {
35 PP_AUDIOSAMPLERATE_NONE = 0, 35 PP_AUDIOSAMPLERATE_NONE = 0,
36 PP_AUDIOSAMPLERATE_44100 = 44100, 36 PP_AUDIOSAMPLERATE_44100 = 44100,
37 PP_AUDIOSAMPLERATE_48000 = 48000 37 PP_AUDIOSAMPLERATE_48000 = 48000
38 } ; 38 } ;
39 39
40 40
41 /** 41 /**
42 * The <code>PPB_AudioConfig</code> interface contains pointers to several 42 * The <code>PPB_AudioConfig</code> interface contains pointers to several
43 * functions for establishing your audio configuration within the browser. 43 * functions for establishing your audio configuration within the browser.
44 * This interface only supports stereo * 16bit output. 44 * This interface only supports 16-bit stereo output.
45 * 45 *
46 * Refer to the 46 * Refer to the
47 * <a href="/chrome/nativeclient/docs/audio.html">Pepper 47 * <a href="/chrome/nativeclient/docs/audio.html">Pepper
48 * Audio API</a> for information on using this interface. 48 * Audio API</a> for information on using this interface.
49 */ 49 */
50 [macro="PPB_AUDIO_CONFIG_INTERFACE"] 50 [macro="PPB_AUDIO_CONFIG_INTERFACE"]
51 interface PPB_AudioConfig { 51 interface PPB_AudioConfig {
52 /** 52 /**
53 * CreateStereo16bit() creates a 16 bit audio configuration resource. The 53 * CreateStereo16bit() creates a 16 bit audio configuration resource. The
54 * <code>sample_frame_count</code> should be the result of calling 54 * <code>sample_frame_count</code> should be the result of calling
(...skipping 11 matching lines...) Expand all
66 * <code>buffer16[3]</code> is the second right channel sample. 66 * <code>buffer16[3]</code> is the second right channel sample.
67 * ... 67 * ...
68 * <code>buffer16[2 * (sample_frame_count - 1)]</code> is the last left 68 * <code>buffer16[2 * (sample_frame_count - 1)]</code> is the last left
69 * channel sample. 69 * channel sample.
70 * <code>buffer16[2 * (sample_frame_count - 1) + 1]</code> is the last 70 * <code>buffer16[2 * (sample_frame_count - 1) + 1]</code> is the last
71 * right channel sample. 71 * right channel sample.
72 * Data will always be in the native endian format of the platform. 72 * Data will always be in the native endian format of the platform.
73 * 73 *
74 * @param[in] instance A <code>PP_Instance</code> identifying one instance 74 * @param[in] instance A <code>PP_Instance</code> identifying one instance
75 * of a module. 75 * of a module.
76 * @param[in] sample_rate A P<code>P_AudioSampleRate</code> which is either 76 * @param[in] sample_rate A <code>PP_AudioSampleRate</code> which is either
77 * <code>PP_AUDIOSAMPLERATE_44100</code> or 77 * <code>PP_AUDIOSAMPLERATE_44100</code> or
78 * <code>PP_AUDIOSAMPLERATE_48000</code>. 78 * <code>PP_AUDIOSAMPLERATE_48000</code>.
79 * @param[in] sample_frame_count A <code>uint32_t</code> frame count returned 79 * @param[in] sample_frame_count A <code>uint32_t</code> frame count returned
80 * from the <code>RecommendSampleFrameCount</code> function. 80 * from the <code>RecommendSampleFrameCount</code> function.
81 * 81 *
82 * @return A <code>PP_Resource</code> containing the 82 * @return A <code>PP_Resource</code> containing the
83 * <code>PPB_Audio_Config</code> if successful or a null resource if the 83 * <code>PPB_Audio_Config</code> if successful or a null resource if the
84 * sample frame count or bit rate are not supported. 84 * sample frame count or bit rate are not supported.
85 */ 85 */
86 PP_Resource CreateStereo16Bit( 86 PP_Resource CreateStereo16Bit(
(...skipping 63 matching lines...) Expand 10 before | Expand all | Expand 10 after
150 * config resource. 150 * config resource.
151 * 151 *
152 * @return A <code>uint32_t</code> containing sample frame count or 152 * @return A <code>uint32_t</code> containing sample frame count or
153 * 0 if the resource is invalid. Refer to 153 * 0 if the resource is invalid. Refer to
154 * RecommendSampleFrameCount() for more on sample frame counts. 154 * RecommendSampleFrameCount() for more on sample frame counts.
155 */ 155 */
156 uint32_t GetSampleFrameCount( 156 uint32_t GetSampleFrameCount(
157 [in] PP_Resource config); 157 [in] PP_Resource config);
158 }; 158 };
159 159
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698