native_client_sdk/doc_generated/pepper_dev/c/struct_p_p_b___video_frame__0__1.html

{{+bindTo:partials.standard_nacl_api}}
<h1>PPB_VideoFrame Struct 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="PPB_VideoFrame" --><h2>
Data Fields</h2><table class="memberdecls">

<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___video_frame__0__1.html#a4b1d739620b38f0c02eb93f5e3ab95f2">IsVideoFrame</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___typedefs.html#ga3962a5355895925a757f613567e422fa">PP_TimeDelta</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___video_frame__0__1.html#ac489deabb1c82426ad1d58be078cfb26">GetTimestamp</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> frame)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___video_frame__0__1.html#a01d82a532ca1f1158b82862cb94c586d">SetTimestamp</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> frame, <a class="el" href="group___typedefs.html#ga3962a5355895925a757f613567e422fa">PP_TimeDelta</a> timestamp)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga4e7cf746d8acbfa268db1f5ebe8061bf">PP_VideoFrame_Format</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___video_frame__0__1.html#a62323240cc59ea9fd8725a44c69b17c6">GetFormat</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> frame)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___video_frame__0__1.html#a6ddf0fe2f254810d969eda729db095d9">GetSize</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> frame, struct <a class="el" href="struct_p_p___size.html">PP_Size</a> *size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___video_frame__0__1.html#a01acb2d82746ce41c37d69a74c055ce0">GetDataBuffer</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> frame)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___video_frame__0__1.html#a29e5e9e9bb2abc0563b1e9ecbc4c880c">GetDataBufferSize</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> frame)</td></tr>
</table>
<hr /><h2>Field Documentation</h2>
<a class="anchor" id="a01acb2d82746ce41c37d69a74c055ce0"></a><!-- doxytag: member="PPB_VideoFrame::GetDataBuffer" ref="a01acb2d82746ce41c37d69a74c055ce0" args=")(PP_Resource frame)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void*(* <a class="el" href="struct_p_p_b___video_frame__0__1.html#a01acb2d82746ce41c37d69a74c055ce0">PPB_VideoFrame::GetDataBuffer</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> frame)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the data buffer for video frame pixels. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">frame</td><td>A <code>PP_Resource</code> corresponding to a video frame resource.</td></tr>
</table>
</dd>
</dl>
<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="a29e5e9e9bb2abc0563b1e9ecbc4c880c"></a><!-- doxytag: member="PPB_VideoFrame::GetDataBufferSize" ref="a29e5e9e9bb2abc0563b1e9ecbc4c880c" args=")(PP_Resource frame)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t(* <a class="el" href="struct_p_p_b___video_frame__0__1.html#a29e5e9e9bb2abc0563b1e9ecbc4c880c">PPB_VideoFrame::GetDataBufferSize</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> frame)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the size of data buffer. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">frame</td><td>A <code>PP_Resource</code> corresponding to a video frame resource.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The size of the data buffer. </dd></dl>
</div>
</div>
<a class="anchor" id="a62323240cc59ea9fd8725a44c69b17c6"></a><!-- doxytag: member="PPB_VideoFrame::GetFormat" ref="a62323240cc59ea9fd8725a44c69b17c6" args=")(PP_Resource frame)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___enums.html#ga4e7cf746d8acbfa268db1f5ebe8061bf">PP_VideoFrame_Format</a>(* <a class="el" href="struct_p_p_b___video_frame__0__1.html#a62323240cc59ea9fd8725a44c69b17c6">PPB_VideoFrame::GetFormat</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> frame)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the format 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">frame</td><td>A <code>PP_Resource</code> corresponding to a video frame resource.</td></tr>
</table>
</dd>
</dl>
<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="a6ddf0fe2f254810d969eda729db095d9"></a><!-- doxytag: member="PPB_VideoFrame::GetSize" ref="a6ddf0fe2f254810d969eda729db095d9" args=")(PP_Resource frame, struct PP_Size *size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* <a class="el" href="struct_p_p_b___video_frame__0__1.html#a6ddf0fe2f254810d969eda729db095d9">PPB_VideoFrame::GetSize</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> frame, struct <a class="el" href="struct_p_p___size.html">PP_Size</a> *size)</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">[in]</td><td class="paramname">frame</td><td>A <code>PP_Resource</code> corresponding to a video frame resource. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">size</td><td>A <code><a class="el" href="struct_p_p___size.html" title="The PP_Size struct contains the size of a 2D rectangle.">PP_Size</a></code>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <code>PP_Bool</code> with <code>PP_TRUE</code> on success or <code>PP_FALSE</code> on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="ac489deabb1c82426ad1d58be078cfb26"></a><!-- doxytag: member="PPB_VideoFrame::GetTimestamp" ref="ac489deabb1c82426ad1d58be078cfb26" args=")(PP_Resource frame)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___typedefs.html#ga3962a5355895925a757f613567e422fa">PP_TimeDelta</a>(* <a class="el" href="struct_p_p_b___video_frame__0__1.html#ac489deabb1c82426ad1d58be078cfb26">PPB_VideoFrame::GetTimestamp</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> frame)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets 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">frame</td><td>A <code>PP_Resource</code> corresponding to a video frame resource.</td></tr>
</table>
</dd>
</dl>
<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="a4b1d739620b38f0c02eb93f5e3ab95f2"></a><!-- doxytag: member="PPB_VideoFrame::IsVideoFrame" ref="a4b1d739620b38f0c02eb93f5e3ab95f2" args=")(PP_Resource resource)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* <a class="el" href="struct_p_p_b___video_frame__0__1.html#a4b1d739620b38f0c02eb93f5e3ab95f2">PPB_VideoFrame::IsVideoFrame</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determines if a resource is a VideoFrame resource. </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>The <code>PP_Resource</code> to test.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <code>PP_Bool</code> with <code>PP_TRUE</code> if the given resource is a VideoFrame resource or <code>PP_FALSE</code> otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a01d82a532ca1f1158b82862cb94c586d"></a><!-- doxytag: member="PPB_VideoFrame::SetTimestamp" ref="a01d82a532ca1f1158b82862cb94c586d" args=")(PP_Resource frame, PP_TimeDelta timestamp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* <a class="el" href="struct_p_p_b___video_frame__0__1.html#a01d82a532ca1f1158b82862cb94c586d">PPB_VideoFrame::SetTimestamp</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> frame, <a class="el" href="group___typedefs.html#ga3962a5355895925a757f613567e422fa">PP_TimeDelta</a> timestamp)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the timestamp of the video frame. </p>
<p>Given in seconds since the start of the containing video stream.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">frame</td><td>A <code>PP_Resource</code> corresponding to a video frame resource. </td></tr>
<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 struct was generated from the following file:<ul>
<li><a class="el" href="ppb__video__frame_8h.html">ppb_video_frame.h</a></li>
</ul>
</div><!-- contents -->
</div>
{{/partials.standard_nacl_api}}