<!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::TheoraDec 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_1TheoraDec.html">TheoraDec</a> </div> </div> <div class="contents"> <h1>Gst::TheoraDec Class Reference<br/> <small> [<a class="el" href="group__GstPlugins.html">gstreamermm Plugins</a>]</small> </h1><!-- doxytag: class="Gst::TheoraDec" --><!-- doxytag: inherits="Gst::Element" --> <p>A Wrapper for the theoradec plugin. <a href="#_details">More...</a></p> <p>Inherits <a class="el" href="classGst_1_1Element.html">Gst::Element</a>.</p> <div class="dynheader"> Collaboration diagram for Gst::TheoraDec:</div> <div class="dynsection"> <div class="center"><img src="classGst_1_1TheoraDec__coll__graph.png" border="0" usemap="#Gst_1_1TheoraDec_coll__map" alt="Collaboration graph"/></div> <map name="Gst_1_1TheoraDec_coll__map" id="Gst_1_1TheoraDec_coll__map"> <area shape="rect" id="node2" href="classGst_1_1Element.html" title="The abstract base class for all pipeline elements." alt="" coords="16,326,115,357"/><area shape="rect" id="node4" href="classGst_1_1Object.html" title="A base class for the GStreamer object hierarchy." alt="" coords="21,246,109,277"/><area shape="rect" id="node6" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="20,166,111,197"/><area shape="rect" id="node8" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,86,125,117"/><area shape="rect" id="node10" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="12,6,119,37"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classGst_1_1TheoraDec-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_1TheoraDec.html#aeb545fec7affceadef5473fc2a61aa88">~TheoraDec</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">GstTheoraDec* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1TheoraDec.html#aab1014a65e58c30a943416c7a4a5fa3f">gobj</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#aab1014a65e58c30a943416c7a4a5fa3f"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const GstTheoraDec* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1TheoraDec.html#ab8cbf23e37bf6a19abc3d5274ac60d2a">gobj</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#ab8cbf23e37bf6a19abc3d5274ac60d2a"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">GstTheoraDec* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1TheoraDec.html#ada9a3455cc62fc9fcf505864a922d0de">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="#ada9a3455cc62fc9fcf505864a922d0de"></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>< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1TheoraDec.html#a2b2bb72929ce8334171069ea28a58737">property_crop</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Crop the image to the visible region. <a href="#a2b2bb72929ce8334171069ea28a58737"></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"/> < bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1TheoraDec.html#a482a5275553b26f0c2f7f1c2b305d1e4">property_crop</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Crop the image to the visible region. <a href="#a482a5275553b26f0c2f7f1c2b305d1e4"></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_1TheoraDec.html">TheoraDec</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1TheoraDec.html#a69aa418dd8c03a211f94f1de59fee9e0">create</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new theoradec plugin with a unique name. <a href="#a69aa418dd8c03a211f94f1de59fee9e0"></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_1TheoraDec.html">TheoraDec</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1TheoraDec.html#a3349ba3765501945eb9565b1c9b893bd">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 theoradec plugin with the given name. <a href="#a3349ba3765501945eb9565b1c9b893bd"></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_1TheoraDec.html#a3b23c23561a31ec2d82dadc07584b236">TheoraDec</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1TheoraDec.html#ac5792bf3f87871d10b1c5542c25f657c">TheoraDec</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_1TheoraDec.html">Gst::TheoraDec</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1TheoraDec.html#a012107397d2e170777ef5a3d9ba576cc">wrap</a> (GstTheoraDec* 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="#a012107397d2e170777ef5a3d9ba576cc"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>A Wrapper for the theoradec 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="aeb545fec7affceadef5473fc2a61aa88"></a><!-- doxytag: member="Gst::TheoraDec::~TheoraDec" ref="aeb545fec7affceadef5473fc2a61aa88" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual Gst::TheoraDec::~TheoraDec </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="a3b23c23561a31ec2d82dadc07584b236"></a><!-- doxytag: member="Gst::TheoraDec::TheoraDec" ref="a3b23c23561a31ec2d82dadc07584b236" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Gst::TheoraDec::TheoraDec </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="ac5792bf3f87871d10b1c5542c25f657c"></a><!-- doxytag: member="Gst::TheoraDec::TheoraDec" ref="ac5792bf3f87871d10b1c5542c25f657c" args="(const Glib::ustring &name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Gst::TheoraDec::TheoraDec </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="a3349ba3765501945eb9565b1c9b893bd"></a><!-- doxytag: member="Gst::TheoraDec::create" ref="a3349ba3765501945eb9565b1c9b893bd" 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_1TheoraDec.html">TheoraDec</a>> Gst::TheoraDec::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 theoradec plugin with the given name. </p> </div> </div> <a class="anchor" id="a69aa418dd8c03a211f94f1de59fee9e0"></a><!-- doxytag: member="Gst::TheoraDec::create" ref="a69aa418dd8c03a211f94f1de59fee9e0" 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_1TheoraDec.html">TheoraDec</a>> Gst::TheoraDec::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 theoradec plugin with a unique name. </p> </div> </div> <a class="anchor" id="ab8cbf23e37bf6a19abc3d5274ac60d2a"></a><!-- doxytag: member="Gst::TheoraDec::gobj" ref="ab8cbf23e37bf6a19abc3d5274ac60d2a" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const GstTheoraDec* Gst::TheoraDec::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_1Element.html#a2fc52bce60c6892c333763a4f308b569">Gst::Element</a>.</p> </div> </div> <a class="anchor" id="aab1014a65e58c30a943416c7a4a5fa3f"></a><!-- doxytag: member="Gst::TheoraDec::gobj" ref="aab1014a65e58c30a943416c7a4a5fa3f" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GstTheoraDec* Gst::TheoraDec::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_1Element.html#a7385513759359ebfb349b824ab463dbc">Gst::Element</a>.</p> </div> </div> <a class="anchor" id="ada9a3455cc62fc9fcf505864a922d0de"></a><!-- doxytag: member="Gst::TheoraDec::gobj_copy" ref="ada9a3455cc62fc9fcf505864a922d0de" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GstTheoraDec* Gst::TheoraDec::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_1Element.html#aaf406873b4b57582deff89ed621fb297">Gst::Element</a>.</p> </div> </div> <a class="anchor" id="a482a5275553b26f0c2f7f1c2b305d1e4"></a><!-- doxytag: member="Gst::TheoraDec::property_crop" ref="a482a5275553b26f0c2f7f1c2b305d1e4" 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><bool> Gst::TheoraDec::property_crop </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Crop the image to the visible region. </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="a2b2bb72929ce8334171069ea28a58737"></a><!-- doxytag: member="Gst::TheoraDec::property_crop" ref="a2b2bb72929ce8334171069ea28a58737" 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><bool> Gst::TheoraDec::property_crop </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Crop the image to the visible region. </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="a012107397d2e170777ef5a3d9ba576cc"></a><!-- doxytag: member="Gst::TheoraDec::wrap" ref="a012107397d2e170777ef5a3d9ba576cc" args="(GstTheoraDec *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_1TheoraDec.html">Gst::TheoraDec</a> > wrap </td> <td>(</td> <td class="paramtype">GstTheoraDec * </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/theoradec.h</li> </ul> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Apr 12 20:34:02 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>