<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>gstreamermm: Gst::VideoFrame Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-extra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">gstreamermm
 <span id="projectnumber">1.10.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceGst.html">Gst</a></li><li class="navelem"><a class="el" href="classGst_1_1VideoFrame.html">VideoFrame</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classGst_1_1VideoFrame-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Gst::VideoFrame Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <gstreamermm/videoframe.h></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab119ebb525a1d956ba228d4726179eda"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoFrame.html#ab119ebb525a1d956ba228d4726179eda">VideoFrame</a> ()</td></tr>
<tr class="separator:ab119ebb525a1d956ba228d4726179eda"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a839533a2cfacead609b65ff5e592377e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoFrame.html#a839533a2cfacead609b65ff5e592377e">VideoFrame</a> (const GstVideoFrame* gobject)</td></tr>
<tr class="separator:a839533a2cfacead609b65ff5e592377e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a93fc637fc8b4b2aff29300877f668b35"><td class="memItemLeft" align="right" valign="top">GstVideoFrame* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoFrame.html#a93fc637fc8b4b2aff29300877f668b35">gobj</a> ()</td></tr>
<tr class="memdesc:a93fc637fc8b4b2aff29300877f668b35"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. <a href="#a93fc637fc8b4b2aff29300877f668b35">More...</a><br /></td></tr>
<tr class="separator:a93fc637fc8b4b2aff29300877f668b35"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a011096ac9308c7845cd2cfe353625fab"><td class="memItemLeft" align="right" valign="top">const GstVideoFrame* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoFrame.html#a011096ac9308c7845cd2cfe353625fab">gobj</a> () const</td></tr>
<tr class="memdesc:a011096ac9308c7845cd2cfe353625fab"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. <a href="#a011096ac9308c7845cd2cfe353625fab">More...</a><br /></td></tr>
<tr class="separator:a011096ac9308c7845cd2cfe353625fab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a246daf6ab966d35b9bcea2056a248586"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoFrame.html#a246daf6ab966d35b9bcea2056a248586">map</a> (const <a class="el" href="classGst_1_1VideoInfo.html">Gst::VideoInfo</a>& info, const Glib::RefPtr< <a class="el" href="classGst_1_1Buffer.html">Gst::Buffer</a> >& buffer, <a class="el" href="group__gstreamermmEnums.html#gaee5716e12b88f74c183e50de377d624a">Gst::MapFlags</a> flags)</td></tr>
<tr class="memdesc:a246daf6ab966d35b9bcea2056a248586"><td class="mdescLeft"> </td><td class="mdescRight">Use <em>info</em> and <em>buffer</em> to fill in the values of <em>frame</em>. <a href="#a246daf6ab966d35b9bcea2056a248586">More...</a><br /></td></tr>
<tr class="separator:a246daf6ab966d35b9bcea2056a248586"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad7d67dd611b82abfe440647d30d0f1f9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoFrame.html#ad7d67dd611b82abfe440647d30d0f1f9">map_id</a> (const <a class="el" href="classGst_1_1VideoInfo.html">Gst::VideoInfo</a>& info, const Glib::RefPtr< <a class="el" href="classGst_1_1Buffer.html">Gst::Buffer</a> >& buffer, gint id, <a class="el" href="group__gstreamermmEnums.html#gaee5716e12b88f74c183e50de377d624a">Gst::MapFlags</a> flags)</td></tr>
<tr class="memdesc:ad7d67dd611b82abfe440647d30d0f1f9"><td class="mdescLeft"> </td><td class="mdescRight">Use <em>info</em> and <em>buffer</em> to fill in the values of <em>frame</em> with the video frame information of frame <em>id</em>. <a href="#ad7d67dd611b82abfe440647d30d0f1f9">More...</a><br /></td></tr>
<tr class="separator:ad7d67dd611b82abfe440647d30d0f1f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6725a00e8d1ce2eddde61d51aa6814b1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoFrame.html#a6725a00e8d1ce2eddde61d51aa6814b1">unmap</a> ()</td></tr>
<tr class="memdesc:a6725a00e8d1ce2eddde61d51aa6814b1"><td class="mdescLeft"> </td><td class="mdescRight">Unmap the memory previously mapped with gst_video_frame_map. <a href="#a6725a00e8d1ce2eddde61d51aa6814b1">More...</a><br /></td></tr>
<tr class="separator:a6725a00e8d1ce2eddde61d51aa6814b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a676f23de6da267107621bd97f6628c02"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoFrame.html#a676f23de6da267107621bd97f6628c02">set_info</a> (const <a class="el" href="classGst_1_1VideoInfo.html">Gst::VideoInfo</a>& value)</td></tr>
<tr class="separator:a676f23de6da267107621bd97f6628c02"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a66263b17a09b61d42657ce18abf0e337"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGst_1_1VideoInfo.html">Gst::VideoInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoFrame.html#a66263b17a09b61d42657ce18abf0e337">get_info</a> () const</td></tr>
<tr class="separator:a66263b17a09b61d42657ce18abf0e337"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb10b8d776ad7d61431c918fd1b2ccf7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoFrame.html#abb10b8d776ad7d61431c918fd1b2ccf7">set_flags</a> (const <a class="el" href="group__gstreamermmEnums.html#ga5aa12f05da8c93d064ed5a0a2661ca69">Gst::VideoFrameFlags</a>& value)</td></tr>
<tr class="separator:abb10b8d776ad7d61431c918fd1b2ccf7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac3934b04a425e7db7b3532aa4f8528d2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__gstreamermmEnums.html#ga5aa12f05da8c93d064ed5a0a2661ca69">Gst::VideoFrameFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoFrame.html#ac3934b04a425e7db7b3532aa4f8528d2">get_flags</a> () const</td></tr>
<tr class="separator:ac3934b04a425e7db7b3532aa4f8528d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a448a8f35e39c054ff49aad8bd63bcc44"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoFrame.html#a448a8f35e39c054ff49aad8bd63bcc44">set_buffer</a> (const Glib::RefPtr< <a class="el" href="classGst_1_1Buffer.html">Gst::Buffer</a> >& value)</td></tr>
<tr class="separator:a448a8f35e39c054ff49aad8bd63bcc44"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad70c62622aa045b0e0374b6d301f8d98"><td class="memItemLeft" align="right" valign="top">Glib::RefPtr< <a class="el" href="classGst_1_1Buffer.html">Gst::Buffer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoFrame.html#ad70c62622aa045b0e0374b6d301f8d98">get_buffer</a> () const</td></tr>
<tr class="separator:ad70c62622aa045b0e0374b6d301f8d98"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a4886b8a327c4e0294f19b17827a4d7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoFrame.html#a2a4886b8a327c4e0294f19b17827a4d7">set_meta</a> (const gpointer& value)</td></tr>
<tr class="separator:a2a4886b8a327c4e0294f19b17827a4d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5a91f218685a1b67eed6283c73a2d7ff"><td class="memItemLeft" align="right" valign="top">gpointer </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoFrame.html#a5a91f218685a1b67eed6283c73a2d7ff">get_meta</a> () const</td></tr>
<tr class="separator:a5a91f218685a1b67eed6283c73a2d7ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a55de8595faeebcd2b3db9107b2354625"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoFrame.html#a55de8595faeebcd2b3db9107b2354625">set_id</a> (const gint& value)</td></tr>
<tr class="separator:a55de8595faeebcd2b3db9107b2354625"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9c5e3d5f322cdddd90ab1c66d87464d7"><td class="memItemLeft" align="right" valign="top">gint </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoFrame.html#a9c5e3d5f322cdddd90ab1c66d87464d7">get_id</a> () const</td></tr>
<tr class="separator:a9c5e3d5f322cdddd90ab1c66d87464d7"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a0580222fa1d337ff95f06dfb6597cc86"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoFrame.html#a0580222fa1d337ff95f06dfb6597cc86">copy</a> (const <a class="el" href="classGst_1_1VideoFrame.html">Gst::VideoFrame</a>& dest, const <a class="el" href="classGst_1_1VideoFrame.html">Gst::VideoFrame</a>& src)</td></tr>
<tr class="memdesc:a0580222fa1d337ff95f06dfb6597cc86"><td class="mdescLeft"> </td><td class="mdescRight">Copy the contents from <em>src</em> to <em>dest</em>. <a href="#a0580222fa1d337ff95f06dfb6597cc86">More...</a><br /></td></tr>
<tr class="separator:a0580222fa1d337ff95f06dfb6597cc86"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af2f3637a86f3a1302cfcd48ec821d1cd"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoFrame.html#af2f3637a86f3a1302cfcd48ec821d1cd">copy_plane</a> (const <a class="el" href="classGst_1_1VideoFrame.html">Gst::VideoFrame</a>& dest, const <a class="el" href="classGst_1_1VideoFrame.html">Gst::VideoFrame</a>& src, guint plane)</td></tr>
<tr class="memdesc:af2f3637a86f3a1302cfcd48ec821d1cd"><td class="mdescLeft"> </td><td class="mdescRight">Copy the plane with index <em>plane</em> from <em>src</em> to <em>dest</em>. <a href="#af2f3637a86f3a1302cfcd48ec821d1cd">More...</a><br /></td></tr>
<tr class="separator:af2f3637a86f3a1302cfcd48ec821d1cd"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a3cda5b4e3c2b0517c4b16e6ed1c21324"><td class="memItemLeft" align="right" valign="top">GstVideoFrame </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoFrame.html#a3cda5b4e3c2b0517c4b16e6ed1c21324">gobject_</a></td></tr>
<tr class="separator:a3cda5b4e3c2b0517c4b16e6ed1c21324"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ab119ebb525a1d956ba228d4726179eda"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab119ebb525a1d956ba228d4726179eda">◆ </a></span>VideoFrame() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gst::VideoFrame::VideoFrame </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a839533a2cfacead609b65ff5e592377e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a839533a2cfacead609b65ff5e592377e">◆ </a></span>VideoFrame() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Gst::VideoFrame::VideoFrame </td>
<td>(</td>
<td class="paramtype">const GstVideoFrame * </td>
<td class="paramname"><em>gobject</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a0580222fa1d337ff95f06dfb6597cc86"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0580222fa1d337ff95f06dfb6597cc86">◆ </a></span>copy()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool Gst::VideoFrame::copy </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGst_1_1VideoFrame.html">Gst::VideoFrame</a>& </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classGst_1_1VideoFrame.html">Gst::VideoFrame</a>& </td>
<td class="paramname"><em>src</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy the contents from <em>src</em> to <em>dest</em>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dest</td><td>A <a class="el" href="classGst_1_1VideoFrame.html">Gst::VideoFrame</a>. </td></tr>
<tr><td class="paramname">src</td><td>A <a class="el" href="classGst_1_1VideoFrame.html">Gst::VideoFrame</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the contents could be copied. </dd></dl>
</div>
</div>
<a id="af2f3637a86f3a1302cfcd48ec821d1cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2f3637a86f3a1302cfcd48ec821d1cd">◆ </a></span>copy_plane()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool Gst::VideoFrame::copy_plane </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGst_1_1VideoFrame.html">Gst::VideoFrame</a>& </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classGst_1_1VideoFrame.html">Gst::VideoFrame</a>& </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">guint </td>
<td class="paramname"><em>plane</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy the plane with index <em>plane</em> from <em>src</em> to <em>dest</em>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dest</td><td>A <a class="el" href="classGst_1_1VideoFrame.html">Gst::VideoFrame</a>. </td></tr>
<tr><td class="paramname">src</td><td>A <a class="el" href="classGst_1_1VideoFrame.html">Gst::VideoFrame</a>. </td></tr>
<tr><td class="paramname">plane</td><td>A plane. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the contents could be copied. </dd></dl>
</div>
</div>
<a id="ad70c62622aa045b0e0374b6d301f8d98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad70c62622aa045b0e0374b6d301f8d98">◆ </a></span>get_buffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Glib::RefPtr<<a class="el" href="classGst_1_1Buffer.html">Gst::Buffer</a>> Gst::VideoFrame::get_buffer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ac3934b04a425e7db7b3532aa4f8528d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3934b04a425e7db7b3532aa4f8528d2">◆ </a></span>get_flags()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__gstreamermmEnums.html#ga5aa12f05da8c93d064ed5a0a2661ca69">Gst::VideoFrameFlags</a> Gst::VideoFrame::get_flags </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a9c5e3d5f322cdddd90ab1c66d87464d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c5e3d5f322cdddd90ab1c66d87464d7">◆ </a></span>get_id()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gint Gst::VideoFrame::get_id </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a66263b17a09b61d42657ce18abf0e337"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66263b17a09b61d42657ce18abf0e337">◆ </a></span>get_info()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGst_1_1VideoInfo.html">Gst::VideoInfo</a> Gst::VideoFrame::get_info </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a5a91f218685a1b67eed6283c73a2d7ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a91f218685a1b67eed6283c73a2d7ff">◆ </a></span>get_meta()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gpointer Gst::VideoFrame::get_meta </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a93fc637fc8b4b2aff29300877f668b35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93fc637fc8b4b2aff29300877f668b35">◆ </a></span>gobj() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">GstVideoFrame* Gst::VideoFrame::gobj </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the underlying C instance. </p>
</div>
</div>
<a id="a011096ac9308c7845cd2cfe353625fab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a011096ac9308c7845cd2cfe353625fab">◆ </a></span>gobj() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const GstVideoFrame* Gst::VideoFrame::gobj </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the underlying C instance. </p>
</div>
</div>
<a id="a246daf6ab966d35b9bcea2056a248586"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a246daf6ab966d35b9bcea2056a248586">◆ </a></span>map()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gst::VideoFrame::map </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGst_1_1VideoInfo.html">Gst::VideoInfo</a>& </td>
<td class="paramname"><em>info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Glib::RefPtr< <a class="el" href="classGst_1_1Buffer.html">Gst::Buffer</a> >& </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__gstreamermmEnums.html#gaee5716e12b88f74c183e50de377d624a">Gst::MapFlags</a> </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Use <em>info</em> and <em>buffer</em> to fill in the values of <em>frame</em>. </p>
<p><em>frame</em> is usually allocated on the stack, and you will pass the address to the <a class="el" href="classGst_1_1VideoFrame.html">Gst::VideoFrame</a> structure allocated on the stack; <a class="el" href="classGst_1_1VideoFrame.html#a246daf6ab966d35b9bcea2056a248586" title="Use info and buffer to fill in the values of frame. ">map()</a> will then fill in the structures with the various video-specific information you need to access the pixels of the video buffer. You can then use accessor macros such as GST_VIDEO_FRAME_COMP_DATA(), GST_VIDEO_FRAME_PLANE_DATA(), GST_VIDEO_FRAME_COMP_STRIDE(), GST_VIDEO_FRAME_PLANE_STRIDE() etc. to get to the pixels.</p>
<p>[C example ellipted]</p>
<p>All video planes of <em>buffer</em> will be mapped and the pointers will be set in <em>frame->data</em>.</p>
<p>The purpose of this function is to make it easy for you to get to the video pixels in a generic way, without you having to worry too much about details such as whether the video data is allocated in one contiguous memory chunk or multiple memory chunks (e.g. one for each plane); or if custom strides and custom plane offsets are used or not (as signalled by GstVideoMeta on each buffer). This function will just fill the <a class="el" href="classGst_1_1VideoFrame.html">Gst::VideoFrame</a> structure with the right values and if you use the accessor macros everything will just work and you can access the data easily. It also maps the underlying memory chunks for you.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">info</td><td>A <a class="el" href="classGst_1_1VideoInfo.html" title="Information describing image properties. ">Gst::VideoInfo</a>. </td></tr>
<tr><td class="paramname">buffer</td><td>The buffer to map. </td></tr>
<tr><td class="paramname">flags</td><td><a class="el" href="group__gstreamermmEnums.html#gaee5716e12b88f74c183e50de377d624a" title="Flags used when mapping memory. ">Gst::MapFlags</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> on success. </dd></dl>
</div>
</div>
<a id="ad7d67dd611b82abfe440647d30d0f1f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7d67dd611b82abfe440647d30d0f1f9">◆ </a></span>map_id()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gst::VideoFrame::map_id </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGst_1_1VideoInfo.html">Gst::VideoInfo</a>& </td>
<td class="paramname"><em>info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Glib::RefPtr< <a class="el" href="classGst_1_1Buffer.html">Gst::Buffer</a> >& </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gint </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__gstreamermmEnums.html#gaee5716e12b88f74c183e50de377d624a">Gst::MapFlags</a> </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Use <em>info</em> and <em>buffer</em> to fill in the values of <em>frame</em> with the video frame information of frame <em>id</em>. </p>
<p>When <em>id</em> is -1, the default frame is mapped. When <em>id</em> != -1, this function will return <code>false</code> when there is no GstVideoMeta with that id.</p>
<p>All video planes of <em>buffer</em> will be mapped and the pointers will be set in <em>frame->data</em>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">info</td><td>A <a class="el" href="classGst_1_1VideoInfo.html" title="Information describing image properties. ">Gst::VideoInfo</a>. </td></tr>
<tr><td class="paramname">buffer</td><td>The buffer to map. </td></tr>
<tr><td class="paramname">id</td><td>The frame id to map. </td></tr>
<tr><td class="paramname">flags</td><td><a class="el" href="group__gstreamermmEnums.html#gaee5716e12b88f74c183e50de377d624a" title="Flags used when mapping memory. ">Gst::MapFlags</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> on success. </dd></dl>
</div>
</div>
<a id="a448a8f35e39c054ff49aad8bd63bcc44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a448a8f35e39c054ff49aad8bd63bcc44">◆ </a></span>set_buffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gst::VideoFrame::set_buffer </td>
<td>(</td>
<td class="paramtype">const Glib::RefPtr< <a class="el" href="classGst_1_1Buffer.html">Gst::Buffer</a> >& </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="abb10b8d776ad7d61431c918fd1b2ccf7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb10b8d776ad7d61431c918fd1b2ccf7">◆ </a></span>set_flags()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gst::VideoFrame::set_flags </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__gstreamermmEnums.html#ga5aa12f05da8c93d064ed5a0a2661ca69">Gst::VideoFrameFlags</a>& </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a55de8595faeebcd2b3db9107b2354625"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55de8595faeebcd2b3db9107b2354625">◆ </a></span>set_id()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gst::VideoFrame::set_id </td>
<td>(</td>
<td class="paramtype">const gint & </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a676f23de6da267107621bd97f6628c02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a676f23de6da267107621bd97f6628c02">◆ </a></span>set_info()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gst::VideoFrame::set_info </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGst_1_1VideoInfo.html">Gst::VideoInfo</a>& </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a2a4886b8a327c4e0294f19b17827a4d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a4886b8a327c4e0294f19b17827a4d7">◆ </a></span>set_meta()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gst::VideoFrame::set_meta </td>
<td>(</td>
<td class="paramtype">const gpointer & </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a6725a00e8d1ce2eddde61d51aa6814b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6725a00e8d1ce2eddde61d51aa6814b1">◆ </a></span>unmap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gst::VideoFrame::unmap </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unmap the memory previously mapped with gst_video_frame_map. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a3cda5b4e3c2b0517c4b16e6ed1c21324"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3cda5b4e3c2b0517c4b16e6ed1c21324">◆ </a></span>gobject_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">GstVideoFrame Gst::VideoFrame::gobject_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Oct 21 2017 12:59:01 for gstreamermm by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
