Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(250)

Unified Diff: native_client_sdk/doc_generated/pepper_dev/cpp/classpp_1_1_audio_frame.html

Issue 179333007: [NaCl SDK Docs] Update the generated documentation. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 6 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: native_client_sdk/doc_generated/pepper_dev/cpp/classpp_1_1_audio_frame.html
diff --git a/native_client_sdk/doc_generated/pepper_dev/cpp/classpp_1_1_audio_frame.html b/native_client_sdk/doc_generated/pepper_dev/cpp/classpp_1_1_audio_frame.html
deleted file mode 100644
index 6017722970d2de547bed18ebed6de02e6002f4b5..0000000000000000000000000000000000000000
--- a/native_client_sdk/doc_generated/pepper_dev/cpp/classpp_1_1_audio_frame.html
+++ /dev/null
@@ -1,279 +0,0 @@
-{{+bindTo:partials.standard_nacl_article}}
-<h1>pp::AudioFrame Class Reference</h1>
-<div id="doxygen-ref">
-{{- dummy div to appease doxygen -}}
- <div>
-<!-- Generated by Doxygen 1.7.6.1 -->
-
-
-
-</div>
-<!--header-->
-<div class="contents">
-<!-- doxytag: class="pp::AudioFrame" --><!-- doxytag: inherits="pp::Resource" --><div class="dynheader">
-Inheritance diagram for pp::AudioFrame:</div>
-<div class="dyncontent">
-<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>
-<map name="pp_1_1_audio_frame_inherit__map" id="pp_1_1_audio_frame_inherit__map">
-<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>
-<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
-<p><a href="classpp_1_1_audio_frame-members.html">List of all members.</a></p>
-<h2>
-Public Member Functions</h2><table class="memberdecls">
-
-<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>
-<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>
-<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>
-<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>
-<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>
-<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>
-<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>
-<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>
-<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>
-<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>
-<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>
-<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>
-</table>
-<hr /><h2>Constructor &amp; Destructor Documentation</h2>
-<a class="anchor" id="a34c5fe2032eb858356bade18829eb5af"></a><!-- doxytag: member="pp::AudioFrame::AudioFrame" ref="a34c5fe2032eb858356bade18829eb5af" args="()" -->
-<div class="memitem">
-<div class="memproto">
-<table class="memname">
-<tr>
-<td class="memname"><a class="el" href="classpp_1_1_audio_frame.html#a34c5fe2032eb858356bade18829eb5af">pp::AudioFrame::AudioFrame</a> </td>
-<td>(</td>
-<td class="paramname"></td><td>)</td>
-<td></td>
-</tr>
-</table>
-</div>
-<div class="memdoc">
-<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>
-</div>
-</div>
-<a class="anchor" id="a4d90b7a73435fe86eec8d3b106ccad49"></a><!-- doxytag: member="pp::AudioFrame::AudioFrame" ref="a4d90b7a73435fe86eec8d3b106ccad49" args="(const AudioFrame &amp;other)" -->
-<div class="memitem">
-<div class="memproto">
-<table class="memname">
-<tr>
-<td class="memname"><a class="el" href="classpp_1_1_audio_frame.html#a34c5fe2032eb858356bade18829eb5af">pp::AudioFrame::AudioFrame</a> </td>
-<td>(</td>
-<td class="paramtype">const <a class="el" href="classpp_1_1_audio_frame.html">AudioFrame</a> &amp;&#160;</td>
-<td class="paramname"><em>other</em></td><td>)</td>
-<td></td>
-</tr>
-</table>
-</div>
-<div class="memdoc">
-<p>The copy constructor for <code><a class="el" href="classpp_1_1_audio_frame.html">AudioFrame</a></code>. </p>
-<dl class="params"><dt><b>Parameters:</b></dt><dd>
-<table class="params">
-<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>
-</table>
-</dd>
-</dl>
-</div>
-</div>
-<a class="anchor" id="a29676f598adbc902205712aa64bd79c8"></a><!-- doxytag: member="pp::AudioFrame::AudioFrame" ref="a29676f598adbc902205712aa64bd79c8" args="(const Resource &amp;resource)" -->
-<div class="memitem">
-<div class="memproto">
-<table class="memname">
-<tr>
-<td class="memname"><a class="el" href="classpp_1_1_audio_frame.html#a34c5fe2032eb858356bade18829eb5af">pp::AudioFrame::AudioFrame</a> </td>
-<td>(</td>
-<td class="paramtype">const <a class="el" href="classpp_1_1_resource.html">Resource</a> &amp;&#160;</td>
-<td class="paramname"><em>resource</em></td><td>)</td>
-<td><code> [explicit]</code></td>
-</tr>
-</table>
-</div>
-<div class="memdoc">
-<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>
-<dl class="params"><dt><b>Parameters:</b></dt><dd>
-<table class="params">
-<tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PPB_AudioFrame</code> resource. </td></tr>
-</table>
-</dd>
-</dl>
-</div>
-</div>
-<a class="anchor" id="a423da94bba4bca8eb296e89f179640f9"></a><!-- doxytag: member="pp::AudioFrame::AudioFrame" ref="a423da94bba4bca8eb296e89f179640f9" args="(PassRef, PP_Resource resource)" -->
-<div class="memitem">
-<div class="memproto">
-<table class="memname">
-<tr>
-<td class="memname"><a class="el" href="classpp_1_1_audio_frame.html#a34c5fe2032eb858356bade18829eb5af">pp::AudioFrame::AudioFrame</a> </td>
-<td>(</td>
-<td class="paramtype"><a class="el" href="namespacepp.html#a339083c1beec620267bf8b3c55decaa5">PassRef</a>&#160;</td>
-<td class="paramname">, </td>
-</tr>
-<tr>
-<td class="paramkey"></td>
-<td></td>
-<td class="paramtype">PP_Resource&#160;</td>
-<td class="paramname"><em>resource</em>&#160;</td>
-</tr>
-<tr>
-<td></td>
-<td>)</td>
-<td></td><td></td>
-</tr>
-</table>
-</div>
-<div class="memdoc">
-<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>
-<dl class="params"><dt><b>Parameters:</b></dt><dd>
-<table class="params">
-<tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PPB_AudioFrame</code> resource. </td></tr>
-</table>
-</dd>
-</dl>
-</div>
-</div>
-<a class="anchor" id="a41fd32585aa8fe9427dff22cb5455422"></a><!-- doxytag: member="pp::AudioFrame::~AudioFrame" ref="a41fd32585aa8fe9427dff22cb5455422" args="()" -->
-<div class="memitem">
-<div class="memproto">
-<table class="memname">
-<tr>
-<td class="memname">virtual <a class="el" href="classpp_1_1_audio_frame.html#a41fd32585aa8fe9427dff22cb5455422">pp::AudioFrame::~AudioFrame</a> </td>
-<td>(</td>
-<td class="paramname"></td><td>)</td>
-<td><code> [virtual]</code></td>
-</tr>
-</table>
-</div>
-<div class="memdoc">
-</div>
-</div>
-<hr /><h2>Member Function Documentation</h2>
-<a class="anchor" id="a3eab39dcfec84777987b0b237747187d"></a><!-- doxytag: member="pp::AudioFrame::GetDataBuffer" ref="a3eab39dcfec84777987b0b237747187d" args="()" -->
-<div class="memitem">
-<div class="memproto">
-<table class="memname">
-<tr>
-<td class="memname">void* <a class="el" href="classpp_1_1_audio_frame.html#a3eab39dcfec84777987b0b237747187d">pp::AudioFrame::GetDataBuffer</a> </td>
-<td>(</td>
-<td class="paramname"></td><td>)</td>
-<td></td>
-</tr>
-</table>
-</div>
-<div class="memdoc">
-<p>Gets the data buffer containing the audio frame samples. </p>
-<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the beginning of the data buffer. </dd></dl>
-</div>
-</div>
-<a class="anchor" id="a9b10a619f819ff7351dbabb8de140563"></a><!-- doxytag: member="pp::AudioFrame::GetDataBufferSize" ref="a9b10a619f819ff7351dbabb8de140563" args="() const " -->
-<div class="memitem">
-<div class="memproto">
-<table class="memname">
-<tr>
-<td class="memname">uint32_t <a class="el" href="classpp_1_1_audio_frame.html#a9b10a619f819ff7351dbabb8de140563">pp::AudioFrame::GetDataBufferSize</a> </td>
-<td>(</td>
-<td class="paramname"></td><td>)</td>
-<td> const</td>
-</tr>
-</table>
-</div>
-<div class="memdoc">
-<p>Gets the size of data buffer in bytes. </p>
-<dl class="return"><dt><b>Returns:</b></dt><dd>The size of the data buffer in bytes. </dd></dl>
-</div>
-</div>
-<a class="anchor" id="a5c5dc02664ce94915445a698f655e7ca"></a><!-- doxytag: member="pp::AudioFrame::GetNumberOfChannels" ref="a5c5dc02664ce94915445a698f655e7ca" args="() const " -->
-<div class="memitem">
-<div class="memproto">
-<table class="memname">
-<tr>
-<td class="memname">uint32_t <a class="el" href="classpp_1_1_audio_frame.html#a5c5dc02664ce94915445a698f655e7ca">pp::AudioFrame::GetNumberOfChannels</a> </td>
-<td>(</td>
-<td class="paramname"></td><td>)</td>
-<td> const</td>
-</tr>
-</table>
-</div>
-<div class="memdoc">
-<p>Gets the number of channels in the audio frame. </p>
-<dl class="return"><dt><b>Returns:</b></dt><dd>The number of channels in the audio frame. </dd></dl>
-</div>
-</div>
-<a class="anchor" id="a740e54cb2498a3dfe5b621cdf830b692"></a><!-- doxytag: member="pp::AudioFrame::GetNumberOfSamples" ref="a740e54cb2498a3dfe5b621cdf830b692" args="() const " -->
-<div class="memitem">
-<div class="memproto">
-<table class="memname">
-<tr>
-<td class="memname">uint32_t <a class="el" href="classpp_1_1_audio_frame.html#a740e54cb2498a3dfe5b621cdf830b692">pp::AudioFrame::GetNumberOfSamples</a> </td>
-<td>(</td>
-<td class="paramname"></td><td>)</td>
-<td> const</td>
-</tr>
-</table>
-</div>
-<div class="memdoc">
-<p>Gets the number of samples in the audio frame. </p>
-<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>
-</div>
-</div>
-<a class="anchor" id="a0cf77d9bbf90d8474053a79514f4dd30"></a><!-- doxytag: member="pp::AudioFrame::GetSampleSize" ref="a0cf77d9bbf90d8474053a79514f4dd30" args="() const " -->
-<div class="memitem">
-<div class="memproto">
-<table class="memname">
-<tr>
-<td class="memname">uint32_t <a class="el" href="classpp_1_1_audio_frame.html#a0cf77d9bbf90d8474053a79514f4dd30">pp::AudioFrame::GetSampleSize</a> </td>
-<td>(</td>
-<td class="paramname"></td><td>)</td>
-<td> const</td>
-</tr>
-</table>
-</div>
-<div class="memdoc">
-<p>Gets the sample size of the audio frame in bytes. </p>
-<dl class="return"><dt><b>Returns:</b></dt><dd>The sample size of the audio frame in bytes. </dd></dl>
-</div>
-</div>
-<a class="anchor" id="acfd8249e24bfe64b502856474c9bc1ff"></a><!-- doxytag: member="pp::AudioFrame::GetTimestamp" ref="acfd8249e24bfe64b502856474c9bc1ff" args="() const " -->
-<div class="memitem">
-<div class="memproto">
-<table class="memname">
-<tr>
-<td class="memname">PP_TimeDelta <a class="el" href="classpp_1_1_audio_frame.html#acfd8249e24bfe64b502856474c9bc1ff">pp::AudioFrame::GetTimestamp</a> </td>
-<td>(</td>
-<td class="paramname"></td><td>)</td>
-<td> const</td>
-</tr>
-</table>
-</div>
-<div class="memdoc">
-<p>Gets the timestamp of the audio frame. </p>
-<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>
-</div>
-</div>
-<a class="anchor" id="af0222861693f93302daa16993aa30ef1"></a><!-- doxytag: member="pp::AudioFrame::SetTimestamp" ref="af0222861693f93302daa16993aa30ef1" args="(PP_TimeDelta timestamp)" -->
-<div class="memitem">
-<div class="memproto">
-<table class="memname">
-<tr>
-<td class="memname">void <a class="el" href="classpp_1_1_audio_frame.html#af0222861693f93302daa16993aa30ef1">pp::AudioFrame::SetTimestamp</a> </td>
-<td>(</td>
-<td class="paramtype">PP_TimeDelta&#160;</td>
-<td class="paramname"><em>timestamp</em></td><td>)</td>
-<td></td>
-</tr>
-</table>
-</div>
-<div class="memdoc">
-<p>Sets the timestamp of the audio frame. </p>
-<dl class="params"><dt><b>Parameters:</b></dt><dd>
-<table class="params">
-<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>
-</table>
-</dd>
-</dl>
-</div>
-</div>
-<hr />The documentation for this class was generated from the following file:<ul>
-<li><a class="el" href="audio__frame_8h.html">audio_frame.h</a></li>
-</ul>
-</div><!-- contents -->
-</div>
-{{/partials.standard_nacl_article}}

Powered by Google App Engine
This is Rietveld 408576698