src/native_client_sdk/doc_generated/pepper_beta/cpp/classpp_1_1_audio_buffer.html

   1 {{+bindTo:partials.standard_nacl_api}}
   2 <h1>pp::AudioBuffer Class 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
  10 </div>
  11 <!--header-->
  12 <div class="contents">
  13 <!-- doxytag: class="pp::AudioBuffer" --><!-- doxytag: inherits="pp::Resource" --><div class="dynheader">
  14 Inheritance diagram for pp::AudioBuffer:</div>
  15 <div class="dyncontent">
  16 <div class="center"><img src="classpp_1_1_audio_buffer__inherit__graph.png" border="0" usemap="#pp_1_1_audio_buffer_inherit__map" alt="Inheritance graph" /></div>
  17 <map name="pp_1_1_audio_buffer_inherit__map" id="pp_1_1_audio_buffer_inherit__map">
  18 <area shape="rect" id="node2" href="classpp_1_1_resource.html" title="A reference counted module resource." alt="" coords="13,5,117,32"></area></map>
  19 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  20 <p><a href="classpp_1_1_audio_buffer-members.html">List of all members.</a></p>
  21 <h2>
  22 Public Member Functions</h2><table class="memberdecls">
  23
  24 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_audio_buffer.html#ae5a21e1df405d530d9280de36791dbbf">AudioBuffer</a> ()</td></tr>
  25 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_audio_buffer.html#a8f51aeb6d98ff9d926ee1e2fcee4f712">AudioBuffer</a> (const <a class="el" href="classpp_1_1_audio_buffer.html">AudioBuffer</a> &amp;other)</td></tr>
  26 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_audio_buffer.html#a96db6e6a05eb834ed8b04ef8c3f6647a">AudioBuffer</a> (const <a class="el" href="classpp_1_1_resource.html">Resource</a> &amp;resource)</td></tr>
  27 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_audio_buffer.html#ad80595164aba1e9fbe1ccc71793c48f9">AudioBuffer</a> (<a class="el" href="namespacepp.html#a339083c1beec620267bf8b3c55decaa5">PassRef</a>, PP_Resource resource)</td></tr>
  28 <tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_audio_buffer.html#aa47da494df014dd6dba16053f914ce34">~AudioBuffer</a> ()</td></tr>
  29 <tr><td class="memItemLeft" align="right" valign="top">PP_TimeDelta&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_audio_buffer.html#a08f55c4a972677114bb0c0e1ceb13661">GetTimestamp</a> () const </td></tr>
  30 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_audio_buffer.html#a2882ec7147f4efddf3cefc6378f11f78">SetTimestamp</a> (PP_TimeDelta timestamp)</td></tr>
  31 <tr><td class="memItemLeft" align="right" valign="top">PP_AudioBuffer_SampleRate&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_audio_buffer.html#a650c3a1abc424e21fa56997c9d55b76f">GetSampleRate</a> () const </td></tr>
  32 <tr><td class="memItemLeft" align="right" valign="top">PP_AudioBuffer_SampleSize&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_audio_buffer.html#ac3846435b70b49392dec120716e0cfd5">GetSampleSize</a> () const </td></tr>
  33 <tr><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_audio_buffer.html#a3061bf5fc031ad6854d2b06ef6f6736a">GetNumberOfChannels</a> () const </td></tr>
  34 <tr><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_audio_buffer.html#ad588d83a59d151fb8448ea59f6f9039e">GetNumberOfSamples</a> () const </td></tr>
  35 <tr><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_audio_buffer.html#aad0cdf64f6fc99ebbad26725ba17df65">GetDataBuffer</a> ()</td></tr>
  36 <tr><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_audio_buffer.html#a5548630a163439b2c811ab40d7cd64a0">GetDataBufferSize</a> () const </td></tr>
  37 </table>
  38 <hr /><h2>Constructor &amp; Destructor Documentation</h2>
  39 <a class="anchor" id="ae5a21e1df405d530d9280de36791dbbf"></a><!-- doxytag: member="pp::AudioBuffer::AudioBuffer" ref="ae5a21e1df405d530d9280de36791dbbf" args="()" -->
  40 <div class="memitem">
  41 <div class="memproto">
  42 <table class="memname">
  43 <tr>
  44 <td class="memname"><a class="el" href="classpp_1_1_audio_buffer.html#ae5a21e1df405d530d9280de36791dbbf">pp::AudioBuffer::AudioBuffer</a> </td>
  45 <td>(</td>
  46 <td class="paramname"></td><td>)</td>
  47 <td></td>
  48 </tr>
  49 </table>
  50 </div>
  51 <div class="memdoc">
  52 <p>Default constructor for creating an <a class="el" href="classpp_1_1_resource.html#a859068e34cdc2dc0b78754c255323aa9" title="This functions determines if this resource is invalid or uninitialized.">is_null()</a> <code><a class="el" href="classpp_1_1_audio_buffer.html">AudioBuffer</a></code> object. </p>
  53 </div>
  54 </div>
  55 <a class="anchor" id="a8f51aeb6d98ff9d926ee1e2fcee4f712"></a><!-- doxytag: member="pp::AudioBuffer::AudioBuffer" ref="a8f51aeb6d98ff9d926ee1e2fcee4f712" args="(const AudioBuffer &amp;other)" -->
  56 <div class="memitem">
  57 <div class="memproto">
  58 <table class="memname">
  59 <tr>
  60 <td class="memname"><a class="el" href="classpp_1_1_audio_buffer.html#ae5a21e1df405d530d9280de36791dbbf">pp::AudioBuffer::AudioBuffer</a> </td>
  61 <td>(</td>
  62 <td class="paramtype">const <a class="el" href="classpp_1_1_audio_buffer.html">AudioBuffer</a> &amp;&#160;</td>
  63 <td class="paramname"><em>other</em></td><td>)</td>
  64 <td></td>
  65 </tr>
  66 </table>
  67 </div>
  68 <div class="memdoc">
  69 <p>The copy constructor for <code><a class="el" href="classpp_1_1_audio_buffer.html">AudioBuffer</a></code>. </p>
  70 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  71 <table class="params">
  72 <tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>A reference to an <code><a class="el" href="classpp_1_1_audio_buffer.html">AudioBuffer</a></code>. </td></tr>
  73 </table>
  74 </dd>
  75 </dl>
  76 </div>
  77 </div>
  78 <a class="anchor" id="a96db6e6a05eb834ed8b04ef8c3f6647a"></a><!-- doxytag: member="pp::AudioBuffer::AudioBuffer" ref="a96db6e6a05eb834ed8b04ef8c3f6647a" args="(const Resource &amp;resource)" -->
  79 <div class="memitem">
  80 <div class="memproto">
  81 <table class="memname">
  82 <tr>
  83 <td class="memname"><a class="el" href="classpp_1_1_audio_buffer.html#ae5a21e1df405d530d9280de36791dbbf">pp::AudioBuffer::AudioBuffer</a> </td>
  84 <td>(</td>
  85 <td class="paramtype">const <a class="el" href="classpp_1_1_resource.html">Resource</a> &amp;&#160;</td>
  86 <td class="paramname"><em>resource</em></td><td>)</td>
  87 <td><code> [explicit]</code></td>
  88 </tr>
  89 </table>
  90 </div>
  91 <div class="memdoc">
  92 <p>Constructs an <code><a class="el" href="classpp_1_1_audio_buffer.html">AudioBuffer</a></code> from a <code><a class="el" href="classpp_1_1_resource.html" title="A reference counted module resource.">Resource</a></code>. </p>
  93 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  94 <table class="params">
  95 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PPB_AudioBuffer</code> resource. </td></tr>
  96 </table>
  97 </dd>
  98 </dl>
  99 </div>
 100 </div>
 101 <a class="anchor" id="ad80595164aba1e9fbe1ccc71793c48f9"></a><!-- doxytag: member="pp::AudioBuffer::AudioBuffer" ref="ad80595164aba1e9fbe1ccc71793c48f9" args="(PassRef, PP_Resource resource)" -->
 102 <div class="memitem">
 103 <div class="memproto">
 104 <table class="memname">
 105 <tr>
 106 <td class="memname"><a class="el" href="classpp_1_1_audio_buffer.html#ae5a21e1df405d530d9280de36791dbbf">pp::AudioBuffer::AudioBuffer</a> </td>
 107 <td>(</td>
 108 <td class="paramtype"><a class="el" href="namespacepp.html#a339083c1beec620267bf8b3c55decaa5">PassRef</a>&#160;</td>
 109 <td class="paramname">, </td>
 110 </tr>
 111 <tr>
 112 <td class="paramkey"></td>
 113 <td></td>
 114 <td class="paramtype">PP_Resource&#160;</td>
 115 <td class="paramname"><em>resource</em>&#160;</td>
 116 </tr>
 117 <tr>
 118 <td></td>
 119 <td>)</td>
 120 <td></td><td></td>
 121 </tr>
 122 </table>
 123 </div>
 124 <div class="memdoc">
 125 <p>A constructor used when you have received a <code>PP_Resource</code> as a return value that has had 1 ref added for you. </p>
 126 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 127 <table class="params">
 128 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PPB_AudioBuffer</code> resource. </td></tr>
 129 </table>
 130 </dd>
 131 </dl>
 132 </div>
 133 </div>
 134 <a class="anchor" id="aa47da494df014dd6dba16053f914ce34"></a><!-- doxytag: member="pp::AudioBuffer::~AudioBuffer" ref="aa47da494df014dd6dba16053f914ce34" args="()" -->
 135 <div class="memitem">
 136 <div class="memproto">
 137 <table class="memname">
 138 <tr>
 139 <td class="memname">virtual <a class="el" href="classpp_1_1_audio_buffer.html#aa47da494df014dd6dba16053f914ce34">pp::AudioBuffer::~AudioBuffer</a> </td>
 140 <td>(</td>
 141 <td class="paramname"></td><td>)</td>
 142 <td><code> [virtual]</code></td>
 143 </tr>
 144 </table>
 145 </div>
 146 <div class="memdoc">
 147 </div>
 148 </div>
 149 <hr /><h2>Member Function Documentation</h2>
 150 <a class="anchor" id="aad0cdf64f6fc99ebbad26725ba17df65"></a><!-- doxytag: member="pp::AudioBuffer::GetDataBuffer" ref="aad0cdf64f6fc99ebbad26725ba17df65" args="()" -->
 151 <div class="memitem">
 152 <div class="memproto">
 153 <table class="memname">
 154 <tr>
 155 <td class="memname">void* <a class="el" href="classpp_1_1_audio_buffer.html#aad0cdf64f6fc99ebbad26725ba17df65">pp::AudioBuffer::GetDataBuffer</a> </td>
 156 <td>(</td>
 157 <td class="paramname"></td><td>)</td>
 158 <td></td>
 159 </tr>
 160 </table>
 161 </div>
 162 <div class="memdoc">
 163 <p>Gets the data buffer containing the audio buffer samples. </p>
 164 <dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the beginning of the data buffer. </dd></dl>
 165 </div>
 166 </div>
 167 <a class="anchor" id="a5548630a163439b2c811ab40d7cd64a0"></a><!-- doxytag: member="pp::AudioBuffer::GetDataBufferSize" ref="a5548630a163439b2c811ab40d7cd64a0" args="() const " -->
 168 <div class="memitem">
 169 <div class="memproto">
 170 <table class="memname">
 171 <tr>
 172 <td class="memname">uint32_t <a class="el" href="classpp_1_1_audio_buffer.html#a5548630a163439b2c811ab40d7cd64a0">pp::AudioBuffer::GetDataBufferSize</a> </td>
 173 <td>(</td>
 174 <td class="paramname"></td><td>)</td>
 175 <td> const</td>
 176 </tr>
 177 </table>
 178 </div>
 179 <div class="memdoc">
 180 <p>Gets the size of data buffer in bytes. </p>
 181 <dl class="return"><dt><b>Returns:</b></dt><dd>The size of the data buffer in bytes. </dd></dl>
 182 </div>
 183 </div>
 184 <a class="anchor" id="a3061bf5fc031ad6854d2b06ef6f6736a"></a><!-- doxytag: member="pp::AudioBuffer::GetNumberOfChannels" ref="a3061bf5fc031ad6854d2b06ef6f6736a" args="() const " -->
 185 <div class="memitem">
 186 <div class="memproto">
 187 <table class="memname">
 188 <tr>
 189 <td class="memname">uint32_t <a class="el" href="classpp_1_1_audio_buffer.html#a3061bf5fc031ad6854d2b06ef6f6736a">pp::AudioBuffer::GetNumberOfChannels</a> </td>
 190 <td>(</td>
 191 <td class="paramname"></td><td>)</td>
 192 <td> const</td>
 193 </tr>
 194 </table>
 195 </div>
 196 <div class="memdoc">
 197 <p>Gets the number of channels in the audio buffer. </p>
 198 <dl class="return"><dt><b>Returns:</b></dt><dd>The number of channels in the audio buffer. </dd></dl>
 199 </div>
 200 </div>
 201 <a class="anchor" id="ad588d83a59d151fb8448ea59f6f9039e"></a><!-- doxytag: member="pp::AudioBuffer::GetNumberOfSamples" ref="ad588d83a59d151fb8448ea59f6f9039e" args="() const " -->
 202 <div class="memitem">
 203 <div class="memproto">
 204 <table class="memname">
 205 <tr>
 206 <td class="memname">uint32_t <a class="el" href="classpp_1_1_audio_buffer.html#ad588d83a59d151fb8448ea59f6f9039e">pp::AudioBuffer::GetNumberOfSamples</a> </td>
 207 <td>(</td>
 208 <td class="paramname"></td><td>)</td>
 209 <td> const</td>
 210 </tr>
 211 </table>
 212 </div>
 213 <div class="memdoc">
 214 <p>Gets the number of samples in the audio buffer. </p>
 215 <dl class="return"><dt><b>Returns:</b></dt><dd>The number of samples in the audio buffer. For example, at a sampling rate of 44,100 Hz in stereo audio, a buffer containing 4,410 * 2 samples would have a duration of 100 milliseconds. </dd></dl>
 216 </div>
 217 </div>
 218 <a class="anchor" id="a650c3a1abc424e21fa56997c9d55b76f"></a><!-- doxytag: member="pp::AudioBuffer::GetSampleRate" ref="a650c3a1abc424e21fa56997c9d55b76f" args="() const " -->
 219 <div class="memitem">
 220 <div class="memproto">
 221 <table class="memname">
 222 <tr>
 223 <td class="memname">PP_AudioBuffer_SampleRate <a class="el" href="classpp_1_1_audio_buffer.html#a650c3a1abc424e21fa56997c9d55b76f">pp::AudioBuffer::GetSampleRate</a> </td>
 224 <td>(</td>
 225 <td class="paramname"></td><td>)</td>
 226 <td> const</td>
 227 </tr>
 228 </table>
 229 </div>
 230 <div class="memdoc">
 231 <p>Gets the sample rate of the audio buffer. </p>
 232 <dl class="return"><dt><b>Returns:</b></dt><dd>The sample rate of the audio buffer. </dd></dl>
 233 </div>
 234 </div>
 235 <a class="anchor" id="ac3846435b70b49392dec120716e0cfd5"></a><!-- doxytag: member="pp::AudioBuffer::GetSampleSize" ref="ac3846435b70b49392dec120716e0cfd5" args="() const " -->
 236 <div class="memitem">
 237 <div class="memproto">
 238 <table class="memname">
 239 <tr>
 240 <td class="memname">PP_AudioBuffer_SampleSize <a class="el" href="classpp_1_1_audio_buffer.html#ac3846435b70b49392dec120716e0cfd5">pp::AudioBuffer::GetSampleSize</a> </td>
 241 <td>(</td>
 242 <td class="paramname"></td><td>)</td>
 243 <td> const</td>
 244 </tr>
 245 </table>
 246 </div>
 247 <div class="memdoc">
 248 <p>Gets the sample size of the audio buffer in bytes. </p>
 249 <dl class="return"><dt><b>Returns:</b></dt><dd>The sample size of the audio buffer in bytes. </dd></dl>
 250 </div>
 251 </div>
 252 <a class="anchor" id="a08f55c4a972677114bb0c0e1ceb13661"></a><!-- doxytag: member="pp::AudioBuffer::GetTimestamp" ref="a08f55c4a972677114bb0c0e1ceb13661" args="() const " -->
 253 <div class="memitem">
 254 <div class="memproto">
 255 <table class="memname">
 256 <tr>
 257 <td class="memname">PP_TimeDelta <a class="el" href="classpp_1_1_audio_buffer.html#a08f55c4a972677114bb0c0e1ceb13661">pp::AudioBuffer::GetTimestamp</a> </td>
 258 <td>(</td>
 259 <td class="paramname"></td><td>)</td>
 260 <td> const</td>
 261 </tr>
 262 </table>
 263 </div>
 264 <div class="memdoc">
 265 <p>Gets the timestamp of the audio buffer. </p>
 266 <dl class="return"><dt><b>Returns:</b></dt><dd>A <code>PP_TimeDelta</code> containing the timestamp of the audio buffer. Given in seconds since the start of the containing audio stream. </dd></dl>
 267 </div>
 268 </div>
 269 <a class="anchor" id="a2882ec7147f4efddf3cefc6378f11f78"></a><!-- doxytag: member="pp::AudioBuffer::SetTimestamp" ref="a2882ec7147f4efddf3cefc6378f11f78" args="(PP_TimeDelta timestamp)" -->
 270 <div class="memitem">
 271 <div class="memproto">
 272 <table class="memname">
 273 <tr>
 274 <td class="memname">void <a class="el" href="classpp_1_1_audio_buffer.html#a2882ec7147f4efddf3cefc6378f11f78">pp::AudioBuffer::SetTimestamp</a> </td>
 275 <td>(</td>
 276 <td class="paramtype">PP_TimeDelta&#160;</td>
 277 <td class="paramname"><em>timestamp</em></td><td>)</td>
 278 <td></td>
 279 </tr>
 280 </table>
 281 </div>
 282 <div class="memdoc">
 283 <p>Sets the timestamp of the audio buffer. </p>
 284 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 285 <table class="params">
 286 <tr><td class="paramdir">[in]</td><td class="paramname">timestamp</td><td>A <code>PP_TimeDelta</code> containing the timestamp of the audio buffer. Given in seconds since the start of the containing audio stream. </td></tr>
 287 </table>
 288 </dd>
 289 </dl>
 290 </div>
 291 </div>
 292 <hr />The documentation for this class was generated from the following file:<ul>
 293 <li><a class="el" href="audio__buffer_8h.html">audio_buffer.h</a></li>
 294 </ul>
 295 </div><!-- contents -->
 296 </div>
 297 {{/partials.standard_nacl_api}}