<!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::IndexFactory 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.1 --> <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_1IndexFactory.html">IndexFactory</a> </div> </div> <div class="contents"> <h1>Gst::IndexFactory Class Reference</h1><!-- doxytag: class="Gst::IndexFactory" --><!-- doxytag: inherits="Gst::PluginFeature" --> <p><a class="el" href="classGst_1_1IndexFactory.html" title="Gst::IndexFactory - Create Indexes from a factory.">Gst::IndexFactory</a> - Create Indexes from a factory. <a href="#_details">More...</a></p> <p>Inherits <a class="el" href="classGst_1_1PluginFeature.html">Gst::PluginFeature</a>.</p> <div class="dynheader"> Collaboration diagram for Gst::IndexFactory:</div> <div class="dynsection"> <div class="center"><img src="classGst_1_1IndexFactory__coll__graph.png" border="0" usemap="#Gst_1_1IndexFactory_coll__map" alt="Collaboration graph"/></div> <map name="Gst_1_1IndexFactory_coll__map" id="Gst_1_1IndexFactory_coll__map"> <area shape="rect" href="classGst_1_1PluginFeature.html" title="This is a base class for anything that can be added to a Gst::Plugin." alt="" coords="5,315,136,344"/><area shape="rect" href="classGst_1_1Object.html" title="Gst::Object - Base class for the GStreamer object hierarchy." alt="" coords="27,237,115,267"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="25,160,116,189"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="11,83,131,112"/><area shape="rect" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="17,5,124,35"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classGst_1_1IndexFactory-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_1IndexFactory.html#a37eaa415b3ea2abe607c669fc69fec4d">~IndexFactory</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">GstIndexFactory* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1IndexFactory.html#ac89b4f21c98a0d8a50913c0e8efb7025">gobj</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#ac89b4f21c98a0d8a50913c0e8efb7025"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const GstIndexFactory* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1IndexFactory.html#a5e85c426e4d15421a9d4cdfb370281ad">gobj</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a5e85c426e4d15421a9d4cdfb370281ad"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">GstIndexFactory* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1IndexFactory.html#ad5039783c87a3a5d4ff05d8cd53838f9">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="#ad5039783c87a3a5d4ff05d8cd53838f9"></a><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_1Index.html">Gst::Index</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1IndexFactory.html#a55fcb5d162c05147bc6e51726b4060a5">create_index</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new <a class="el" href="classGst_1_1Index.html" title="Gst::Index is used to generate a stream index of one or more elements in a pipeline...">Gst::Index</a> instance from the given indexfactory. <a href="#a55fcb5d162c05147bc6e51726b4060a5"></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_1IndexFactory.html">IndexFactory</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1IndexFactory.html#a63771d68a2e202a192a240935d051e8f">create</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& name, const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& longdesc, GType type)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new index factory with the given parameters. <a href="#a63771d68a2e202a192a240935d051e8f"></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><br class="typebreak"/> < <a class="el" href="classGst_1_1IndexFactory.html">Gst::IndexFactory</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1IndexFactory.html#a89b682978c228fa4510e42a81c9a386e">find</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">Search for an indexfactory of the given name. <a href="#a89b682978c228fa4510e42a81c9a386e"></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_1Index.html">Gst::Index</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1IndexFactory.html#a5fbf75b39b83736e8662c412591c137b">create_index</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& factory_name)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new <a class="el" href="classGst_1_1Index.html" title="Gst::Index is used to generate a stream index of one or more elements in a pipeline...">Gst::Index</a> instance from the indexfactory with the given name. <a href="#a5fbf75b39b83736e8662c412591c137b"></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_1IndexFactory.html#ac1dd6059f910781b879b372c29a603e3">IndexFactory</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& name, const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& longdesc, GType type)</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_1IndexFactory.html">Gst::IndexFactory</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1IndexFactory.html#a7cd83fff28d8c208fd76f7d9ad168362">wrap</a> (GstIndexFactory* 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="#a7cd83fff28d8c208fd76f7d9ad168362"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p><a class="el" href="classGst_1_1IndexFactory.html" title="Gst::IndexFactory - Create Indexes from a factory.">Gst::IndexFactory</a> - Create Indexes from a factory. </p> <p><a class="el" href="classGst_1_1IndexFactory.html" title="Gst::IndexFactory - Create Indexes from a factory.">Gst::IndexFactory</a> is used to dynamically create <a class="el" href="classGst_1_1Index.html" title="Gst::Index is used to generate a stream index of one or more elements in a pipeline...">Gst::Index</a> implementations. </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a37eaa415b3ea2abe607c669fc69fec4d"></a><!-- doxytag: member="Gst::IndexFactory::~IndexFactory" ref="a37eaa415b3ea2abe607c669fc69fec4d" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual Gst::IndexFactory::~IndexFactory </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="ac1dd6059f910781b879b372c29a603e3"></a><!-- doxytag: member="Gst::IndexFactory::IndexFactory" ref="ac1dd6059f910781b879b372c29a603e3" args="(const Glib::ustring &name, const Glib::ustring &longdesc, GType type)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Gst::IndexFactory::IndexFactory </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> </tr> <tr> <td class="paramkey"></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>longdesc</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">GType </td> <td class="paramname"> <em>type</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></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="a63771d68a2e202a192a240935d051e8f"></a><!-- doxytag: member="Gst::IndexFactory::create" ref="a63771d68a2e202a192a240935d051e8f" args="(const Glib::ustring &name, const Glib::ustring &longdesc, GType type)" --> <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_1IndexFactory.html">IndexFactory</a>> Gst::IndexFactory::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> </tr> <tr> <td class="paramkey"></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>longdesc</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">GType </td> <td class="paramname"> <em>type</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Create a new index factory with the given parameters. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of the index factory to create. </td></tr> <tr><td valign="top"></td><td valign="top"><em>longdesc</em> </td><td>Long description of the index factory to create. </td></tr> <tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>The GType of the <a class="el" href="classGst_1_1Index.html" title="Gst::Index is used to generate a stream index of one or more elements in a pipeline...">Gst::Index</a> element of this factory. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>A new <a class="el" href="classGst_1_1IndexFactory.html" title="Gst::IndexFactory - Create Indexes from a factory.">Gst::IndexFactory</a>. </dd></dl> </div> </div> <a class="anchor" id="a5fbf75b39b83736e8662c412591c137b"></a><!-- doxytag: member="Gst::IndexFactory::create_index" ref="a5fbf75b39b83736e8662c412591c137b" args="(const Glib::ustring &factory_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_1Index.html">Gst::Index</a>> Gst::IndexFactory::create_index </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>factory_name</em></td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Create a new <a class="el" href="classGst_1_1Index.html" title="Gst::Index is used to generate a stream index of one or more elements in a pipeline...">Gst::Index</a> instance from the indexfactory with the given name. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name of the factory used to create the instance. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>A new <a class="el" href="classGst_1_1Index.html" title="Gst::Index is used to generate a stream index of one or more elements in a pipeline...">Gst::Index</a> instance. </dd></dl> </div> </div> <a class="anchor" id="a55fcb5d162c05147bc6e51726b4060a5"></a><!-- doxytag: member="Gst::IndexFactory::create_index" ref="a55fcb5d162c05147bc6e51726b4060a5" 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_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGst_1_1Index.html">Gst::Index</a>> Gst::IndexFactory::create_index </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Create a new <a class="el" href="classGst_1_1Index.html" title="Gst::Index is used to generate a stream index of one or more elements in a pipeline...">Gst::Index</a> instance from the given indexfactory. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>A new <a class="el" href="classGst_1_1Index.html" title="Gst::Index is used to generate a stream index of one or more elements in a pipeline...">Gst::Index</a> instance. </dd></dl> </div> </div> <a class="anchor" id="a89b682978c228fa4510e42a81c9a386e"></a><!-- doxytag: member="Gst::IndexFactory::find" ref="a89b682978c228fa4510e42a81c9a386e" 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_1IndexFactory.html">Gst::IndexFactory</a>> Gst::IndexFactory::find </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>Search for an indexfactory of the given name. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of indexfactory to find. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classGst_1_1IndexFactory.html" title="Gst::IndexFactory - Create Indexes from a factory.">Gst::IndexFactory</a> if found, <code>0</code> otherwise. </dd></dl> </div> </div> <a class="anchor" id="a5e85c426e4d15421a9d4cdfb370281ad"></a><!-- doxytag: member="Gst::IndexFactory::gobj" ref="a5e85c426e4d15421a9d4cdfb370281ad" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const GstIndexFactory* Gst::IndexFactory::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_1PluginFeature.html#a13f5107f5c8fd289bfe2bd233389c79f">Gst::PluginFeature</a>.</p> </div> </div> <a class="anchor" id="ac89b4f21c98a0d8a50913c0e8efb7025"></a><!-- doxytag: member="Gst::IndexFactory::gobj" ref="ac89b4f21c98a0d8a50913c0e8efb7025" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GstIndexFactory* Gst::IndexFactory::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_1PluginFeature.html#ae5b357504a500e18cf8452cb8bc88341">Gst::PluginFeature</a>.</p> </div> </div> <a class="anchor" id="ad5039783c87a3a5d4ff05d8cd53838f9"></a><!-- doxytag: member="Gst::IndexFactory::gobj_copy" ref="ad5039783c87a3a5d4ff05d8cd53838f9" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GstIndexFactory* Gst::IndexFactory::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_1PluginFeature.html#a9d2137649eff64ff9bcb182b41b667de">Gst::PluginFeature</a>.</p> </div> </div> <hr/><h2>Friends And Related Function Documentation</h2> <a class="anchor" id="a7cd83fff28d8c208fd76f7d9ad168362"></a><!-- doxytag: member="Gst::IndexFactory::wrap" ref="a7cd83fff28d8c208fd76f7d9ad168362" args="(GstIndexFactory *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_1IndexFactory.html">Gst::IndexFactory</a> > wrap </td> <td>(</td> <td class="paramtype">GstIndexFactory * </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/indexfactory.h</li> </ul> </div> <hr size="1"/><address style="text-align: right;"><small>Generated on Mon Sep 21 22:32:56 2009 for gstreamermm by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> </body> </html>