<!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::VideoOverlay 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_1VideoOverlay.html">VideoOverlay</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-methods">Protected Member Functions</a> |
<a href="#related">Related Functions</a> |
<a href="classGst_1_1VideoOverlay-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Gst::VideoOverlay Class Reference<div class="ingroups"><a class="el" href="group__GstInterfaces.html">gstreamermm Interfaces</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>An interface for setting/getting a Window on elements supporting it.
<a href="classGst_1_1VideoOverlay.html#details">More...</a></p>
<p><code>#include <gstreamermm/videooverlay.h></code></p>
<p>Inherits Interface.</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:a0d9555ec33243be0aef14814af5d68ab"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoOverlay.html#a0d9555ec33243be0aef14814af5d68ab">VideoOverlay</a> (<a class="el" href="classGst_1_1VideoOverlay.html">VideoOverlay</a>&& src) noexcept</td></tr>
<tr class="separator:a0d9555ec33243be0aef14814af5d68ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a208a8ecbf15901a2cd05e606d080c153"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGst_1_1VideoOverlay.html">VideoOverlay</a>& </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoOverlay.html#a208a8ecbf15901a2cd05e606d080c153">operator=</a> (<a class="el" href="classGst_1_1VideoOverlay.html">VideoOverlay</a>&& src) noexcept</td></tr>
<tr class="separator:a208a8ecbf15901a2cd05e606d080c153"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acf6ea9f1c5d178308a4d2e39bcc28ed4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoOverlay.html#acf6ea9f1c5d178308a4d2e39bcc28ed4">~VideoOverlay</a> () noexcept override</td></tr>
<tr class="separator:acf6ea9f1c5d178308a4d2e39bcc28ed4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd4a39d5aa7265e83dd81c23bc1ba5a4"><td class="memItemLeft" align="right" valign="top">GstVideoOverlay* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoOverlay.html#acd4a39d5aa7265e83dd81c23bc1ba5a4">gobj</a> ()</td></tr>
<tr class="memdesc:acd4a39d5aa7265e83dd81c23bc1ba5a4"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#acd4a39d5aa7265e83dd81c23bc1ba5a4">More...</a><br /></td></tr>
<tr class="separator:acd4a39d5aa7265e83dd81c23bc1ba5a4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a50ff1208ae8387c827fdd01b3ccba289"><td class="memItemLeft" align="right" valign="top">const GstVideoOverlay* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoOverlay.html#a50ff1208ae8387c827fdd01b3ccba289">gobj</a> () const</td></tr>
<tr class="memdesc:a50ff1208ae8387c827fdd01b3ccba289"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a50ff1208ae8387c827fdd01b3ccba289">More...</a><br /></td></tr>
<tr class="separator:a50ff1208ae8387c827fdd01b3ccba289"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a22b3d25a2a1ccb5c50a419f5db2685b8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoOverlay.html#a22b3d25a2a1ccb5c50a419f5db2685b8">set_window_handle</a> (guintptr window_handle)</td></tr>
<tr class="memdesc:a22b3d25a2a1ccb5c50a419f5db2685b8"><td class="mdescLeft"> </td><td class="mdescRight">This will call the video overlay's set_window_handle method. <a href="#a22b3d25a2a1ccb5c50a419f5db2685b8">More...</a><br /></td></tr>
<tr class="separator:a22b3d25a2a1ccb5c50a419f5db2685b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a38770ee51251894eb517d959bcc71419"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoOverlay.html#a38770ee51251894eb517d959bcc71419">got_window_handle</a> (guintptr window_handle)</td></tr>
<tr class="memdesc:a38770ee51251894eb517d959bcc71419"><td class="mdescLeft"> </td><td class="mdescRight">This will post a "have-window-handle" element message on the bus. <a href="#a38770ee51251894eb517d959bcc71419">More...</a><br /></td></tr>
<tr class="separator:a38770ee51251894eb517d959bcc71419"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad4f4e781799f02a86e5d951724b72e0f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoOverlay.html#ad4f4e781799f02a86e5d951724b72e0f">prepare_window_handle</a> ()</td></tr>
<tr class="memdesc:ad4f4e781799f02a86e5d951724b72e0f"><td class="mdescLeft"> </td><td class="mdescRight">This will post a "prepare-window-handle" element message on the bus to give applications an opportunity to call gst_video_overlay_set_window_handle() before a plugin creates its own window. <a href="#ad4f4e781799f02a86e5d951724b72e0f">More...</a><br /></td></tr>
<tr class="separator:ad4f4e781799f02a86e5d951724b72e0f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aece721710ad9fc3dc30c47fc2776f44c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoOverlay.html#aece721710ad9fc3dc30c47fc2776f44c">expose</a> ()</td></tr>
<tr class="memdesc:aece721710ad9fc3dc30c47fc2776f44c"><td class="mdescLeft"> </td><td class="mdescRight">Tell an overlay that it has been exposed. <a href="#aece721710ad9fc3dc30c47fc2776f44c">More...</a><br /></td></tr>
<tr class="separator:aece721710ad9fc3dc30c47fc2776f44c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a924ba7a62f43fd52c5c698594a990605"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoOverlay.html#a924ba7a62f43fd52c5c698594a990605">handle_events</a> (bool handle_events)</td></tr>
<tr class="memdesc:a924ba7a62f43fd52c5c698594a990605"><td class="mdescLeft"> </td><td class="mdescRight">Tell an overlay that it should handle events from the window system. <a href="#a924ba7a62f43fd52c5c698594a990605">More...</a><br /></td></tr>
<tr class="separator:a924ba7a62f43fd52c5c698594a990605"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6eaf2b5e90d50780f92de2cea53ed23b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoOverlay.html#a6eaf2b5e90d50780f92de2cea53ed23b">set_render_rectangle</a> (int x, int y, int width, int height)</td></tr>
<tr class="memdesc:a6eaf2b5e90d50780f92de2cea53ed23b"><td class="mdescLeft"> </td><td class="mdescRight">Configure a subregion as a video target within the window set by gst_video_overlay_set_window_handle(). <a href="#a6eaf2b5e90d50780f92de2cea53ed23b">More...</a><br /></td></tr>
<tr class="separator:a6eaf2b5e90d50780f92de2cea53ed23b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad0322956e7af7fe2df8b8bbdfe4bb21b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoOverlay.html#ad0322956e7af7fe2df8b8bbdfe4bb21b">set_window_handle_vfunc</a> (guintptr handle)</td></tr>
<tr class="memdesc:ad0322956e7af7fe2df8b8bbdfe4bb21b"><td class="mdescLeft"> </td><td class="mdescRight">Virtual method to configure the window handle. <a href="#ad0322956e7af7fe2df8b8bbdfe4bb21b">More...</a><br /></td></tr>
<tr class="separator:ad0322956e7af7fe2df8b8bbdfe4bb21b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a813991ea570e839b3f6ad8532d05a82e"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoOverlay.html#a813991ea570e839b3f6ad8532d05a82e">expose_vfunc</a> ()</td></tr>
<tr class="memdesc:a813991ea570e839b3f6ad8532d05a82e"><td class="mdescLeft"> </td><td class="mdescRight">Virtual method to handle expose events. <a href="#a813991ea570e839b3f6ad8532d05a82e">More...</a><br /></td></tr>
<tr class="separator:a813991ea570e839b3f6ad8532d05a82e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af89ffb1aa332527f4c57b02ab722e746"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoOverlay.html#af89ffb1aa332527f4c57b02ab722e746">handle_events_vfunc</a> (bool <a class="el" href="classGst_1_1VideoOverlay.html#a924ba7a62f43fd52c5c698594a990605">handle_events</a>)</td></tr>
<tr class="memdesc:af89ffb1aa332527f4c57b02ab722e746"><td class="mdescLeft"> </td><td class="mdescRight">Virtual method to handle events. <a href="#af89ffb1aa332527f4c57b02ab722e746">More...</a><br /></td></tr>
<tr class="separator:af89ffb1aa332527f4c57b02ab722e746"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a41e397388acb34d20d1d4e3ec62e2715"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoOverlay.html#a41e397388acb34d20d1d4e3ec62e2715">set_render_rectangle_vfunc</a> (int x, int y, int width, int height)</td></tr>
<tr class="memdesc:a41e397388acb34d20d1d4e3ec62e2715"><td class="mdescLeft"> </td><td class="mdescRight">Virtual method to set the render rectangle. <a href="#a41e397388acb34d20d1d4e3ec62e2715">More...</a><br /></td></tr>
<tr class="separator:a41e397388acb34d20d1d4e3ec62e2715"><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:ad4b7d977c29644b1e6c0279b1e5837d1"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoOverlay.html#ad4b7d977c29644b1e6c0279b1e5837d1">add_interface</a> (GType gtype_implementer)</td></tr>
<tr class="separator:ad4b7d977c29644b1e6c0279b1e5837d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa77467acbe6e776deaa5156338b2020c"><td class="memItemLeft" align="right" valign="top">static GType </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoOverlay.html#aa77467acbe6e776deaa5156338b2020c">get_type</a> ()</td></tr>
<tr class="memdesc:aa77467acbe6e776deaa5156338b2020c"><td class="mdescLeft"> </td><td class="mdescRight">Get the GType for this class, for use with the underlying GObject type system. <a href="#aa77467acbe6e776deaa5156338b2020c">More...</a><br /></td></tr>
<tr class="separator:aa77467acbe6e776deaa5156338b2020c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a46053a2955dcfafbbf619b2d1e0982e9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoOverlay.html#a46053a2955dcfafbbf619b2d1e0982e9">VideoOverlay</a> ()</td></tr>
<tr class="memdesc:a46053a2955dcfafbbf619b2d1e0982e9"><td class="mdescLeft"> </td><td class="mdescRight">You should derive from this class to use it. <a href="#a46053a2955dcfafbbf619b2d1e0982e9">More...</a><br /></td></tr>
<tr class="separator:a46053a2955dcfafbbf619b2d1e0982e9"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p>
</td></tr>
<tr class="memitem:a5e4fbd6326a37490886d4ae6d7a3e3ff"><td class="memItemLeft" align="right" valign="top">Glib::RefPtr< <a class="el" href="classGst_1_1VideoOverlay.html">Gst::VideoOverlay</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1VideoOverlay.html#a5e4fbd6326a37490886d4ae6d7a3e3ff">wrap</a> (GstVideoOverlay* object, bool take_copy=false)</td></tr>
<tr class="memdesc:a5e4fbd6326a37490886d4ae6d7a3e3ff"><td class="mdescLeft"> </td><td class="mdescRight">A <a class="el" href="namespaceGlib.html#a43fcab2a44083e8b7b6a1c8193acae2b">Glib::wrap()</a> method for this object. <a href="#a5e4fbd6326a37490886d4ae6d7a3e3ff">More...</a><br /></td></tr>
<tr class="separator:a5e4fbd6326a37490886d4ae6d7a3e3ff"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An interface for setting/getting a Window on elements supporting it. </p>
<p>The <a class="el" href="classGst_1_1VideoOverlay.html" title="An interface for setting/getting a Window on elements supporting it. ">VideoOverlay</a> interface is used for 2 main purposes :</p>
<ul>
<li>To get a grab on the Window where the video sink element is going to render. This is achieved by either being informed about the Window identifier that the video sink element generated, or by forcing the video sink element to use a specific Window identifier for rendering.</li>
<li>To force a redrawing of the latest video frame the video sink element displayed on the Window. Indeed if the <a class="el" href="classGst_1_1Pipeline.html" title="A top-level bin with clocking and bus management functionality. ">Pipeline</a> is in STATE_PAUSED state, moving the Window around will damage its content. Application developers will want to handle the Expose events themselves and force the video sink element to refresh the Window's content.</li>
</ul>
<p>Using the Window created by the video sink is probably the simplest scenario, in some cases, though, it might not be flexible enough for application developers if they need to catch events such as mouse moves and button clicks.</p>
<p>Setting a specific Window identifier on the video sink element is the most flexible solution but it has some issues. Indeed the application needs to set its Window identifier at the right time to avoid internal Window creation from the video sink element. To solve this issue a <a class="el" href="classGst_1_1Message.html" title="A class that represents lightweight objects to signal the application of pipeline events...">Message</a> is posted on the bus to inform the application that it should set the Window identifier immediately. Here is an example on how to do that correctly:</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include <gdk/gdkx.h></span></div><div class="line">...</div><div class="line">void PlayerWindow::on_bus_message_sync(</div><div class="line"> <span class="keyword">const</span> Glib::RefPtr<Gst::Message>& message)</div><div class="line">{</div><div class="line"> <span class="comment">// ignore anything but 'prepare-xwindow-id' element messages</span></div><div class="line"> <span class="keywordflow">if</span>(message->get_message_type() != <a class="code" href="namespaceGst.html#ga704e8de3c3f9698d3c3ca15d61190a86a1446541b67def22116801ffd77ec3f82">Gst::MESSAGE_ELEMENT</a>)</div><div class="line"> <span class="keywordflow">return</span>;</div><div class="line"></div><div class="line"> <span class="keywordflow">if</span>(!message->get_structure().has_name(<span class="stringliteral">"prepare-xwindow-id"</span>))</div><div class="line"> <span class="keywordflow">return</span>;</div><div class="line"></div><div class="line"> Glib::RefPtr<Gst::Element> element =</div><div class="line"> Glib::RefPtr<Gst::Element>::cast_dynamic(message->get_source());</div><div class="line"></div><div class="line"> Glib::RefPtr< Gst::ElementInterfaced<Gst::XOverlay> > xoverlay =</div><div class="line"> Gst::Interface::cast <Gst::XOverlay>(element);</div><div class="line"></div><div class="line"> <span class="keywordflow">if</span>(xoverlay)</div><div class="line"> {</div><div class="line"> <span class="keyword">const</span> gulong xWindowId =</div><div class="line"> GDK_WINDOW_XID(widget->get_window()->gobj());</div><div class="line"> xoverlay->set_xwindow_id(xWindowId);</div><div class="line"> }</div><div class="line">}</div><div class="line">...</div><div class="line">int main (<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> *argv[])</div><div class="line">{</div><div class="line"> ...</div><div class="line"> <span class="comment">// Get the bus from the pipeline:</span></div><div class="line"> Glib::RefPtr<Gst::Bus> bus = pipeline->get_bus();</div><div class="line"></div><div class="line"> <span class="comment">// Enable synchronous message emission:</span></div><div class="line"> bus->enable_sync_message_emission();</div><div class="line"></div><div class="line"> <span class="comment">// Connect to bus's synchronous message signal:</span></div><div class="line"> bus->signal_sync_message().connect(</div><div class="line"> sigc::mem_fun(*<span class="keyword">this</span>, &PlayerWindow::on_bus_message_sync));</div><div class="line"> ...</div><div class="line">}</div></div><!-- fragment --> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a46053a2955dcfafbbf619b2d1e0982e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46053a2955dcfafbbf619b2d1e0982e9">◆ </a></span>VideoOverlay() <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">Gst::VideoOverlay::VideoOverlay </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>You should derive from this class to use it. </p>
</div>
</div>
<a id="a0d9555ec33243be0aef14814af5d68ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d9555ec33243be0aef14814af5d68ab">◆ </a></span>VideoOverlay() <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::VideoOverlay::VideoOverlay </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGst_1_1VideoOverlay.html">VideoOverlay</a>&& </td>
<td class="paramname"><em>src</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="acf6ea9f1c5d178308a4d2e39bcc28ed4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf6ea9f1c5d178308a4d2e39bcc28ed4">◆ </a></span>~VideoOverlay()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Gst::VideoOverlay::~VideoOverlay </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad4b7d977c29644b1e6c0279b1e5837d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4b7d977c29644b1e6c0279b1e5837d1">◆ </a></span>add_interface()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void Gst::VideoOverlay::add_interface </td>
<td>(</td>
<td class="paramtype">GType </td>
<td class="paramname"><em>gtype_implementer</em></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">
</div>
</div>
<a id="aece721710ad9fc3dc30c47fc2776f44c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aece721710ad9fc3dc30c47fc2776f44c">◆ </a></span>expose()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gst::VideoOverlay::expose </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tell an overlay that it has been exposed. </p>
<p>This will redraw the current frame in the drawable even if the pipeline is PAUSED. </p>
</div>
</div>
<a id="a813991ea570e839b3f6ad8532d05a82e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a813991ea570e839b3f6ad8532d05a82e">◆ </a></span>expose_vfunc()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Gst::VideoOverlay::expose_vfunc </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Virtual method to handle expose events. </p>
</div>
</div>
<a id="aa77467acbe6e776deaa5156338b2020c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa77467acbe6e776deaa5156338b2020c">◆ </a></span>get_type()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static GType Gst::VideoOverlay::get_type </td>
<td>(</td>
<td class="paramname"></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>Get the GType for this class, for use with the underlying GObject type system. </p>
</div>
</div>
<a id="acd4a39d5aa7265e83dd81c23bc1ba5a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd4a39d5aa7265e83dd81c23bc1ba5a4">◆ </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">GstVideoOverlay* Gst::VideoOverlay::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 GObject. </p>
</div>
</div>
<a id="a50ff1208ae8387c827fdd01b3ccba289"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50ff1208ae8387c827fdd01b3ccba289">◆ </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 GstVideoOverlay* Gst::VideoOverlay::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 GObject. </p>
</div>
</div>
<a id="a38770ee51251894eb517d959bcc71419"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38770ee51251894eb517d959bcc71419">◆ </a></span>got_window_handle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gst::VideoOverlay::got_window_handle </td>
<td>(</td>
<td class="paramtype">guintptr </td>
<td class="paramname"><em>window_handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This will post a "have-window-handle" element message on the bus. </p>
<p>This function should only be used by video overlay plugin developers.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">window_handle</td><td>A platform-specific handle referencing the window. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a924ba7a62f43fd52c5c698594a990605"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a924ba7a62f43fd52c5c698594a990605">◆ </a></span>handle_events()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gst::VideoOverlay::handle_events </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>handle_events</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tell an overlay that it should handle events from the window system. </p>
<p>These events are forwarded upstream as navigation events. In some window system, events are not propagated in the window hierarchy if a client is listening for them. This method allows you to disable events handling completely from the <a class="el" href="classGst_1_1VideoOverlay.html" title="An interface for setting/getting a Window on elements supporting it. ">Gst::VideoOverlay</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle_events</td><td>A <code>bool</code> indicating if events should be handled or not. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af89ffb1aa332527f4c57b02ab722e746"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af89ffb1aa332527f4c57b02ab722e746">◆ </a></span>handle_events_vfunc()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Gst::VideoOverlay::handle_events_vfunc </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>handle_events</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Virtual method to handle events. </p>
</div>
</div>
<a id="a208a8ecbf15901a2cd05e606d080c153"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a208a8ecbf15901a2cd05e606d080c153">◆ </a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGst_1_1VideoOverlay.html">VideoOverlay</a>& Gst::VideoOverlay::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGst_1_1VideoOverlay.html">VideoOverlay</a>&& </td>
<td class="paramname"><em>src</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ad4f4e781799f02a86e5d951724b72e0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4f4e781799f02a86e5d951724b72e0f">◆ </a></span>prepare_window_handle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gst::VideoOverlay::prepare_window_handle </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This will post a "prepare-window-handle" element message on the bus to give applications an opportunity to call gst_video_overlay_set_window_handle() before a plugin creates its own window. </p>
<p>This function should only be used by video overlay plugin developers. </p>
</div>
</div>
<a id="a6eaf2b5e90d50780f92de2cea53ed23b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6eaf2b5e90d50780f92de2cea53ed23b">◆ </a></span>set_render_rectangle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gst::VideoOverlay::set_render_rectangle </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>height</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Configure a subregion as a video target within the window set by gst_video_overlay_set_window_handle(). </p>
<p>If this is not used or not supported the video will fill the area of the window set as the overlay to 100%. By specifying the rectangle, the video can be overlayed to a specific region of that window only. After setting the new rectangle one should call gst_video_overlay_expose() to force a redraw. To unset the region pass -1 for the <em>width</em> and <em>height</em> parameters.</p>
<p>This method is needed for non fullscreen video overlay in UI toolkits that do not support subwindows.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>The horizontal offset of the render area inside the window. </td></tr>
<tr><td class="paramname">y</td><td>The vertical offset of the render area inside the window. </td></tr>
<tr><td class="paramname">width</td><td>The width of the render area inside the window. </td></tr>
<tr><td class="paramname">height</td><td>The height of the render area inside the window. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>false</code> if not supported by the sink. </dd></dl>
</div>
</div>
<a id="a41e397388acb34d20d1d4e3ec62e2715"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41e397388acb34d20d1d4e3ec62e2715">◆ </a></span>set_render_rectangle_vfunc()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Gst::VideoOverlay::set_render_rectangle_vfunc </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>height</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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Virtual method to set the render rectangle. </p>
</div>
</div>
<a id="a22b3d25a2a1ccb5c50a419f5db2685b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22b3d25a2a1ccb5c50a419f5db2685b8">◆ </a></span>set_window_handle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gst::VideoOverlay::set_window_handle </td>
<td>(</td>
<td class="paramtype">guintptr </td>
<td class="paramname"><em>window_handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This will call the video overlay's set_window_handle method. </p>
<p>You should use this method to tell to an overlay to display video output to a specific window (e.g. an XWindow on X11). Passing 0 as the <em>window_handle</em> will tell the overlay to stop using that window and create an internal one.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">window_handle</td><td>A handle referencing the window. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad0322956e7af7fe2df8b8bbdfe4bb21b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0322956e7af7fe2df8b8bbdfe4bb21b">◆ </a></span>set_window_handle_vfunc()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Gst::VideoOverlay::set_window_handle_vfunc </td>
<td>(</td>
<td class="paramtype">guintptr </td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Virtual method to configure the window handle. </p>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a5e4fbd6326a37490886d4ae6d7a3e3ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e4fbd6326a37490886d4ae6d7a3e3ff">◆ </a></span>wrap()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Glib::RefPtr< <a class="el" href="classGst_1_1VideoOverlay.html">Gst::VideoOverlay</a> > wrap </td>
<td>(</td>
<td class="paramtype">GstVideoOverlay * </td>
<td class="paramname"><em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>take_copy</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A <a class="el" href="namespaceGlib.html#a43fcab2a44083e8b7b6a1c8193acae2b">Glib::wrap()</a> method for this object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">object</td><td>The C instance. </td></tr>
<tr><td class="paramname">take_copy</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</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>
