src/ppapi/api/ppb_audio_frame.idl

   1 /* Copyright 2014 The Chromium Authors. All rights reserved.
   2  * Use of this source code is governed by a BSD-style license that can be
   3  * found in the LICENSE file.
   4  */
   5
   6 /**
   7  * Defines the <code>PPB_AudioFrame</code> interface.
   8  */
   9
  10 [generate_thunk]
  11
  12 label Chrome {
  13   [channel=dev] M34 = 0.1
  14 };
  15
  16 /**
  17  * PP_AudioFrame_SampleRate is an enumeration of the different audio sample
  18  * rates.
  19  */
  20 enum PP_AudioFrame_SampleRate {
  21   PP_AUDIOFRAME_SAMPLERATE_UNKNOWN = 0,
  22   PP_AUDIOFRAME_SAMPLERATE_44100 = 44100
  23 };
  24
  25 /**
  26  * PP_AudioFrame_SampleSize is an enumeration of the different audio sample
  27  * sizes.
  28  */
  29 enum PP_AudioFrame_SampleSize {
  30   PP_AUDIOFRAME_SAMPLESIZE_UNKNOWN = 0,
  31   PP_AUDIOFRAME_SAMPLESIZE_16_BITS = 2
  32 };
  33
  34 interface PPB_AudioFrame {
  35   /**
  36    * Determines if a resource is an AudioFrame resource.
  37    *
  38    * @param[in] resource The <code>PP_Resource</code> to test.
  39    *
  40    * @return A <code>PP_Bool</code> with <code>PP_TRUE</code> if the given
  41    * resource is an AudioFrame resource or <code>PP_FALSE</code> otherwise.
  42    */
  43   PP_Bool IsAudioFrame([in] PP_Resource resource);
  44
  45   /**
  46    * Gets the timestamp of the audio frame.
  47    *
  48    * @param[in] frame A <code>PP_Resource</code> corresponding to an audio frame
  49    * resource.
  50    *
  51    * @return A <code>PP_TimeDelta</code> containing the timestamp of the audio
  52    * frame. Given in seconds since the start of the containing audio stream.
  53    */
  54   [on_failure=0.0]
  55   PP_TimeDelta GetTimestamp([in] PP_Resource frame);
  56
  57   /**
  58    * Sets the timestamp of the audio frame.
  59    *
  60    * @param[in] frame A <code>PP_Resource</code> corresponding to an audio frame
  61    * resource.
  62    * @param[in] timestamp A <code>PP_TimeDelta</code> containing the timestamp
  63    * of the audio frame. Given in seconds since the start of the containing
  64    * audio stream.
  65    */
  66   void SetTimestamp([in] PP_Resource frame, [in] PP_TimeDelta timestamp);
  67
  68   /**
  69    * Gets the sample size of the audio frame.
  70    *
  71    * @param[in] frame A <code>PP_Resource</code> corresponding to an audio frame
  72    * resource.
  73    *
  74    * @return The sample size of the audio frame.
  75    */
  76   [on_failure=PP_AUDIOFRAME_SAMPLESIZE_UNKNOWN]
  77   PP_AudioFrame_SampleSize GetSampleSize([in] PP_Resource frame);
  78
  79   /**
  80    * Gets the number of channels in the audio frame.
  81    *
  82    * @param[in] frame A <code>PP_Resource</code> corresponding to an audio frame
  83    * resource.
  84    *
  85    * @return The number of channels in the audio frame.
  86    */
  87   uint32_t GetNumberOfChannels([in] PP_Resource frame);
  88
  89   /**
  90    * Gets the number of samples in the audio frame.
  91    *
  92    * @param[in] frame A <code>PP_Resource</code> corresponding to an audio frame
  93    * resource.
  94    *
  95    * @return The number of samples in the audio frame.
  96    * For example, at a sampling rate of 44,100 Hz in stereo audio, a frame
  97    * containing 4410 * 2 samples would have a duration of 100 milliseconds.
  98    */
  99   uint32_t GetNumberOfSamples([in] PP_Resource frame);
 100
 101   /**
 102    * Gets the data buffer containing the audio frame samples.
 103    *
 104    * @param[in] frame A <code>PP_Resource</code> corresponding to an audio frame
 105    * resource.
 106    *
 107    * @return A pointer to the beginning of the data buffer.
 108    */
 109   mem_t GetDataBuffer([in] PP_Resource frame);
 110
 111   /**
 112    * Gets the size of the data buffer in bytes.
 113    *
 114    * @param[in] frame A <code>PP_Resource</code> corresponding to an audio frame
 115    * resource.
 116    *
 117    * @return The size of the data buffer in bytes.
 118    */
 119   uint32_t GetDataBufferSize([in] PP_Resource frame);
 120 };