src/native_client_sdk/doc_generated/pepper_dev/c/struct_p_p_b___audio_frame__0__1.html

   1 {{+bindTo:partials.standard_nacl_article}}
   2 <h1>PPB_AudioFrame Struct Reference</h1>
   3 <div id="doxygen-ref">
   4 {{- dummy div to appease doxygen -}}
   5   <div>
   6 <!-- Generated by Doxygen 1.7.6.1 -->
   7
   8
   9 </div>
  10 <!--header-->
  11 <div class="contents">
  12 <!-- doxytag: class="PPB_AudioFrame" --><h2>
  13 Data Fields</h2><table class="memberdecls">
  14
  15 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___audio_frame__0__1.html#a47061a145f5fa7511cad2b65e6c7f0a6">IsAudioFrame</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource)</td></tr>
  16 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___typedefs.html#ga3962a5355895925a757f613567e422fa">PP_TimeDelta</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___audio_frame__0__1.html#a64d5acceb403c808b63b17090c7321b8">GetTimestamp</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> frame)</td></tr>
  17 <tr><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___audio_frame__0__1.html#a58b693627085d79c202146b2937b9811">SetTimestamp</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> frame, <a class="el" href="group___typedefs.html#ga3962a5355895925a757f613567e422fa">PP_TimeDelta</a> timestamp)</td></tr>
  18 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga971dbd9c541225dde753fb3ede7aac6a">PP_AudioFrame_SampleSize</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___audio_frame__0__1.html#a9fbb4974a6b2f317469a873a330df339">GetSampleSize</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> frame)</td></tr>
  19 <tr><td class="memItemLeft" align="right" valign="top">uint32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___audio_frame__0__1.html#abc3b6c3ec27bb3653f9d2ec6e91a13c7">GetNumberOfChannels</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> frame)</td></tr>
  20 <tr><td class="memItemLeft" align="right" valign="top">uint32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___audio_frame__0__1.html#ad0f46ad3beaa6146f9785d39ade2e4b3">GetNumberOfSamples</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> frame)</td></tr>
  21 <tr><td class="memItemLeft" align="right" valign="top">void *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___audio_frame__0__1.html#aa07fd4a8cefea92d3c922221aefe414f">GetDataBuffer</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> frame)</td></tr>
  22 <tr><td class="memItemLeft" align="right" valign="top">uint32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___audio_frame__0__1.html#a8ded1473451dc73b9c2d6bd33eb8863c">GetDataBufferSize</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> frame)</td></tr>
  23 </table>
  24 <hr /><h2>Field Documentation</h2>
  25 <a class="anchor" id="aa07fd4a8cefea92d3c922221aefe414f"></a><!-- doxytag: member="PPB_AudioFrame::GetDataBuffer" ref="aa07fd4a8cefea92d3c922221aefe414f" args=")(PP_Resource frame)" -->
  26 <div class="memitem">
  27 <div class="memproto">
  28 <table class="memname">
  29 <tr>
  30 <td class="memname">void*(* <a class="el" href="struct_p_p_b___audio_frame__0__1.html#aa07fd4a8cefea92d3c922221aefe414f">PPB_AudioFrame::GetDataBuffer</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> frame)</td>
  31 </tr>
  32 </table>
  33 </div>
  34 <div class="memdoc">
  35 <p>Gets the data buffer containing the audio frame samples. </p>
  36 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  37 <table class="params">
  38 <tr><td class="paramdir">[in]</td><td class="paramname">frame</td><td>A <code>PP_Resource</code> corresponding to an audio frame resource.</td></tr>
  39 </table>
  40 </dd>
  41 </dl>
  42 <dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the beginning of the data buffer. </dd></dl>
  43 </div>
  44 </div>
  45 <a class="anchor" id="a8ded1473451dc73b9c2d6bd33eb8863c"></a><!-- doxytag: member="PPB_AudioFrame::GetDataBufferSize" ref="a8ded1473451dc73b9c2d6bd33eb8863c" args=")(PP_Resource frame)" -->
  46 <div class="memitem">
  47 <div class="memproto">
  48 <table class="memname">
  49 <tr>
  50 <td class="memname">uint32_t(* <a class="el" href="struct_p_p_b___audio_frame__0__1.html#a8ded1473451dc73b9c2d6bd33eb8863c">PPB_AudioFrame::GetDataBufferSize</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> frame)</td>
  51 </tr>
  52 </table>
  53 </div>
  54 <div class="memdoc">
  55 <p>Gets the size of the data buffer in bytes. </p>
  56 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  57 <table class="params">
  58 <tr><td class="paramdir">[in]</td><td class="paramname">frame</td><td>A <code>PP_Resource</code> corresponding to an audio frame resource.</td></tr>
  59 </table>
  60 </dd>
  61 </dl>
  62 <dl class="return"><dt><b>Returns:</b></dt><dd>The size of the data buffer in bytes. </dd></dl>
  63 </div>
  64 </div>
  65 <a class="anchor" id="abc3b6c3ec27bb3653f9d2ec6e91a13c7"></a><!-- doxytag: member="PPB_AudioFrame::GetNumberOfChannels" ref="abc3b6c3ec27bb3653f9d2ec6e91a13c7" args=")(PP_Resource frame)" -->
  66 <div class="memitem">
  67 <div class="memproto">
  68 <table class="memname">
  69 <tr>
  70 <td class="memname">uint32_t(* <a class="el" href="struct_p_p_b___audio_frame__0__1.html#abc3b6c3ec27bb3653f9d2ec6e91a13c7">PPB_AudioFrame::GetNumberOfChannels</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> frame)</td>
  71 </tr>
  72 </table>
  73 </div>
  74 <div class="memdoc">
  75 <p>Gets the number of channels in the audio frame. </p>
  76 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  77 <table class="params">
  78 <tr><td class="paramdir">[in]</td><td class="paramname">frame</td><td>A <code>PP_Resource</code> corresponding to an audio frame resource.</td></tr>
  79 </table>
  80 </dd>
  81 </dl>
  82 <dl class="return"><dt><b>Returns:</b></dt><dd>The number of channels in the audio frame. </dd></dl>
  83 </div>
  84 </div>
  85 <a class="anchor" id="ad0f46ad3beaa6146f9785d39ade2e4b3"></a><!-- doxytag: member="PPB_AudioFrame::GetNumberOfSamples" ref="ad0f46ad3beaa6146f9785d39ade2e4b3" args=")(PP_Resource frame)" -->
  86 <div class="memitem">
  87 <div class="memproto">
  88 <table class="memname">
  89 <tr>
  90 <td class="memname">uint32_t(* <a class="el" href="struct_p_p_b___audio_frame__0__1.html#ad0f46ad3beaa6146f9785d39ade2e4b3">PPB_AudioFrame::GetNumberOfSamples</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> frame)</td>
  91 </tr>
  92 </table>
  93 </div>
  94 <div class="memdoc">
  95 <p>Gets the number of samples in the audio frame. </p>
  96 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  97 <table class="params">
  98 <tr><td class="paramdir">[in]</td><td class="paramname">frame</td><td>A <code>PP_Resource</code> corresponding to an audio frame resource.</td></tr>
  99 </table>
 100 </dd>
 101 </dl>
 102 <dl class="return"><dt><b>Returns:</b></dt><dd>The number of samples in the audio frame. For example, at a sampling rate of 44,100 Hz in stereo audio, a frame containing 4410 * 2 samples would have a duration of 100 milliseconds. </dd></dl>
 103 </div>
 104 </div>
 105 <a class="anchor" id="a9fbb4974a6b2f317469a873a330df339"></a><!-- doxytag: member="PPB_AudioFrame::GetSampleSize" ref="a9fbb4974a6b2f317469a873a330df339" args=")(PP_Resource frame)" -->
 106 <div class="memitem">
 107 <div class="memproto">
 108 <table class="memname">
 109 <tr>
 110 <td class="memname"><a class="el" href="group___enums.html#ga971dbd9c541225dde753fb3ede7aac6a">PP_AudioFrame_SampleSize</a>(* <a class="el" href="struct_p_p_b___audio_frame__0__1.html#a9fbb4974a6b2f317469a873a330df339">PPB_AudioFrame::GetSampleSize</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> frame)</td>
 111 </tr>
 112 </table>
 113 </div>
 114 <div class="memdoc">
 115 <p>Gets the sample size of the audio frame. </p>
 116 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 117 <table class="params">
 118 <tr><td class="paramdir">[in]</td><td class="paramname">frame</td><td>A <code>PP_Resource</code> corresponding to an audio frame resource.</td></tr>
 119 </table>
 120 </dd>
 121 </dl>
 122 <dl class="return"><dt><b>Returns:</b></dt><dd>The sample size of the audio frame. </dd></dl>
 123 </div>
 124 </div>
 125 <a class="anchor" id="a64d5acceb403c808b63b17090c7321b8"></a><!-- doxytag: member="PPB_AudioFrame::GetTimestamp" ref="a64d5acceb403c808b63b17090c7321b8" args=")(PP_Resource frame)" -->
 126 <div class="memitem">
 127 <div class="memproto">
 128 <table class="memname">
 129 <tr>
 130 <td class="memname"><a class="el" href="group___typedefs.html#ga3962a5355895925a757f613567e422fa">PP_TimeDelta</a>(* <a class="el" href="struct_p_p_b___audio_frame__0__1.html#a64d5acceb403c808b63b17090c7321b8">PPB_AudioFrame::GetTimestamp</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> frame)</td>
 131 </tr>
 132 </table>
 133 </div>
 134 <div class="memdoc">
 135 <p>Gets the timestamp of the audio frame. </p>
 136 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 137 <table class="params">
 138 <tr><td class="paramdir">[in]</td><td class="paramname">frame</td><td>A <code>PP_Resource</code> corresponding to an audio frame resource.</td></tr>
 139 </table>
 140 </dd>
 141 </dl>
 142 <dl class="return"><dt><b>Returns:</b></dt><dd>A <code>PP_TimeDelta</code> containing the timestamp of the audio frame. Given in seconds since the start of the containing audio stream. </dd></dl>
 143 </div>
 144 </div>
 145 <a class="anchor" id="a47061a145f5fa7511cad2b65e6c7f0a6"></a><!-- doxytag: member="PPB_AudioFrame::IsAudioFrame" ref="a47061a145f5fa7511cad2b65e6c7f0a6" args=")(PP_Resource resource)" -->
 146 <div class="memitem">
 147 <div class="memproto">
 148 <table class="memname">
 149 <tr>
 150 <td class="memname"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* <a class="el" href="struct_p_p_b___audio_frame__0__1.html#a47061a145f5fa7511cad2b65e6c7f0a6">PPB_AudioFrame::IsAudioFrame</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource)</td>
 151 </tr>
 152 </table>
 153 </div>
 154 <div class="memdoc">
 155 <p>Determines if a resource is an AudioFrame resource. </p>
 156 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 157 <table class="params">
 158 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>The <code>PP_Resource</code> to test.</td></tr>
 159 </table>
 160 </dd>
 161 </dl>
 162 <dl class="return"><dt><b>Returns:</b></dt><dd>A <code>PP_Bool</code> with <code>PP_TRUE</code> if the given resource is an AudioFrame resource or <code>PP_FALSE</code> otherwise. </dd></dl>
 163 </div>
 164 </div>
 165 <a class="anchor" id="a58b693627085d79c202146b2937b9811"></a><!-- doxytag: member="PPB_AudioFrame::SetTimestamp" ref="a58b693627085d79c202146b2937b9811" args=")(PP_Resource frame, PP_TimeDelta timestamp)" -->
 166 <div class="memitem">
 167 <div class="memproto">
 168 <table class="memname">
 169 <tr>
 170 <td class="memname">void(* <a class="el" href="struct_p_p_b___audio_frame__0__1.html#a58b693627085d79c202146b2937b9811">PPB_AudioFrame::SetTimestamp</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> frame, <a class="el" href="group___typedefs.html#ga3962a5355895925a757f613567e422fa">PP_TimeDelta</a> timestamp)</td>
 171 </tr>
 172 </table>
 173 </div>
 174 <div class="memdoc">
 175 <p>Sets the timestamp of the audio frame. </p>
 176 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 177 <table class="params">
 178 <tr><td class="paramdir">[in]</td><td class="paramname">frame</td><td>A <code>PP_Resource</code> corresponding to an audio frame resource. </td></tr>
 179 <tr><td class="paramdir">[in]</td><td class="paramname">timestamp</td><td>A <code>PP_TimeDelta</code> containing the timestamp of the audio frame. Given in seconds since the start of the containing audio stream. </td></tr>
 180 </table>
 181 </dd>
 182 </dl>
 183 </div>
 184 </div>
 185 <hr />The documentation for this struct was generated from the following file:<ul>
 186 <li><a class="el" href="ppb__audio__frame_8h.html">ppb_audio_frame.h</a></li>
 187 </ul>
 188 </div><!-- contents -->
 189 </div>
 190 {{/partials.standard_nacl_article}}