src/native_client_sdk/doc_generated/pepper_stable/cpp/classpp_1_1_video_frame.html

   1 {{+bindTo:partials.standard_nacl_api}}
   2 <h1>pp::VideoFrame 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::VideoFrame" --><!-- doxytag: inherits="pp::Resource" --><div class="dynheader">
  14 Inheritance diagram for pp::VideoFrame:</div>
  15 <div class="dyncontent">
  16 <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>
  17 <map name="pp_1_1_video_frame_inherit__map" id="pp_1_1_video_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,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_video_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_video_frame.html#a2875cb170789aa00c3e9d5b3e96daa51">VideoFrame</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_video_frame.html#a00e462115cc543192cf8736373e72d51">VideoFrame</a> (const <a class="el" href="classpp_1_1_video_frame.html">VideoFrame</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_video_frame.html#aa3f0c75b3e71a5aa450bb59db405d7f2">VideoFrame</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_video_frame.html#a9174464e29af68a4b701469ad3ad8cba">VideoFrame</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_video_frame.html#af4f974572030ac92546b75a93a9e2b09">~VideoFrame</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_video_frame.html#ab2cfae58a6d08410ca7351bd123a6a66">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_video_frame.html#a1c77d15f28b8252dd711f2fc39448b41">SetTimestamp</a> (PP_TimeDelta timestamp)</td></tr>
  31 <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>
  32 <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>
  33 <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>
  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_video_frame.html#a9e993de4bf5349f3420a9e7dde2dd89f">GetDataBufferSize</a> () const </td></tr>
  35 </table>
  36 <hr /><h2>Constructor &amp; Destructor Documentation</h2>
  37 <a class="anchor" id="a2875cb170789aa00c3e9d5b3e96daa51"></a><!-- doxytag: member="pp::VideoFrame::VideoFrame" ref="a2875cb170789aa00c3e9d5b3e96daa51" args="()" -->
  38 <div class="memitem">
  39 <div class="memproto">
  40 <table class="memname">
  41 <tr>
  42 <td class="memname"><a class="el" href="classpp_1_1_video_frame.html#a2875cb170789aa00c3e9d5b3e96daa51">pp::VideoFrame::VideoFrame</a> </td>
  43 <td>(</td>
  44 <td class="paramname"></td><td>)</td>
  45 <td></td>
  46 </tr>
  47 </table>
  48 </div>
  49 <div class="memdoc">
  50 <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>
  51 </div>
  52 </div>
  53 <a class="anchor" id="a00e462115cc543192cf8736373e72d51"></a><!-- doxytag: member="pp::VideoFrame::VideoFrame" ref="a00e462115cc543192cf8736373e72d51" args="(const VideoFrame &amp;other)" -->
  54 <div class="memitem">
  55 <div class="memproto">
  56 <table class="memname">
  57 <tr>
  58 <td class="memname"><a class="el" href="classpp_1_1_video_frame.html#a2875cb170789aa00c3e9d5b3e96daa51">pp::VideoFrame::VideoFrame</a> </td>
  59 <td>(</td>
  60 <td class="paramtype">const <a class="el" href="classpp_1_1_video_frame.html">VideoFrame</a> &amp;&#160;</td>
  61 <td class="paramname"><em>other</em></td><td>)</td>
  62 <td></td>
  63 </tr>
  64 </table>
  65 </div>
  66 <div class="memdoc">
  67 <p>The copy constructor for <code><a class="el" href="classpp_1_1_video_frame.html">VideoFrame</a></code>. </p>
  68 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  69 <table class="params">
  70 <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>
  71 </table>
  72 </dd>
  73 </dl>
  74 </div>
  75 </div>
  76 <a class="anchor" id="aa3f0c75b3e71a5aa450bb59db405d7f2"></a><!-- doxytag: member="pp::VideoFrame::VideoFrame" ref="aa3f0c75b3e71a5aa450bb59db405d7f2" args="(const Resource &amp;resource)" -->
  77 <div class="memitem">
  78 <div class="memproto">
  79 <table class="memname">
  80 <tr>
  81 <td class="memname"><a class="el" href="classpp_1_1_video_frame.html#a2875cb170789aa00c3e9d5b3e96daa51">pp::VideoFrame::VideoFrame</a> </td>
  82 <td>(</td>
  83 <td class="paramtype">const <a class="el" href="classpp_1_1_resource.html">Resource</a> &amp;&#160;</td>
  84 <td class="paramname"><em>resource</em></td><td>)</td>
  85 <td><code> [explicit]</code></td>
  86 </tr>
  87 </table>
  88 </div>
  89 <div class="memdoc">
  90 <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>
  91 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  92 <table class="params">
  93 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PPB_VideoFrame</code> resource. </td></tr>
  94 </table>
  95 </dd>
  96 </dl>
  97 </div>
  98 </div>
  99 <a class="anchor" id="a9174464e29af68a4b701469ad3ad8cba"></a><!-- doxytag: member="pp::VideoFrame::VideoFrame" ref="a9174464e29af68a4b701469ad3ad8cba" args="(PassRef, PP_Resource resource)" -->
 100 <div class="memitem">
 101 <div class="memproto">
 102 <table class="memname">
 103 <tr>
 104 <td class="memname"><a class="el" href="classpp_1_1_video_frame.html#a2875cb170789aa00c3e9d5b3e96daa51">pp::VideoFrame::VideoFrame</a> </td>
 105 <td>(</td>
 106 <td class="paramtype"><a class="el" href="namespacepp.html#a339083c1beec620267bf8b3c55decaa5">PassRef</a>&#160;</td>
 107 <td class="paramname">, </td>
 108 </tr>
 109 <tr>
 110 <td class="paramkey"></td>
 111 <td></td>
 112 <td class="paramtype">PP_Resource&#160;</td>
 113 <td class="paramname"><em>resource</em>&#160;</td>
 114 </tr>
 115 <tr>
 116 <td></td>
 117 <td>)</td>
 118 <td></td><td></td>
 119 </tr>
 120 </table>
 121 </div>
 122 <div class="memdoc">
 123 <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>
 124 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 125 <table class="params">
 126 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PPB_VideoFrame</code> resource. </td></tr>
 127 </table>
 128 </dd>
 129 </dl>
 130 </div>
 131 </div>
 132 <a class="anchor" id="af4f974572030ac92546b75a93a9e2b09"></a><!-- doxytag: member="pp::VideoFrame::~VideoFrame" ref="af4f974572030ac92546b75a93a9e2b09" args="()" -->
 133 <div class="memitem">
 134 <div class="memproto">
 135 <table class="memname">
 136 <tr>
 137 <td class="memname">virtual <a class="el" href="classpp_1_1_video_frame.html#af4f974572030ac92546b75a93a9e2b09">pp::VideoFrame::~VideoFrame</a> </td>
 138 <td>(</td>
 139 <td class="paramname"></td><td>)</td>
 140 <td><code> [virtual]</code></td>
 141 </tr>
 142 </table>
 143 </div>
 144 <div class="memdoc">
 145 </div>
 146 </div>
 147 <hr /><h2>Member Function Documentation</h2>
 148 <a class="anchor" id="abc019dddc8f073fb5ebb72e51a400f5e"></a><!-- doxytag: member="pp::VideoFrame::GetDataBuffer" ref="abc019dddc8f073fb5ebb72e51a400f5e" args="()" -->
 149 <div class="memitem">
 150 <div class="memproto">
 151 <table class="memname">
 152 <tr>
 153 <td class="memname">void* <a class="el" href="classpp_1_1_video_frame.html#abc019dddc8f073fb5ebb72e51a400f5e">pp::VideoFrame::GetDataBuffer</a> </td>
 154 <td>(</td>
 155 <td class="paramname"></td><td>)</td>
 156 <td></td>
 157 </tr>
 158 </table>
 159 </div>
 160 <div class="memdoc">
 161 <p>Gets the data buffer for video frame pixels. </p>
 162 <dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the beginning of the data buffer. </dd></dl>
 163 </div>
 164 </div>
 165 <a class="anchor" id="a9e993de4bf5349f3420a9e7dde2dd89f"></a><!-- doxytag: member="pp::VideoFrame::GetDataBufferSize" ref="a9e993de4bf5349f3420a9e7dde2dd89f" args="() const " -->
 166 <div class="memitem">
 167 <div class="memproto">
 168 <table class="memname">
 169 <tr>
 170 <td class="memname">uint32_t <a class="el" href="classpp_1_1_video_frame.html#a9e993de4bf5349f3420a9e7dde2dd89f">pp::VideoFrame::GetDataBufferSize</a> </td>
 171 <td>(</td>
 172 <td class="paramname"></td><td>)</td>
 173 <td> const</td>
 174 </tr>
 175 </table>
 176 </div>
 177 <div class="memdoc">
 178 <p>Gets the size of data buffer in bytes. </p>
 179 <dl class="return"><dt><b>Returns:</b></dt><dd>The size of the data buffer in bytes. </dd></dl>
 180 </div>
 181 </div>
 182 <a class="anchor" id="ad03a1634ce404649f2f484159fd73be8"></a><!-- doxytag: member="pp::VideoFrame::GetFormat" ref="ad03a1634ce404649f2f484159fd73be8" args="() const " -->
 183 <div class="memitem">
 184 <div class="memproto">
 185 <table class="memname">
 186 <tr>
 187 <td class="memname">PP_VideoFrame_Format <a class="el" href="classpp_1_1_video_frame.html#ad03a1634ce404649f2f484159fd73be8">pp::VideoFrame::GetFormat</a> </td>
 188 <td>(</td>
 189 <td class="paramname"></td><td>)</td>
 190 <td> const</td>
 191 </tr>
 192 </table>
 193 </div>
 194 <div class="memdoc">
 195 <p>Gets the format of the video frame. </p>
 196 <dl class="return"><dt><b>Returns:</b></dt><dd>A <code>PP_VideoFrame_Format</code> containing the format of the video frame. </dd></dl>
 197 </div>
 198 </div>
 199 <a class="anchor" id="a7d4026c03a06f519175406a55d254e60"></a><!-- doxytag: member="pp::VideoFrame::GetSize" ref="a7d4026c03a06f519175406a55d254e60" args="(Size *size) const " -->
 200 <div class="memitem">
 201 <div class="memproto">
 202 <table class="memname">
 203 <tr>
 204 <td class="memname">bool <a class="el" href="classpp_1_1_video_frame.html#a7d4026c03a06f519175406a55d254e60">pp::VideoFrame::GetSize</a> </td>
 205 <td>(</td>
 206 <td class="paramtype"><a class="el" href="classpp_1_1_size.html">Size</a> *&#160;</td>
 207 <td class="paramname"><em>size</em></td><td>)</td>
 208 <td> const</td>
 209 </tr>
 210 </table>
 211 </div>
 212 <div class="memdoc">
 213 <p>Gets the size of the video frame. </p>
 214 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 215 <table class="params">
 216 <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>
 217 </table>
 218 </dd>
 219 </dl>
 220 <dl class="return"><dt><b>Returns:</b></dt><dd>True on success or false on failure. </dd></dl>
 221 </div>
 222 </div>
 223 <a class="anchor" id="ab2cfae58a6d08410ca7351bd123a6a66"></a><!-- doxytag: member="pp::VideoFrame::GetTimestamp" ref="ab2cfae58a6d08410ca7351bd123a6a66" args="() const " -->
 224 <div class="memitem">
 225 <div class="memproto">
 226 <table class="memname">
 227 <tr>
 228 <td class="memname">PP_TimeDelta <a class="el" href="classpp_1_1_video_frame.html#ab2cfae58a6d08410ca7351bd123a6a66">pp::VideoFrame::GetTimestamp</a> </td>
 229 <td>(</td>
 230 <td class="paramname"></td><td>)</td>
 231 <td> const</td>
 232 </tr>
 233 </table>
 234 </div>
 235 <div class="memdoc">
 236 <p>Gets the timestamp of the video frame. </p>
 237 <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>
 238 </div>
 239 </div>
 240 <a class="anchor" id="a1c77d15f28b8252dd711f2fc39448b41"></a><!-- doxytag: member="pp::VideoFrame::SetTimestamp" ref="a1c77d15f28b8252dd711f2fc39448b41" args="(PP_TimeDelta timestamp)" -->
 241 <div class="memitem">
 242 <div class="memproto">
 243 <table class="memname">
 244 <tr>
 245 <td class="memname">void <a class="el" href="classpp_1_1_video_frame.html#a1c77d15f28b8252dd711f2fc39448b41">pp::VideoFrame::SetTimestamp</a> </td>
 246 <td>(</td>
 247 <td class="paramtype">PP_TimeDelta&#160;</td>
 248 <td class="paramname"><em>timestamp</em></td><td>)</td>
 249 <td></td>
 250 </tr>
 251 </table>
 252 </div>
 253 <div class="memdoc">
 254 <p>Sets the timestamp of the video frame. </p>
 255 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 256 <table class="params">
 257 <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>
 258 </table>
 259 </dd>
 260 </dl>
 261 </div>
 262 </div>
 263 <hr />The documentation for this class was generated from the following file:<ul>
 264 <li><a class="el" href="video__frame_8h.html">video_frame.h</a></li>
 265 </ul>
 266 </div><!-- contents -->
 267 </div>
 268 {{/partials.standard_nacl_api}}