native_client_sdk/doc_generated/pepper_dev/cpp/classpp_1_1_video_frame.html

{{+bindTo:partials.standard_nacl_api}}
<h1>pp::VideoFrame 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::VideoFrame" --><!-- doxytag: inherits="pp::Resource" --><div class="dynheader">
Inheritance diagram for pp::VideoFrame:</div>
<div class="dyncontent">
<div class="center"><img src="classpp_1_1_video_frame__inherit__graph.png" border="0" usemap="#pp_1_1_video_frame_inherit__map" alt="Inheritance graph" /></div>
<map name="pp_1_1_video_frame_inherit__map" id="pp_1_1_video_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,32"></area></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classpp_1_1_video_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_video_frame.html#a2875cb170789aa00c3e9d5b3e96daa51">VideoFrame</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_video_frame.html#a00e462115cc543192cf8736373e72d51">VideoFrame</a> (const <a class="el" href="classpp_1_1_video_frame.html">VideoFrame</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_video_frame.html#aa3f0c75b3e71a5aa450bb59db405d7f2">VideoFrame</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_video_frame.html#a9174464e29af68a4b701469ad3ad8cba">VideoFrame</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_video_frame.html#af4f974572030ac92546b75a93a9e2b09">~VideoFrame</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_video_frame.html#ab2cfae58a6d08410ca7351bd123a6a66">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_video_frame.html#a1c77d15f28b8252dd711f2fc39448b41">SetTimestamp</a> (PP_TimeDelta timestamp)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PP_VideoFrame_Format&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_video_frame.html#ad03a1634ce404649f2f484159fd73be8">GetFormat</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_video_frame.html#a7d4026c03a06f519175406a55d254e60">GetSize</a> (<a class="el" href="classpp_1_1_size.html">Size</a> *size) 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_video_frame.html#abc019dddc8f073fb5ebb72e51a400f5e">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_video_frame.html#a9e993de4bf5349f3420a9e7dde2dd89f">GetDataBufferSize</a> () const </td></tr>
</table>
<hr /><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a2875cb170789aa00c3e9d5b3e96daa51"></a><!-- doxytag: member="pp::VideoFrame::VideoFrame" ref="a2875cb170789aa00c3e9d5b3e96daa51" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_video_frame.html#a2875cb170789aa00c3e9d5b3e96daa51">pp::VideoFrame::VideoFrame</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_video_frame.html">VideoFrame</a></code> object. </p>
</div>
</div>
<a class="anchor" id="a00e462115cc543192cf8736373e72d51"></a><!-- doxytag: member="pp::VideoFrame::VideoFrame" ref="a00e462115cc543192cf8736373e72d51" args="(const VideoFrame &amp;other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_video_frame.html#a2875cb170789aa00c3e9d5b3e96daa51">pp::VideoFrame::VideoFrame</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_video_frame.html">VideoFrame</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_video_frame.html">VideoFrame</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 a <code><a class="el" href="classpp_1_1_video_frame.html">VideoFrame</a></code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa3f0c75b3e71a5aa450bb59db405d7f2"></a><!-- doxytag: member="pp::VideoFrame::VideoFrame" ref="aa3f0c75b3e71a5aa450bb59db405d7f2" 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_video_frame.html#a2875cb170789aa00c3e9d5b3e96daa51">pp::VideoFrame::VideoFrame</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 a <code><a class="el" href="classpp_1_1_video_frame.html">VideoFrame</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_VideoFrame</code> resource. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9174464e29af68a4b701469ad3ad8cba"></a><!-- doxytag: member="pp::VideoFrame::VideoFrame" ref="a9174464e29af68a4b701469ad3ad8cba" 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_video_frame.html#a2875cb170789aa00c3e9d5b3e96daa51">pp::VideoFrame::VideoFrame</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_VideoFrame</code> resource. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af4f974572030ac92546b75a93a9e2b09"></a><!-- doxytag: member="pp::VideoFrame::~VideoFrame" ref="af4f974572030ac92546b75a93a9e2b09" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classpp_1_1_video_frame.html#af4f974572030ac92546b75a93a9e2b09">pp::VideoFrame::~VideoFrame</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="abc019dddc8f073fb5ebb72e51a400f5e"></a><!-- doxytag: member="pp::VideoFrame::GetDataBuffer" ref="abc019dddc8f073fb5ebb72e51a400f5e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="classpp_1_1_video_frame.html#abc019dddc8f073fb5ebb72e51a400f5e">pp::VideoFrame::GetDataBuffer</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the data buffer for video frame pixels. </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="a9e993de4bf5349f3420a9e7dde2dd89f"></a><!-- doxytag: member="pp::VideoFrame::GetDataBufferSize" ref="a9e993de4bf5349f3420a9e7dde2dd89f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="classpp_1_1_video_frame.html#a9e993de4bf5349f3420a9e7dde2dd89f">pp::VideoFrame::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="ad03a1634ce404649f2f484159fd73be8"></a><!-- doxytag: member="pp::VideoFrame::GetFormat" ref="ad03a1634ce404649f2f484159fd73be8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PP_VideoFrame_Format <a class="el" href="classpp_1_1_video_frame.html#ad03a1634ce404649f2f484159fd73be8">pp::VideoFrame::GetFormat</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the format of the video frame. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <code>PP_VideoFrame_Format</code> containing the format of the video frame. </dd></dl>
</div>
</div>
<a class="anchor" id="a7d4026c03a06f519175406a55d254e60"></a><!-- doxytag: member="pp::VideoFrame::GetSize" ref="a7d4026c03a06f519175406a55d254e60" args="(Size *size) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_video_frame.html#a7d4026c03a06f519175406a55d254e60">pp::VideoFrame::GetSize</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classpp_1_1_size.html">Size</a> *&#160;</td>
<td class="paramname"><em>size</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the size of the video frame. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">size</td><td>A <code><a class="el" href="classpp_1_1_size.html" title="A size of an object based on width and height.">Size</a></code>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>True on success or false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="ab2cfae58a6d08410ca7351bd123a6a66"></a><!-- doxytag: member="pp::VideoFrame::GetTimestamp" ref="ab2cfae58a6d08410ca7351bd123a6a66" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PP_TimeDelta <a class="el" href="classpp_1_1_video_frame.html#ab2cfae58a6d08410ca7351bd123a6a66">pp::VideoFrame::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 video frame. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <code>PP_TimeDelta</code> containing the timestamp of the video frame. Given in seconds since the start of the containing video stream. </dd></dl>
</div>
</div>
<a class="anchor" id="a1c77d15f28b8252dd711f2fc39448b41"></a><!-- doxytag: member="pp::VideoFrame::SetTimestamp" ref="a1c77d15f28b8252dd711f2fc39448b41" 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_video_frame.html#a1c77d15f28b8252dd711f2fc39448b41">pp::VideoFrame::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 video 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 video frame. Given in seconds since the start of the containing video 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="video__frame_8h.html">video_frame.h</a></li>
</ul>
</div><!-- contents -->
</div>
{{/partials.standard_nacl_api}}