src/native_client_sdk/doc_generated/pepper_dev/cpp/classpp_1_1_audio_frame.html

   1 {{+bindTo:partials.standard_nacl_article}}
   2 <h1>pp::AudioFrame 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::AudioFrame" --><!-- doxytag: inherits="pp::Resource" --><div class="dynheader">
  14 Inheritance diagram for pp::AudioFrame:</div>
  15 <div class="dyncontent">
  16 <div class="center"><img src="classpp_1_1_audio_frame__inherit__graph.png" border="0" usemap="#pp_1_1_audio_frame_inherit__map" alt="Inheritance graph" /></div>
  17 <map name="pp_1_1_audio_frame_inherit__map" id="pp_1_1_audio_frame_inherit__map">
  18 <area shape="rect" id="node2" href="classpp_1_1_resource.html" title="A reference counted module resource." alt="" coords="15,5,119,35"></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_frame-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_frame.html#a34c5fe2032eb858356bade18829eb5af">AudioFrame</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_frame.html#a4d90b7a73435fe86eec8d3b106ccad49">AudioFrame</a> (const <a class="el" href="classpp_1_1_audio_frame.html">AudioFrame</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_frame.html#a29676f598adbc902205712aa64bd79c8">AudioFrame</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_frame.html#a423da94bba4bca8eb296e89f179640f9">AudioFrame</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_frame.html#a41fd32585aa8fe9427dff22cb5455422">~AudioFrame</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_frame.html#acfd8249e24bfe64b502856474c9bc1ff">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_frame.html#af0222861693f93302daa16993aa30ef1">SetTimestamp</a> (PP_TimeDelta timestamp)</td></tr>
  31 <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_frame.html#a0cf77d9bbf90d8474053a79514f4dd30">GetSampleSize</a> () const </td></tr>
  32 <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_frame.html#a5c5dc02664ce94915445a698f655e7ca">GetNumberOfChannels</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_frame.html#a740e54cb2498a3dfe5b621cdf830b692">GetNumberOfSamples</a> () const </td></tr>
  34 <tr><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_audio_frame.html#a3eab39dcfec84777987b0b237747187d">GetDataBuffer</a> ()</td></tr>
  35 <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_frame.html#a9b10a619f819ff7351dbabb8de140563">GetDataBufferSize</a> () const </td></tr>
  36 </table>
  37 <hr /><h2>Constructor &amp; Destructor Documentation</h2>
  38 <a class="anchor" id="a34c5fe2032eb858356bade18829eb5af"></a><!-- doxytag: member="pp::AudioFrame::AudioFrame" ref="a34c5fe2032eb858356bade18829eb5af" args="()" -->
  39 <div class="memitem">
  40 <div class="memproto">
  41 <table class="memname">
  42 <tr>
  43 <td class="memname"><a class="el" href="classpp_1_1_audio_frame.html#a34c5fe2032eb858356bade18829eb5af">pp::AudioFrame::AudioFrame</a> </td>
  44 <td>(</td>
  45 <td class="paramname"></td><td>)</td>
  46 <td></td>
  47 </tr>
  48 </table>
  49 </div>
  50 <div class="memdoc">
  51 <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_frame.html">AudioFrame</a></code> object. </p>
  52 </div>
  53 </div>
  54 <a class="anchor" id="a4d90b7a73435fe86eec8d3b106ccad49"></a><!-- doxytag: member="pp::AudioFrame::AudioFrame" ref="a4d90b7a73435fe86eec8d3b106ccad49" args="(const AudioFrame &amp;other)" -->
  55 <div class="memitem">
  56 <div class="memproto">
  57 <table class="memname">
  58 <tr>
  59 <td class="memname"><a class="el" href="classpp_1_1_audio_frame.html#a34c5fe2032eb858356bade18829eb5af">pp::AudioFrame::AudioFrame</a> </td>
  60 <td>(</td>
  61 <td class="paramtype">const <a class="el" href="classpp_1_1_audio_frame.html">AudioFrame</a> &amp;&#160;</td>
  62 <td class="paramname"><em>other</em></td><td>)</td>
  63 <td></td>
  64 </tr>
  65 </table>
  66 </div>
  67 <div class="memdoc">
  68 <p>The copy constructor for <code><a class="el" href="classpp_1_1_audio_frame.html">AudioFrame</a></code>. </p>
  69 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  70 <table class="params">
  71 <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_frame.html">AudioFrame</a></code>. </td></tr>
  72 </table>
  73 </dd>
  74 </dl>
  75 </div>
  76 </div>
  77 <a class="anchor" id="a29676f598adbc902205712aa64bd79c8"></a><!-- doxytag: member="pp::AudioFrame::AudioFrame" ref="a29676f598adbc902205712aa64bd79c8" args="(const Resource &amp;resource)" -->
  78 <div class="memitem">
  79 <div class="memproto">
  80 <table class="memname">
  81 <tr>
  82 <td class="memname"><a class="el" href="classpp_1_1_audio_frame.html#a34c5fe2032eb858356bade18829eb5af">pp::AudioFrame::AudioFrame</a> </td>
  83 <td>(</td>
  84 <td class="paramtype">const <a class="el" href="classpp_1_1_resource.html">Resource</a> &amp;&#160;</td>
  85 <td class="paramname"><em>resource</em></td><td>)</td>
  86 <td><code> [explicit]</code></td>
  87 </tr>
  88 </table>
  89 </div>
  90 <div class="memdoc">
  91 <p>Constructs an <code><a class="el" href="classpp_1_1_audio_frame.html">AudioFrame</a></code> from a <code><a class="el" href="classpp_1_1_resource.html" title="A reference counted module resource.">Resource</a></code>. </p>
  92 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  93 <table class="params">
  94 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PPB_AudioFrame</code> resource. </td></tr>
  95 </table>
  96 </dd>
  97 </dl>
  98 </div>
  99 </div>
 100 <a class="anchor" id="a423da94bba4bca8eb296e89f179640f9"></a><!-- doxytag: member="pp::AudioFrame::AudioFrame" ref="a423da94bba4bca8eb296e89f179640f9" args="(PassRef, PP_Resource resource)" -->
 101 <div class="memitem">
 102 <div class="memproto">
 103 <table class="memname">
 104 <tr>
 105 <td class="memname"><a class="el" href="classpp_1_1_audio_frame.html#a34c5fe2032eb858356bade18829eb5af">pp::AudioFrame::AudioFrame</a> </td>
 106 <td>(</td>
 107 <td class="paramtype"><a class="el" href="namespacepp.html#a339083c1beec620267bf8b3c55decaa5">PassRef</a>&#160;</td>
 108 <td class="paramname">, </td>
 109 </tr>
 110 <tr>
 111 <td class="paramkey"></td>
 112 <td></td>
 113 <td class="paramtype">PP_Resource&#160;</td>
 114 <td class="paramname"><em>resource</em>&#160;</td>
 115 </tr>
 116 <tr>
 117 <td></td>
 118 <td>)</td>
 119 <td></td><td></td>
 120 </tr>
 121 </table>
 122 </div>
 123 <div class="memdoc">
 124 <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>
 125 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 126 <table class="params">
 127 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PPB_AudioFrame</code> resource. </td></tr>
 128 </table>
 129 </dd>
 130 </dl>
 131 </div>
 132 </div>
 133 <a class="anchor" id="a41fd32585aa8fe9427dff22cb5455422"></a><!-- doxytag: member="pp::AudioFrame::~AudioFrame" ref="a41fd32585aa8fe9427dff22cb5455422" args="()" -->
 134 <div class="memitem">
 135 <div class="memproto">
 136 <table class="memname">
 137 <tr>
 138 <td class="memname">virtual <a class="el" href="classpp_1_1_audio_frame.html#a41fd32585aa8fe9427dff22cb5455422">pp::AudioFrame::~AudioFrame</a> </td>
 139 <td>(</td>
 140 <td class="paramname"></td><td>)</td>
 141 <td><code> [virtual]</code></td>
 142 </tr>
 143 </table>
 144 </div>
 145 <div class="memdoc">
 146 </div>
 147 </div>
 148 <hr /><h2>Member Function Documentation</h2>
 149 <a class="anchor" id="a3eab39dcfec84777987b0b237747187d"></a><!-- doxytag: member="pp::AudioFrame::GetDataBuffer" ref="a3eab39dcfec84777987b0b237747187d" args="()" -->
 150 <div class="memitem">
 151 <div class="memproto">
 152 <table class="memname">
 153 <tr>
 154 <td class="memname">void* <a class="el" href="classpp_1_1_audio_frame.html#a3eab39dcfec84777987b0b237747187d">pp::AudioFrame::GetDataBuffer</a> </td>
 155 <td>(</td>
 156 <td class="paramname"></td><td>)</td>
 157 <td></td>
 158 </tr>
 159 </table>
 160 </div>
 161 <div class="memdoc">
 162 <p>Gets the data buffer containing the audio frame samples. </p>
 163 <dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the beginning of the data buffer. </dd></dl>
 164 </div>
 165 </div>
 166 <a class="anchor" id="a9b10a619f819ff7351dbabb8de140563"></a><!-- doxytag: member="pp::AudioFrame::GetDataBufferSize" ref="a9b10a619f819ff7351dbabb8de140563" args="() const " -->
 167 <div class="memitem">
 168 <div class="memproto">
 169 <table class="memname">
 170 <tr>
 171 <td class="memname">uint32_t <a class="el" href="classpp_1_1_audio_frame.html#a9b10a619f819ff7351dbabb8de140563">pp::AudioFrame::GetDataBufferSize</a> </td>
 172 <td>(</td>
 173 <td class="paramname"></td><td>)</td>
 174 <td> const</td>
 175 </tr>
 176 </table>
 177 </div>
 178 <div class="memdoc">
 179 <p>Gets the size of data buffer in bytes. </p>
 180 <dl class="return"><dt><b>Returns:</b></dt><dd>The size of the data buffer in bytes. </dd></dl>
 181 </div>
 182 </div>
 183 <a class="anchor" id="a5c5dc02664ce94915445a698f655e7ca"></a><!-- doxytag: member="pp::AudioFrame::GetNumberOfChannels" ref="a5c5dc02664ce94915445a698f655e7ca" args="() const " -->
 184 <div class="memitem">
 185 <div class="memproto">
 186 <table class="memname">
 187 <tr>
 188 <td class="memname">uint32_t <a class="el" href="classpp_1_1_audio_frame.html#a5c5dc02664ce94915445a698f655e7ca">pp::AudioFrame::GetNumberOfChannels</a> </td>
 189 <td>(</td>
 190 <td class="paramname"></td><td>)</td>
 191 <td> const</td>
 192 </tr>
 193 </table>
 194 </div>
 195 <div class="memdoc">
 196 <p>Gets the number of channels in the audio frame. </p>
 197 <dl class="return"><dt><b>Returns:</b></dt><dd>The number of channels in the audio frame. </dd></dl>
 198 </div>
 199 </div>
 200 <a class="anchor" id="a740e54cb2498a3dfe5b621cdf830b692"></a><!-- doxytag: member="pp::AudioFrame::GetNumberOfSamples" ref="a740e54cb2498a3dfe5b621cdf830b692" args="() const " -->
 201 <div class="memitem">
 202 <div class="memproto">
 203 <table class="memname">
 204 <tr>
 205 <td class="memname">uint32_t <a class="el" href="classpp_1_1_audio_frame.html#a740e54cb2498a3dfe5b621cdf830b692">pp::AudioFrame::GetNumberOfSamples</a> </td>
 206 <td>(</td>
 207 <td class="paramname"></td><td>)</td>
 208 <td> const</td>
 209 </tr>
 210 </table>
 211 </div>
 212 <div class="memdoc">
 213 <p>Gets the number of samples in the audio frame. </p>
 214 <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 4,410 * 2 samples would have a duration of 100 milliseconds. </dd></dl>
 215 </div>
 216 </div>
 217 <a class="anchor" id="a0cf77d9bbf90d8474053a79514f4dd30"></a><!-- doxytag: member="pp::AudioFrame::GetSampleSize" ref="a0cf77d9bbf90d8474053a79514f4dd30" args="() const " -->
 218 <div class="memitem">
 219 <div class="memproto">
 220 <table class="memname">
 221 <tr>
 222 <td class="memname">uint32_t <a class="el" href="classpp_1_1_audio_frame.html#a0cf77d9bbf90d8474053a79514f4dd30">pp::AudioFrame::GetSampleSize</a> </td>
 223 <td>(</td>
 224 <td class="paramname"></td><td>)</td>
 225 <td> const</td>
 226 </tr>
 227 </table>
 228 </div>
 229 <div class="memdoc">
 230 <p>Gets the sample size of the audio frame in bytes. </p>
 231 <dl class="return"><dt><b>Returns:</b></dt><dd>The sample size of the audio frame in bytes. </dd></dl>
 232 </div>
 233 </div>
 234 <a class="anchor" id="acfd8249e24bfe64b502856474c9bc1ff"></a><!-- doxytag: member="pp::AudioFrame::GetTimestamp" ref="acfd8249e24bfe64b502856474c9bc1ff" args="() const " -->
 235 <div class="memitem">
 236 <div class="memproto">
 237 <table class="memname">
 238 <tr>
 239 <td class="memname">PP_TimeDelta <a class="el" href="classpp_1_1_audio_frame.html#acfd8249e24bfe64b502856474c9bc1ff">pp::AudioFrame::GetTimestamp</a> </td>
 240 <td>(</td>
 241 <td class="paramname"></td><td>)</td>
 242 <td> const</td>
 243 </tr>
 244 </table>
 245 </div>
 246 <div class="memdoc">
 247 <p>Gets the timestamp of the audio frame. </p>
 248 <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>
 249 </div>
 250 </div>
 251 <a class="anchor" id="af0222861693f93302daa16993aa30ef1"></a><!-- doxytag: member="pp::AudioFrame::SetTimestamp" ref="af0222861693f93302daa16993aa30ef1" args="(PP_TimeDelta timestamp)" -->
 252 <div class="memitem">
 253 <div class="memproto">
 254 <table class="memname">
 255 <tr>
 256 <td class="memname">void <a class="el" href="classpp_1_1_audio_frame.html#af0222861693f93302daa16993aa30ef1">pp::AudioFrame::SetTimestamp</a> </td>
 257 <td>(</td>
 258 <td class="paramtype">PP_TimeDelta&#160;</td>
 259 <td class="paramname"><em>timestamp</em></td><td>)</td>
 260 <td></td>
 261 </tr>
 262 </table>
 263 </div>
 264 <div class="memdoc">
 265 <p>Sets the timestamp of the audio frame. </p>
 266 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 267 <table class="params">
 268 <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>
 269 </table>
 270 </dd>
 271 </dl>
 272 </div>
 273 </div>
 274 <hr />The documentation for this class was generated from the following file:<ul>
 275 <li><a class="el" href="audio__frame_8h.html">audio_frame.h</a></li>
 276 </ul>
 277 </div><!-- contents -->
 278 </div>
 279 {{/partials.standard_nacl_article}}