1 {{+bindTo:partials.standard_nacl_article}}
2 <h1>PPB_VideoFrame Struct Reference</h1>
4 {{- dummy div to appease doxygen -}}
6 <!-- Generated by Doxygen 1.7.6.1 -->
11 <div class="contents">
12 <!-- doxytag: class="PPB_VideoFrame" --><h2>
13 Data Fields</h2><table class="memberdecls">
15 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* </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>
16 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___typedefs.html#ga3962a5355895925a757f613567e422fa">PP_TimeDelta</a>(* </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>
17 <tr><td class="memItemLeft" align="right" valign="top">void(* </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>
18 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga4e7cf746d8acbfa268db1f5ebe8061bf">PP_VideoFrame_Format</a>(* </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>
19 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* </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>
20 <tr><td class="memItemLeft" align="right" valign="top">void *(* </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>
21 <tr><td class="memItemLeft" align="right" valign="top">uint32_t(* </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>
23 <hr /><h2>Field Documentation</h2>
24 <a class="anchor" id="a01acb2d82746ce41c37d69a74c055ce0"></a><!-- doxytag: member="PPB_VideoFrame::GetDataBuffer" ref="a01acb2d82746ce41c37d69a74c055ce0" args=")(PP_Resource frame)" -->
26 <div class="memproto">
27 <table class="memname">
29 <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>
34 <p>Gets the data buffer for video frame pixels. </p>
35 <dl class="params"><dt><b>Parameters:</b></dt><dd>
36 <table class="params">
37 <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>
41 <dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the beginning of the data buffer. </dd></dl>
44 <a class="anchor" id="a29e5e9e9bb2abc0563b1e9ecbc4c880c"></a><!-- doxytag: member="PPB_VideoFrame::GetDataBufferSize" ref="a29e5e9e9bb2abc0563b1e9ecbc4c880c" args=")(PP_Resource frame)" -->
46 <div class="memproto">
47 <table class="memname">
49 <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>
54 <p>Gets the size of data buffer. </p>
55 <dl class="params"><dt><b>Parameters:</b></dt><dd>
56 <table class="params">
57 <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>
61 <dl class="return"><dt><b>Returns:</b></dt><dd>The size of the data buffer. </dd></dl>
64 <a class="anchor" id="a62323240cc59ea9fd8725a44c69b17c6"></a><!-- doxytag: member="PPB_VideoFrame::GetFormat" ref="a62323240cc59ea9fd8725a44c69b17c6" args=")(PP_Resource frame)" -->
66 <div class="memproto">
67 <table class="memname">
69 <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>
74 <p>Gets the format of the video frame. </p>
75 <dl class="params"><dt><b>Parameters:</b></dt><dd>
76 <table class="params">
77 <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>
81 <dl class="return"><dt><b>Returns:</b></dt><dd>A <code>PP_VideoFrame_Format</code> containing the format of the video frame. </dd></dl>
84 <a class="anchor" id="a6ddf0fe2f254810d969eda729db095d9"></a><!-- doxytag: member="PPB_VideoFrame::GetSize" ref="a6ddf0fe2f254810d969eda729db095d9" args=")(PP_Resource frame, struct PP_Size *size)" -->
86 <div class="memproto">
87 <table class="memname">
89 <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>
94 <p>Gets the size of the video frame. </p>
95 <dl class="params"><dt><b>Parameters:</b></dt><dd>
96 <table class="params">
97 <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>
98 <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>
102 <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>
105 <a class="anchor" id="ac489deabb1c82426ad1d58be078cfb26"></a><!-- doxytag: member="PPB_VideoFrame::GetTimestamp" ref="ac489deabb1c82426ad1d58be078cfb26" args=")(PP_Resource frame)" -->
106 <div class="memitem">
107 <div class="memproto">
108 <table class="memname">
110 <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>
115 <p>Gets the timestamp of the video frame. </p>
116 <dl class="params"><dt><b>Parameters:</b></dt><dd>
117 <table class="params">
118 <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>
122 <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>
125 <a class="anchor" id="a4b1d739620b38f0c02eb93f5e3ab95f2"></a><!-- doxytag: member="PPB_VideoFrame::IsVideoFrame" ref="a4b1d739620b38f0c02eb93f5e3ab95f2" args=")(PP_Resource resource)" -->
126 <div class="memitem">
127 <div class="memproto">
128 <table class="memname">
130 <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>
135 <p>Determines if a resource is a VideoFrame resource. </p>
136 <dl class="params"><dt><b>Parameters:</b></dt><dd>
137 <table class="params">
138 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>The <code>PP_Resource</code> to test.</td></tr>
142 <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>
145 <a class="anchor" id="a01d82a532ca1f1158b82862cb94c586d"></a><!-- doxytag: member="PPB_VideoFrame::SetTimestamp" ref="a01d82a532ca1f1158b82862cb94c586d" args=")(PP_Resource frame, PP_TimeDelta timestamp)" -->
146 <div class="memitem">
147 <div class="memproto">
148 <table class="memname">
150 <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>
155 <p>Sets the timestamp of the video frame. </p>
156 <p>Given in seconds since the start of the containing video stream.</p>
157 <dl class="params"><dt><b>Parameters:</b></dt><dd>
158 <table class="params">
159 <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>
160 <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>
166 <hr />The documentation for this struct was generated from the following file:<ul>
167 <li><a class="el" href="ppb__video__frame_8h.html">ppb_video_frame.h</a></li>
169 </div><!-- contents -->
171 {{/partials.standard_nacl_article}}