1{{+bindTo:partials.standard_nacl_api}} 2<h1>PPB_AudioBuffer 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_AudioBuffer" --><h2> 13Data 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>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___audio_buffer__0__1.html#a0d62d7fb07cae07004bbc6fbe1f14dcd">IsAudioBuffer</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>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___audio_buffer__0__1.html#a1072f128761e1869ca8bd8e31fc18b51">GetTimestamp</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> buffer)</td></tr> 17<tr><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___audio_buffer__0__1.html#a03113971cf40f80274d4475e335fbea3">SetTimestamp</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> buffer, <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#ga78757d4be14d14d17708071a9466afbd">PP_AudioBuffer_SampleRate</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___audio_buffer__0__1.html#a69f6c324fcc347f24f064f38a19d2465">GetSampleRate</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> buffer)</td></tr> 19<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga2ba5c3a8eed23fa49a73b218b1bce044">PP_AudioBuffer_SampleSize</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___audio_buffer__0__1.html#a71f0374949280835b5db4503c4ef8e15">GetSampleSize</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> buffer)</td></tr> 20<tr><td class="memItemLeft" align="right" valign="top">uint32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___audio_buffer__0__1.html#a6dd92974e5543ade219fff80b8bb1a38">GetNumberOfChannels</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> buffer)</td></tr> 21<tr><td class="memItemLeft" align="right" valign="top">uint32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___audio_buffer__0__1.html#abba9e5c66fb8fb01771002b9667ec80f">GetNumberOfSamples</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> buffer)</td></tr> 22<tr><td class="memItemLeft" align="right" valign="top">void *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___audio_buffer__0__1.html#a6c2b7a87ea483ee31950efef6de57201">GetDataBuffer</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> buffer)</td></tr> 23<tr><td class="memItemLeft" align="right" valign="top">uint32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___audio_buffer__0__1.html#aad58d200bfdd1e1ed1e1cb6884a10570">GetDataBufferSize</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> buffer)</td></tr> 24</table> 25<hr /><h2>Field Documentation</h2> 26<a class="anchor" id="a6c2b7a87ea483ee31950efef6de57201"></a><!-- doxytag: member="PPB_AudioBuffer::GetDataBuffer" ref="a6c2b7a87ea483ee31950efef6de57201" args=")(PP_Resource buffer)" --> 27<div class="memitem"> 28<div class="memproto"> 29<table class="memname"> 30<tr> 31<td class="memname">void*(* <a class="el" href="struct_p_p_b___audio_buffer__0__1.html#a6c2b7a87ea483ee31950efef6de57201">PPB_AudioBuffer::GetDataBuffer</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> buffer)</td> 32</tr> 33</table> 34</div> 35<div class="memdoc"> 36<p>Gets the data buffer containing the audio samples. </p> 37<dl class="params"><dt><b>Parameters:</b></dt><dd> 38<table class="params"> 39<tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>A <code>PP_Resource</code> corresponding to an audio buffer resource.</td></tr> 40</table> 41</dd> 42</dl> 43<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the beginning of the data buffer. </dd></dl> 44</div> 45</div> 46<a class="anchor" id="aad58d200bfdd1e1ed1e1cb6884a10570"></a><!-- doxytag: member="PPB_AudioBuffer::GetDataBufferSize" ref="aad58d200bfdd1e1ed1e1cb6884a10570" args=")(PP_Resource buffer)" --> 47<div class="memitem"> 48<div class="memproto"> 49<table class="memname"> 50<tr> 51<td class="memname">uint32_t(* <a class="el" href="struct_p_p_b___audio_buffer__0__1.html#aad58d200bfdd1e1ed1e1cb6884a10570">PPB_AudioBuffer::GetDataBufferSize</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> buffer)</td> 52</tr> 53</table> 54</div> 55<div class="memdoc"> 56<p>Gets the size of the data buffer in bytes. </p> 57<dl class="params"><dt><b>Parameters:</b></dt><dd> 58<table class="params"> 59<tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>A <code>PP_Resource</code> corresponding to an audio buffer resource.</td></tr> 60</table> 61</dd> 62</dl> 63<dl class="return"><dt><b>Returns:</b></dt><dd>The size of the data buffer in bytes. </dd></dl> 64</div> 65</div> 66<a class="anchor" id="a6dd92974e5543ade219fff80b8bb1a38"></a><!-- doxytag: member="PPB_AudioBuffer::GetNumberOfChannels" ref="a6dd92974e5543ade219fff80b8bb1a38" args=")(PP_Resource buffer)" --> 67<div class="memitem"> 68<div class="memproto"> 69<table class="memname"> 70<tr> 71<td class="memname">uint32_t(* <a class="el" href="struct_p_p_b___audio_buffer__0__1.html#a6dd92974e5543ade219fff80b8bb1a38">PPB_AudioBuffer::GetNumberOfChannels</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> buffer)</td> 72</tr> 73</table> 74</div> 75<div class="memdoc"> 76<p>Gets the number of channels in the audio buffer. </p> 77<dl class="params"><dt><b>Parameters:</b></dt><dd> 78<table class="params"> 79<tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>A <code>PP_Resource</code> corresponding to an audio buffer resource.</td></tr> 80</table> 81</dd> 82</dl> 83<dl class="return"><dt><b>Returns:</b></dt><dd>The number of channels in the audio buffer. </dd></dl> 84</div> 85</div> 86<a class="anchor" id="abba9e5c66fb8fb01771002b9667ec80f"></a><!-- doxytag: member="PPB_AudioBuffer::GetNumberOfSamples" ref="abba9e5c66fb8fb01771002b9667ec80f" args=")(PP_Resource buffer)" --> 87<div class="memitem"> 88<div class="memproto"> 89<table class="memname"> 90<tr> 91<td class="memname">uint32_t(* <a class="el" href="struct_p_p_b___audio_buffer__0__1.html#abba9e5c66fb8fb01771002b9667ec80f">PPB_AudioBuffer::GetNumberOfSamples</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> buffer)</td> 92</tr> 93</table> 94</div> 95<div class="memdoc"> 96<p>Gets the number of samples in the audio buffer. </p> 97<dl class="params"><dt><b>Parameters:</b></dt><dd> 98<table class="params"> 99<tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>A <code>PP_Resource</code> corresponding to an audio buffer resource.</td></tr> 100</table> 101</dd> 102</dl> 103<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 4410 * 2 samples would have a duration of 100 milliseconds. </dd></dl> 104</div> 105</div> 106<a class="anchor" id="a69f6c324fcc347f24f064f38a19d2465"></a><!-- doxytag: member="PPB_AudioBuffer::GetSampleRate" ref="a69f6c324fcc347f24f064f38a19d2465" args=")(PP_Resource buffer)" --> 107<div class="memitem"> 108<div class="memproto"> 109<table class="memname"> 110<tr> 111<td class="memname"><a class="el" href="group___enums.html#ga78757d4be14d14d17708071a9466afbd">PP_AudioBuffer_SampleRate</a>(* <a class="el" href="struct_p_p_b___audio_buffer__0__1.html#a69f6c324fcc347f24f064f38a19d2465">PPB_AudioBuffer::GetSampleRate</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> buffer)</td> 112</tr> 113</table> 114</div> 115<div class="memdoc"> 116<p>Gets the sample rate of the audio buffer. </p> 117<dl class="params"><dt><b>Parameters:</b></dt><dd> 118<table class="params"> 119<tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>A <code>PP_Resource</code> corresponding to an audio buffer resource.</td></tr> 120</table> 121</dd> 122</dl> 123<dl class="return"><dt><b>Returns:</b></dt><dd>The sample rate of the audio buffer. </dd></dl> 124</div> 125</div> 126<a class="anchor" id="a71f0374949280835b5db4503c4ef8e15"></a><!-- doxytag: member="PPB_AudioBuffer::GetSampleSize" ref="a71f0374949280835b5db4503c4ef8e15" args=")(PP_Resource buffer)" --> 127<div class="memitem"> 128<div class="memproto"> 129<table class="memname"> 130<tr> 131<td class="memname"><a class="el" href="group___enums.html#ga2ba5c3a8eed23fa49a73b218b1bce044">PP_AudioBuffer_SampleSize</a>(* <a class="el" href="struct_p_p_b___audio_buffer__0__1.html#a71f0374949280835b5db4503c4ef8e15">PPB_AudioBuffer::GetSampleSize</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> buffer)</td> 132</tr> 133</table> 134</div> 135<div class="memdoc"> 136<p>Gets the sample size of the audio buffer. </p> 137<dl class="params"><dt><b>Parameters:</b></dt><dd> 138<table class="params"> 139<tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>A <code>PP_Resource</code> corresponding to an audio buffer resource.</td></tr> 140</table> 141</dd> 142</dl> 143<dl class="return"><dt><b>Returns:</b></dt><dd>The sample size of the audio buffer. </dd></dl> 144</div> 145</div> 146<a class="anchor" id="a1072f128761e1869ca8bd8e31fc18b51"></a><!-- doxytag: member="PPB_AudioBuffer::GetTimestamp" ref="a1072f128761e1869ca8bd8e31fc18b51" args=")(PP_Resource buffer)" --> 147<div class="memitem"> 148<div class="memproto"> 149<table class="memname"> 150<tr> 151<td class="memname"><a class="el" href="group___typedefs.html#ga3962a5355895925a757f613567e422fa">PP_TimeDelta</a>(* <a class="el" href="struct_p_p_b___audio_buffer__0__1.html#a1072f128761e1869ca8bd8e31fc18b51">PPB_AudioBuffer::GetTimestamp</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> buffer)</td> 152</tr> 153</table> 154</div> 155<div class="memdoc"> 156<p>Gets the timestamp of the audio buffer. </p> 157<dl class="params"><dt><b>Parameters:</b></dt><dd> 158<table class="params"> 159<tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>A <code>PP_Resource</code> corresponding to an audio buffer resource.</td></tr> 160</table> 161</dd> 162</dl> 163<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> 164</div> 165</div> 166<a class="anchor" id="a0d62d7fb07cae07004bbc6fbe1f14dcd"></a><!-- doxytag: member="PPB_AudioBuffer::IsAudioBuffer" ref="a0d62d7fb07cae07004bbc6fbe1f14dcd" args=")(PP_Resource resource)" --> 167<div class="memitem"> 168<div class="memproto"> 169<table class="memname"> 170<tr> 171<td class="memname"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* <a class="el" href="struct_p_p_b___audio_buffer__0__1.html#a0d62d7fb07cae07004bbc6fbe1f14dcd">PPB_AudioBuffer::IsAudioBuffer</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource)</td> 172</tr> 173</table> 174</div> 175<div class="memdoc"> 176<p>Determines if a resource is an AudioBuffer resource. </p> 177<dl class="params"><dt><b>Parameters:</b></dt><dd> 178<table class="params"> 179<tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>The <code>PP_Resource</code> to test.</td></tr> 180</table> 181</dd> 182</dl> 183<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 AudioBuffer resource or <code>PP_FALSE</code> otherwise. </dd></dl> 184</div> 185</div> 186<a class="anchor" id="a03113971cf40f80274d4475e335fbea3"></a><!-- doxytag: member="PPB_AudioBuffer::SetTimestamp" ref="a03113971cf40f80274d4475e335fbea3" args=")(PP_Resource buffer, PP_TimeDelta timestamp)" --> 187<div class="memitem"> 188<div class="memproto"> 189<table class="memname"> 190<tr> 191<td class="memname">void(* <a class="el" href="struct_p_p_b___audio_buffer__0__1.html#a03113971cf40f80274d4475e335fbea3">PPB_AudioBuffer::SetTimestamp</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> buffer, <a class="el" href="group___typedefs.html#ga3962a5355895925a757f613567e422fa">PP_TimeDelta</a> timestamp)</td> 192</tr> 193</table> 194</div> 195<div class="memdoc"> 196<p>Sets the timestamp of the audio buffer. </p> 197<dl class="params"><dt><b>Parameters:</b></dt><dd> 198<table class="params"> 199<tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>A <code>PP_Resource</code> corresponding to an audio buffer resource. </td></tr> 200<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> 201</table> 202</dd> 203</dl> 204</div> 205</div> 206<hr />The documentation for this struct was generated from the following file:<ul> 207<li><a class="el" href="ppb__audio__buffer_8h.html">ppb_audio_buffer.h</a></li> 208</ul> 209</div><!-- contents --> 210</div> 211{{/partials.standard_nacl_api}} 212