<!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"/> <title>gstreamermm: Gst::ClockOverlay Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.3 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespaceGst.html">Gst</a>::<a class="el" href="classGst_1_1ClockOverlay.html">ClockOverlay</a> </div> </div> <div class="contents"> <h1>Gst::ClockOverlay Class Reference<br/> <small> [<a class="el" href="group__GstPlugins.html">gstreamermm Plugins</a>]</small> </h1><!-- doxytag: class="Gst::ClockOverlay" --><!-- doxytag: inherits="Gst::TextOverlay" --> <p>A Wrapper for the clockoverlay plugin. <a href="#_details">More...</a></p> <p>Inherits <a class="el" href="classGst_1_1TextOverlay.html">Gst::TextOverlay</a>.</p> <div class="dynheader"> Collaboration diagram for Gst::ClockOverlay:</div> <div class="dynsection"> <div class="center"><img src="classGst_1_1ClockOverlay__coll__graph.png" border="0" usemap="#Gst_1_1ClockOverlay_coll__map" alt="Collaboration graph"/></div> <map name="Gst_1_1ClockOverlay_coll__map" id="Gst_1_1ClockOverlay_coll__map"> <area shape="rect" id="node2" href="classGst_1_1TextOverlay.html" title="A Wrapper for the textoverlay plugin." alt="" coords="9,406,129,437"/><area shape="rect" id="node4" href="classGst_1_1Element.html" title="The abstract base class for all pipeline elements." alt="" coords="20,326,119,357"/><area shape="rect" id="node6" href="classGst_1_1Object.html" title="A base class for the GStreamer object hierarchy." alt="" coords="25,246,113,277"/><area shape="rect" id="node8" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="24,166,115,197"/><area shape="rect" id="node10" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="9,86,129,117"/><area shape="rect" id="node12" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="16,6,123,37"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classGst_1_1ClockOverlay-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1ClockOverlay.html#a71b054151e3e596eb636b1ceb495c155">~ClockOverlay</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">GstClockOverlay* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1ClockOverlay.html#ad226cfde091a2e89715ffb4408f33b15">gobj</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#ad226cfde091a2e89715ffb4408f33b15"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const GstClockOverlay* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1ClockOverlay.html#a46364599dd82ebd2b62d5229dfea44ed">gobj</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a46364599dd82ebd2b62d5229dfea44ed"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">GstClockOverlay* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1ClockOverlay.html#a53594e7c2534ebb5e210cbfbd2c031dc">gobj_copy</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <a href="#a53594e7c2534ebb5e210cbfbd2c031dc"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><br class="typebreak"/> < <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1ClockOverlay.html#afd874ab3ec6a1643cdb01b337615f16f">property_time_format</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Format to use for time and date value. <a href="#afd874ab3ec6a1643cdb01b337615f16f"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/> < <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1ClockOverlay.html#a81fca2e2c6e54de674f21719479bb28f">property_time_format</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Format to use for time and date value. <a href="#a81fca2e2c6e54de674f21719479bb28f"></a><br/></td></tr> <tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGst_1_1ClockOverlay.html">ClockOverlay</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1ClockOverlay.html#a645c5d4612ffdd3cf5ca2a036c92ff02">create</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new clockoverlay plugin with a unique name. <a href="#a645c5d4612ffdd3cf5ca2a036c92ff02"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGst_1_1ClockOverlay.html">ClockOverlay</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1ClockOverlay.html#ab5c60e3b9d25e6ebed34d6edd3ff20e2">create</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& name)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new clockoverlay plugin with the given name. <a href="#ab5c60e3b9d25e6ebed34d6edd3ff20e2"></a><br/></td></tr> <tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1ClockOverlay.html#a8557e02cc3149d13eee6f56f5e9e9941">ClockOverlay</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1ClockOverlay.html#a499496eb8da0391da007aeb0b9ef1a58">ClockOverlay</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& name)</td></tr> <tr><td colspan="2"><h2>Related Functions</h2></td></tr> <tr><td colspan="2"><p>(Note that these are not member functions.) </p> <br/><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGst_1_1ClockOverlay.html">Gst::ClockOverlay</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1ClockOverlay.html#a91dfae966d9f635e7d6210c4d02858c1">wrap</a> (GstClockOverlay* object, bool take_copy=false)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a91dfae966d9f635e7d6210c4d02858c1"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>A Wrapper for the clockoverlay plugin. </p> <p>Please note that, though using the underlying GObject is fine, using its C <b>type</b> is not guaranteed to be API stable across releases because it is not guaranteed to always remain the same. Also, not all plug-ins are available on all systems so care must be taken that they exist before they are used, otherwise there will be errors and possibly a crash. </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a71b054151e3e596eb636b1ceb495c155"></a><!-- doxytag: member="Gst::ClockOverlay::~ClockOverlay" ref="a71b054151e3e596eb636b1ceb495c155" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual Gst::ClockOverlay::~ClockOverlay </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a8557e02cc3149d13eee6f56f5e9e9941"></a><!-- doxytag: member="Gst::ClockOverlay::ClockOverlay" ref="a8557e02cc3149d13eee6f56f5e9e9941" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Gst::ClockOverlay::ClockOverlay </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a499496eb8da0391da007aeb0b9ef1a58"></a><!-- doxytag: member="Gst::ClockOverlay::ClockOverlay" ref="a499496eb8da0391da007aeb0b9ef1a58" args="(const Glib::ustring &name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Gst::ClockOverlay::ClockOverlay </td> <td>(</td> <td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td> <td class="paramname"> <em>name</em></td> <td> ) </td> <td><code> [explicit, protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ab5c60e3b9d25e6ebed34d6edd3ff20e2"></a><!-- doxytag: member="Gst::ClockOverlay::create" ref="ab5c60e3b9d25e6ebed34d6edd3ff20e2" args="(const Glib::ustring &name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGst_1_1ClockOverlay.html">ClockOverlay</a>> Gst::ClockOverlay::create </td> <td>(</td> <td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td> <td class="paramname"> <em>name</em></td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Creates a new clockoverlay plugin with the given name. </p> <p>Reimplemented from <a class="el" href="classGst_1_1TextOverlay.html#ae19cb478ce5d8021d8f060ae1c58ff1e">Gst::TextOverlay</a>.</p> </div> </div> <a class="anchor" id="a645c5d4612ffdd3cf5ca2a036c92ff02"></a><!-- doxytag: member="Gst::ClockOverlay::create" ref="a645c5d4612ffdd3cf5ca2a036c92ff02" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGst_1_1ClockOverlay.html">ClockOverlay</a>> Gst::ClockOverlay::create </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Creates a new clockoverlay plugin with a unique name. </p> <p>Reimplemented from <a class="el" href="classGst_1_1TextOverlay.html#a6eb299128009479d67cfde6eaac4da55">Gst::TextOverlay</a>.</p> </div> </div> <a class="anchor" id="a46364599dd82ebd2b62d5229dfea44ed"></a><!-- doxytag: member="Gst::ClockOverlay::gobj" ref="a46364599dd82ebd2b62d5229dfea44ed" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const GstClockOverlay* Gst::ClockOverlay::gobj </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Provides access to the underlying C GObject. </p> <p>Reimplemented from <a class="el" href="classGst_1_1TextOverlay.html#a2a772dafff3eda3dd507924295b79676">Gst::TextOverlay</a>.</p> </div> </div> <a class="anchor" id="ad226cfde091a2e89715ffb4408f33b15"></a><!-- doxytag: member="Gst::ClockOverlay::gobj" ref="ad226cfde091a2e89715ffb4408f33b15" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GstClockOverlay* Gst::ClockOverlay::gobj </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Provides access to the underlying C GObject. </p> <p>Reimplemented from <a class="el" href="classGst_1_1TextOverlay.html#afb27066550f935edefccd09ad25a2b82">Gst::TextOverlay</a>.</p> </div> </div> <a class="anchor" id="a53594e7c2534ebb5e210cbfbd2c031dc"></a><!-- doxytag: member="Gst::ClockOverlay::gobj_copy" ref="a53594e7c2534ebb5e210cbfbd2c031dc" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GstClockOverlay* Gst::ClockOverlay::gobj_copy </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. </p> <p>Reimplemented from <a class="el" href="classGst_1_1TextOverlay.html#a4a273fc3a843f70ca8fa345602fef7e1">Gst::TextOverlay</a>.</p> </div> </div> <a class="anchor" id="a81fca2e2c6e54de674f21719479bb28f"></a><!-- doxytag: member="Gst::ClockOverlay::property_time_format" ref="a81fca2e2c6e54de674f21719479bb28f" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><<a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>> Gst::ClockOverlay::property_time_format </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Format to use for time and date value. </p> <p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl> </div> </div> <a class="anchor" id="afd874ab3ec6a1643cdb01b337615f16f"></a><!-- doxytag: member="Gst::ClockOverlay::property_time_format" ref="afd874ab3ec6a1643cdb01b337615f16f" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><<a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>> Gst::ClockOverlay::property_time_format </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Format to use for time and date value. </p> <p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl> </div> </div> <hr/><h2>Friends And Related Function Documentation</h2> <a class="anchor" id="a91dfae966d9f635e7d6210c4d02858c1"></a><!-- doxytag: member="Gst::ClockOverlay::wrap" ref="a91dfae966d9f635e7d6210c4d02858c1" args="(GstClockOverlay *object, bool take_copy=false)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGst_1_1ClockOverlay.html">Gst::ClockOverlay</a> > wrap </td> <td>(</td> <td class="paramtype">GstClockOverlay * </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><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [related]</code></td> </tr> </table> </div> <div class="memdoc"> <p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>The C instance. </td></tr> <tr><td valign="top"></td><td valign="top"><em>take_copy</em> </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="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>gstreamermm/clockoverlay.h</li> </ul> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Apr 12 20:33:58 2010 for gstreamermm by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>