Index: ppapi/api/ppb_audio_buffer.idl |
diff --git a/ppapi/api/ppb_audio_buffer.idl b/ppapi/api/ppb_audio_buffer.idl |
new file mode 100644 |
index 0000000000000000000000000000000000000000..6d8fa6389f69fd82c37bf1e8ac14cb3f25328795 |
--- /dev/null |
+++ b/ppapi/api/ppb_audio_buffer.idl |
@@ -0,0 +1,132 @@ |
+/* Copyright 2014 The Chromium Authors. All rights reserved. |
+ * Use of this source code is governed by a BSD-style license that can be |
+ * found in the LICENSE file. |
+ */ |
+ |
+/** |
+ * Defines the <code>PPB_AudioBuffer</code> interface. |
+ */ |
+ |
+[generate_thunk] |
+ |
+label Chrome { |
+ [channel=dev] M34 = 0.1 |
+}; |
+ |
+/** |
+ * PP_AudioBuffer_SampleRate is an enumeration of the different audio sample |
+ * rates. |
+ */ |
+enum PP_AudioBuffer_SampleRate { |
+ PP_AUDIOBUFFER_SAMPLERATE_UNKNOWN = 0, |
+ PP_AUDIOBUFFER_SAMPLERATE_8000 = 8000, |
+ PP_AUDIOBUFFER_SAMPLERATE_44100 = 44100 |
+}; |
+ |
+/** |
+ * PP_AudioBuffer_SampleSize is an enumeration of the different audio sample |
+ * sizes. |
+ */ |
+enum PP_AudioBuffer_SampleSize { |
+ PP_AUDIOBUFFER_SAMPLESIZE_UNKNOWN = 0, |
+ PP_AUDIOBUFFER_SAMPLESIZE_16_BITS = 2 |
+}; |
+ |
+interface PPB_AudioBuffer { |
+ /** |
+ * Determines if a resource is an AudioBuffer resource. |
+ * |
+ * @param[in] resource The <code>PP_Resource</code> to test. |
+ * |
+ * @return A <code>PP_Bool</code> with <code>PP_TRUE</code> if the given |
+ * resource is an AudioBuffer resource or <code>PP_FALSE</code> otherwise. |
+ */ |
+ PP_Bool IsAudioBuffer([in] PP_Resource resource); |
+ |
+ /** |
+ * Gets the timestamp of the audio buffer. |
+ * |
+ * @param[in] buffer A <code>PP_Resource</code> corresponding to an audio |
+ * buffer resource. |
+ * |
+ * @return A <code>PP_TimeDelta</code> containing the timestamp of the audio |
+ * buffer. Given in seconds since the start of the containing audio stream. |
+ */ |
+ [on_failure=0.0] |
+ PP_TimeDelta GetTimestamp([in] PP_Resource buffer); |
+ |
+ /** |
+ * Sets the timestamp of the audio buffer. |
+ * |
+ * @param[in] buffer A <code>PP_Resource</code> corresponding to an audio |
+ * buffer resource. |
+ * @param[in] timestamp A <code>PP_TimeDelta</code> containing the timestamp |
+ * of the audio buffer. Given in seconds since the start of the containing |
+ * audio stream. |
+ */ |
+ void SetTimestamp([in] PP_Resource buffer, [in] PP_TimeDelta timestamp); |
+ |
+ /** |
+ * Gets the sample rate of the audio buffer. |
+ * |
+ * @param[in] buffer A <code>PP_Resource</code> corresponding to an audio |
+ * buffer resource. |
+ * |
+ * @return The sample rate of the audio buffer. |
+ */ |
+ [on_failure=PP_AUDIOBUFFER_SAMPLERATE_UNKNOWN] |
+ PP_AudioBuffer_SampleRate GetSampleRate([in] PP_Resource buffer); |
+ |
+ /** |
+ * Gets the sample size of the audio buffer. |
+ * |
+ * @param[in] buffer A <code>PP_Resource</code> corresponding to an audio |
+ * buffer resource. |
+ * |
+ * @return The sample size of the audio buffer. |
+ */ |
+ [on_failure=PP_AUDIOBUFFER_SAMPLESIZE_UNKNOWN] |
+ PP_AudioBuffer_SampleSize GetSampleSize([in] PP_Resource buffer); |
+ |
+ /** |
+ * Gets the number of channels in the audio buffer. |
+ * |
+ * @param[in] buffer A <code>PP_Resource</code> corresponding to an audio |
+ * buffer resource. |
+ * |
+ * @return The number of channels in the audio buffer. |
+ */ |
+ uint32_t GetNumberOfChannels([in] PP_Resource buffer); |
+ |
+ /** |
+ * Gets the number of samples in the audio buffer. |
+ * |
+ * @param[in] buffer A <code>PP_Resource</code> corresponding to an audio |
+ * buffer resource. |
+ * |
+ * @return The number of samples in the audio buffer. |
+ * For example, at a sampling rate of 44,100 Hz in stereo audio, a buffer |
+ * containing 4410 * 2 samples would have a duration of 100 milliseconds. |
+ */ |
+ uint32_t GetNumberOfSamples([in] PP_Resource buffer); |
+ |
+ /** |
+ * Gets the data buffer containing the audio samples. |
+ * |
+ * @param[in] buffer A <code>PP_Resource</code> corresponding to an audio |
+ * buffer resource. |
+ * |
+ * @return A pointer to the beginning of the data buffer. |
+ */ |
+ mem_t GetDataBuffer([in] PP_Resource buffer); |
+ |
+ /** |
+ * Gets the size of the data buffer in bytes. |
+ * |
+ * @param[in] buffer A <code>PP_Resource</code> corresponding to an audio |
+ * buffer resource. |
+ * |
+ * @return The size of the data buffer in bytes. |
+ */ |
+ uint32_t GetDataBufferSize([in] PP_Resource buffer); |
+}; |