<!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::Index 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_1Index.html">Index</a>
</div>
</div>
<div class="contents">
<h1>Gst::Index Class Reference</h1><!-- doxytag: class="Gst::Index" --><!-- doxytag: inherits="Gst::Object" -->
<p>A class that generates a stream index of one or more elements in a pipeline. <a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classGst_1_1Object.html">Gst::Object</a>.</p>
<div class="dynheader">
Collaboration diagram for Gst::Index:</div>
<div class="dynsection">
<div class="center"><img src="classGst_1_1Index__coll__graph.png" border="0" usemap="#Gst_1_1Index_coll__map" alt="Collaboration graph"/></div>
<map name="Gst_1_1Index_coll__map" id="Gst_1_1Index_coll__map">
<area shape="rect" id="node2" href="classGst_1_1Object.html" title="A base class for the GStreamer object hierarchy." alt="" coords="21,246,109,277"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="20,166,111,197"/><area shape="rect" id="node6" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,86,125,117"/><area shape="rect" id="node8" 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_1Index-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="elRef" href="../../../libsigc++-2.0/reference/html/classsigc_1_1slot.html">sigc::slot</a>< bool, <br class="typebreak"/>
const <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> ><br class="typebreak"/>
&, <a class="el" href="classGst_1_1IndexEntry.html">Gst::IndexEntry</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#a2bf33e42ab39dd1109670e9b1d2e6295">SlotFilter</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For example, bool on_filter(const Glib::RefPtr<Gst::Index>& index, <a class="el" href="classGst_1_1IndexEntry.html" title="The basic element of an index.">Gst::IndexEntry</a> entry);. <a href="#a2bf33e42ab39dd1109670e9b1d2e6295"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="elRef" href="../../../libsigc++-2.0/reference/html/classsigc_1_1slot.html">sigc::slot</a>< bool, <br class="typebreak"/>
const <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> ><br class="typebreak"/>
&, const <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_1Object.html">Gst::Object</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_1Index.html#a6f4411649b802f1703ea700a477a2f89">SlotResolver</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For example, bool on_resolve(const Glib::RefPtr<Gst::Object>& writer, <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& writer_string);. <a href="#a6f4411649b802f1703ea700a477a2f89"></a><br/></td></tr>
<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_1Index.html#ac1fa0c8c8f25a743642c83169d03b971">~Index</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GstIndex* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#a1d84d2d90b180fbc855537e10fc5d1ac">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a1d84d2d90b180fbc855537e10fc5d1ac"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const GstIndex* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#aa24f8d445b9f504b255c4071f978e713">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#aa24f8d445b9f504b255c4071f978e713"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GstIndex* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#a501f228f51fc2834d7e47f09faf9297e">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="#a501f228f51fc2834d7e47f09faf9297e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#ac1d1f4d63421d97984fca2349f97bd4a">is_readable</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the index can be read from. <a href="#ac1d1f4d63421d97984fca2349f97bd4a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#a307b4046a7206d9712ad485443104986">is_writable</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the index can be written to. <a href="#a307b4046a7206d9712ad485443104986"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#a3abd5baa1a2261e591232840f6790016">commit</a> (int id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell the index that the writer with the given id is done with this index and is not going to write any more entries to it. <a href="#a3abd5baa1a2261e591232840f6790016"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#a78605d74e1b092b920a23eb2f72f5fc2">get_group</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the id of the current group. <a href="#a78605d74e1b092b920a23eb2f72f5fc2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#a87e945c16059db3705fd37fbd8280df7">new_group</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new group for the given index. <a href="#a87e945c16059db3705fd37fbd8280df7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#ad2814d284396a891f8673a69d04c446d">set_group</a> (int group_number)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the current groupnumber to the given argument. <a href="#ad2814d284396a891f8673a69d04c446d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#a69415a5cbd07c1324cfe646e16df54f5">set_certainty</a> (<a class="el" href="group__gstreamermmEnums.html#gaa4c947a0c8ea32aca7f6218422a0b321">IndexCertainty</a> certainty)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the certainty of the given index. <a href="#a69415a5cbd07c1324cfe646e16df54f5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__gstreamermmEnums.html#gaa4c947a0c8ea32aca7f6218422a0b321">IndexCertainty</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#abc254da4d31a3b1d9d54e4635f6c3623">get_certainty</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the certainty of the given index. <a href="#abc254da4d31a3b1d9d54e4635f6c3623"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#a07915b28f3ae7dc2b228f0fe52e86808">get_writer_id</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGst_1_1Object.html">Gst::Object</a> >& writer, int& id) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Before entries can be added to the index, a writer should obtain a unique id. <a href="#a07915b28f3ae7dc2b228f0fe52e86808"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGst_1_1IndexEntry.html">Gst::IndexEntry</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#aaf5b60995341c07ccdd04bd1a590f143">add_format</a> (int id, <a class="el" href="group__gstreamermmEnums.html#ga9aeb4c7c49680888ff819ac95fb13cff">Format</a> format)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a format entry into the index. <a href="#aaf5b60995341c07ccdd04bd1a590f143"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGst_1_1IndexEntry.html">Gst::IndexEntry</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#a426c818fec24fbcbf70af6f6e6001f0e">add_association</a> (int id, <a class="el" href="group__gstreamermmEnums.html#gae0f85537e89b432d290d4de911d9930c">AssocFlags</a> flags, int n, const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< const <a class="el" href="classGst_1_1IndexAssociation.html">Gst::IndexAssociation</a> >& list)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Associate given format/value pairs with each other. <a href="#a426c818fec24fbcbf70af6f6e6001f0e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGst_1_1IndexEntry.html">Gst::IndexEntry</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#a7c83ba820e21ab2bf5f81459f4a3fbff">add_id</a> (int id, const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& description)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add an id entry into the index. <a href="#a7c83ba820e21ab2bf5f81459f4a3fbff"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGst_1_1IndexEntry.html">Gst::IndexEntry</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#a3ef8f5ec47d67831217e85bcfdbb0655">get_assoc_entry</a> (int id, gint64 <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01167.html#ga1c9e781d8d15a3814a601f471797c825">value</a>, <a class="el" href="group__gstreamermmEnums.html#gaf4e55f963620b0a49af91e3e2ae46077">IndexLookupMethod</a> method=Gst::INDEX_LOOKUP_EXACT, <a class="el" href="group__gstreamermmEnums.html#gae0f85537e89b432d290d4de911d9930c">AssocFlags</a> flags=Gst::ASSOCIATION_FLAG_NONE, <a class="el" href="group__gstreamermmEnums.html#ga9aeb4c7c49680888ff819ac95fb13cff">Format</a> format=Gst::FORMAT_DEFAULT) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finds the given format/value in the index. <a href="#a3ef8f5ec47d67831217e85bcfdbb0655"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#aab80ec078746e0cb86bb69c404a369ea">set_filter</a> (const <a class="elRef" href="../../../libsigc++-2.0/reference/html/classsigc_1_1slot.html">SlotFilter</a>& slot)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Lets the app register a custom filter slot so that it can select what entries should be stored in the index. <a href="#aab80ec078746e0cb86bb69c404a369ea"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#a061e92ca9a7fc57c19d93cdd437bd11d">set_resolver</a> (const <a class="elRef" href="../../../libsigc++-2.0/reference/html/classsigc_1_1slot.html">SlotResolver</a>& slot)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Lets the app register a custom slot to map index ids to writer descriptions. <a href="#a061e92ca9a7fc57c19d93cdd437bd11d"></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="../../../libsigc++-2.0/reference/html/classsigc_1_1slot.html">Gst::Index::SlotResolver</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#ace6abab30265006b1a00e517d4b56f29">property_resolver</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Select a predefined object to string mapper. <a href="#ace6abab30265006b1a00e517d4b56f29"></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="../../../libsigc++-2.0/reference/html/classsigc_1_1slot.html">Gst::Index::SlotResolver</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#ae3b856278c7094a3095b7bee07d170df">property_resolver</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Select a predefined object to string mapper. <a href="#ae3b856278c7094a3095b7bee07d170df"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy1.html">Glib::SignalProxy1</a>< void, <br class="typebreak"/>
const <a class="el" href="classGst_1_1IndexEntry.html">Gst::IndexEntry</a>& > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#a4199ed73fe9dd1972ea411562a9e6cd0">signal_entry_added</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Emitted when a new entry is added to the index. <a href="#a4199ed73fe9dd1972ea411562a9e6cd0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#a9ccff069c97cd82e590bdf1487075deb">get_writer_id_vfunc</a> (int& writer_id, const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& writer_string) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#a5f7c479cf91a761522b0a085f3eb9a13">commit_vfunc</a> (gint id)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#ad6b9bb6d047acf8551b63fb59dc91cc3">add_entry_vfunc</a> (<a class="el" href="classGst_1_1IndexEntry.html">Gst::IndexEntry</a>& entry)</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_1Index.html#ade6255ceba284b442006f3300d9c4f44">Index</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#a12f6b0988ba179a7a6d8001144009a63">on_entry_added</a> (const <a class="el" href="classGst_1_1IndexEntry.html">Gst::IndexEntry</a>& entry)</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_1Index.html">Gst::Index</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Index.html#a2b476c599b3e9ed09d7c3dee4b790df0">wrap</a> (GstIndex* 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="#a2b476c599b3e9ed09d7c3dee4b790df0"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A class that generates a stream index of one or more elements in a pipeline. </p>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a2bf33e42ab39dd1109670e9b1d2e6295"></a><!-- doxytag: member="Gst::Index::SlotFilter" ref="a2bf33e42ab39dd1109670e9b1d2e6295" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="elRef" href="../../../libsigc++-2.0/reference/html/classsigc_1_1slot.html">sigc::slot</a><bool, const <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>>&, <a class="el" href="classGst_1_1IndexEntry.html">Gst::IndexEntry</a>> <a class="elRef" href="../../../libsigc++-2.0/reference/html/classsigc_1_1slot.html">Gst::Index::SlotFilter</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>For example, bool on_filter(const Glib::RefPtr<Gst::Index>& index, <a class="el" href="classGst_1_1IndexEntry.html" title="The basic element of an index.">Gst::IndexEntry</a> entry);. </p>
<p>The filter function should return true if the entry is to be added to the index, false otherwise. </p>
</div>
</div>
<a class="anchor" id="a6f4411649b802f1703ea700a477a2f89"></a><!-- doxytag: member="Gst::Index::SlotResolver" ref="a6f4411649b802f1703ea700a477a2f89" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="elRef" href="../../../libsigc++-2.0/reference/html/classsigc_1_1slot.html">sigc::slot</a><bool, const <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>>&, const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGst_1_1Object.html">Gst::Object</a>>&, <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>&> <a class="elRef" href="../../../libsigc++-2.0/reference/html/classsigc_1_1slot.html">Gst::Index::SlotResolver</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>For example, bool on_resolve(const Glib::RefPtr<Gst::Object>& writer, <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& writer_string);. </p>
<p>The resolve function should return true if an id could be assigned to writer. </p>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac1fa0c8c8f25a743642c83169d03b971"></a><!-- doxytag: member="Gst::Index::~Index" ref="ac1fa0c8c8f25a743642c83169d03b971" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Gst::Index::~Index </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="ade6255ceba284b442006f3300d9c4f44"></a><!-- doxytag: member="Gst::Index::Index" ref="ade6255ceba284b442006f3300d9c4f44" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gst::Index::Index </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a426c818fec24fbcbf70af6f6e6001f0e"></a><!-- doxytag: member="Gst::Index::add_association" ref="a426c818fec24fbcbf70af6f6e6001f0e" args="(int id, AssocFlags flags, int n, const Glib::ArrayHandle< const Gst::IndexAssociation > &list)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGst_1_1IndexEntry.html">Gst::IndexEntry</a> Gst::Index::add_association </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__gstreamermmEnums.html#gae0f85537e89b432d290d4de911d9930c">AssocFlags</a> </td>
<td class="paramname"> <em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>n</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_1ArrayHandle.html">Glib::ArrayHandle</a>< const <a class="el" href="classGst_1_1IndexAssociation.html">Gst::IndexAssociation</a> >& </td>
<td class="paramname"> <em>list</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Associate given format/value pairs with each other. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>The id of the index writer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>flags</em> </td><td>Optinal flags for this entry. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>n</em> </td><td>Number of associations. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List of associations. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the newly added entry in the index. </dd></dl>
</div>
</div>
<a class="anchor" id="ad6b9bb6d047acf8551b63fb59dc91cc3"></a><!-- doxytag: member="Gst::Index::add_entry_vfunc" ref="ad6b9bb6d047acf8551b63fb59dc91cc3" args="(Gst::IndexEntry &entry)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Gst::Index::add_entry_vfunc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGst_1_1IndexEntry.html">Gst::IndexEntry</a>& </td>
<td class="paramname"> <em>entry</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aaf5b60995341c07ccdd04bd1a590f143"></a><!-- doxytag: member="Gst::Index::add_format" ref="aaf5b60995341c07ccdd04bd1a590f143" args="(int id, Format format)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGst_1_1IndexEntry.html">Gst::IndexEntry</a> Gst::Index::add_format </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__gstreamermmEnums.html#ga9aeb4c7c49680888ff819ac95fb13cff">Format</a> </td>
<td class="paramname"> <em>format</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds a format entry into the index. </p>
<p>This function is used to map dynamic GstFormat ids to their original format key. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>The id of the index writer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>The format to add to the index. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the newly added entry in the index. </dd></dl>
</div>
</div>
<a class="anchor" id="a7c83ba820e21ab2bf5f81459f4a3fbff"></a><!-- doxytag: member="Gst::Index::add_id" ref="a7c83ba820e21ab2bf5f81459f4a3fbff" args="(int id, const Glib::ustring &description)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGst_1_1IndexEntry.html">Gst::IndexEntry</a> Gst::Index::add_id </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</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>description</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add an id entry into the index. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>The id of the index writer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>description</em> </td><td>The description of the index writer. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the newly added entry in the index. </dd></dl>
</div>
</div>
<a class="anchor" id="a3abd5baa1a2261e591232840f6790016"></a><!-- doxytag: member="Gst::Index::commit" ref="a3abd5baa1a2261e591232840f6790016" args="(int id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gst::Index::commit </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tell the index that the writer with the given id is done with this index and is not going to write any more entries to it. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>The writer that commited the index. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5f7c479cf91a761522b0a085f3eb9a13"></a><!-- doxytag: member="Gst::Index::commit_vfunc" ref="a5f7c479cf91a761522b0a085f3eb9a13" args="(gint id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Gst::Index::commit_vfunc </td>
<td>(</td>
<td class="paramtype">gint </td>
<td class="paramname"> <em>id</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a3ef8f5ec47d67831217e85bcfdbb0655"></a><!-- doxytag: member="Gst::Index::get_assoc_entry" ref="a3ef8f5ec47d67831217e85bcfdbb0655" args="(int id, gint64 value, IndexLookupMethod method=Gst::INDEX_LOOKUP_EXACT, AssocFlags flags=Gst::ASSOCIATION_FLAG_NONE, Format format=Gst::FORMAT_DEFAULT) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGst_1_1IndexEntry.html">Gst::IndexEntry</a> Gst::Index::get_assoc_entry </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gint64 </td>
<td class="paramname"> <em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__gstreamermmEnums.html#gaf4e55f963620b0a49af91e3e2ae46077">IndexLookupMethod</a> </td>
<td class="paramname"> <em>method</em> = <code>Gst::INDEX_LOOKUP_EXACT</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__gstreamermmEnums.html#gae0f85537e89b432d290d4de911d9930c">AssocFlags</a> </td>
<td class="paramname"> <em>flags</em> = <code>Gst::ASSOCIATION_FLAG_NONE</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__gstreamermmEnums.html#ga9aeb4c7c49680888ff819ac95fb13cff">Format</a> </td>
<td class="paramname"> <em>format</em> = <code>Gst::FORMAT_DEFAULT</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Finds the given format/value in the index. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>The id of the index writer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>The value to find. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>method</em> </td><td>The lookup method to use. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>flags</em> </td><td>Flags for the entry. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>The format of the value. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The entry associated with the value or 0 if the value was not found. </dd></dl>
</div>
</div>
<a class="anchor" id="abc254da4d31a3b1d9d54e4635f6c3623"></a><!-- doxytag: member="Gst::Index::get_certainty" ref="abc254da4d31a3b1d9d54e4635f6c3623" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__gstreamermmEnums.html#gaa4c947a0c8ea32aca7f6218422a0b321">IndexCertainty</a> Gst::Index::get_certainty </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the certainty of the given index. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The certainty of the index. </dd></dl>
</div>
</div>
<a class="anchor" id="a78605d74e1b092b920a23eb2f72f5fc2"></a><!-- doxytag: member="Gst::Index::get_group" ref="a78605d74e1b092b920a23eb2f72f5fc2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Gst::Index::get_group </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the id of the current group. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The id of the current group. </dd></dl>
</div>
</div>
<a class="anchor" id="a07915b28f3ae7dc2b228f0fe52e86808"></a><!-- doxytag: member="Gst::Index::get_writer_id" ref="a07915b28f3ae7dc2b228f0fe52e86808" args="(const Glib::RefPtr< Gst::Object > &writer, int &id) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gst::Index::get_writer_id </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGst_1_1Object.html">Gst::Object</a> >& </td>
<td class="paramname"> <em>writer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>id</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Before entries can be added to the index, a writer should obtain a unique id. </p>
<p>The methods to add new entries to the index require this id as an argument.</p>
<p>The application can implement a custom function to map the writer object to a string. That string will be used to register or look up an id in the index. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>writer</em> </td><td>The GstObject to allocate an id for. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>A pointer to a <code>int</code> to hold the id. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the writer would be mapped to an id. </dd></dl>
</div>
</div>
<a class="anchor" id="a9ccff069c97cd82e590bdf1487075deb"></a><!-- doxytag: member="Gst::Index::get_writer_id_vfunc" ref="a9ccff069c97cd82e590bdf1487075deb" args="(int &writer_id, const Glib::ustring &writer_string) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool Gst::Index::get_writer_id_vfunc </td>
<td>(</td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>writer_id</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>writer_string</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa24f8d445b9f504b255c4071f978e713"></a><!-- doxytag: member="Gst::Index::gobj" ref="aa24f8d445b9f504b255c4071f978e713" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GstIndex* Gst::Index::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_1Object.html#a11313ecde7bc68ee4ee43c0cf2e65c22">Gst::Object</a>.</p>
</div>
</div>
<a class="anchor" id="a1d84d2d90b180fbc855537e10fc5d1ac"></a><!-- doxytag: member="Gst::Index::gobj" ref="a1d84d2d90b180fbc855537e10fc5d1ac" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GstIndex* Gst::Index::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_1Object.html#a3d889e949c76aa3ab4490026d6aca8ca">Gst::Object</a>.</p>
</div>
</div>
<a class="anchor" id="a501f228f51fc2834d7e47f09faf9297e"></a><!-- doxytag: member="Gst::Index::gobj_copy" ref="a501f228f51fc2834d7e47f09faf9297e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GstIndex* Gst::Index::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_1Object.html#a63d7202d3eb47c81ffc3ac16a895e9d1">Gst::Object</a>.</p>
</div>
</div>
<a class="anchor" id="ac1d1f4d63421d97984fca2349f97bd4a"></a><!-- doxytag: member="Gst::Index::is_readable" ref="ac1d1f4d63421d97984fca2349f97bd4a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gst::Index::is_readable </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if the index can be read from. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if index is readable, false otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a307b4046a7206d9712ad485443104986"></a><!-- doxytag: member="Gst::Index::is_writable" ref="a307b4046a7206d9712ad485443104986" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gst::Index::is_writable </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if the index can be written to. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if index is writable, false otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a87e945c16059db3705fd37fbd8280df7"></a><!-- doxytag: member="Gst::Index::new_group" ref="a87e945c16059db3705fd37fbd8280df7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Gst::Index::new_group </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new group for the given index. </p>
<p>It will be set as the current group. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The id of the newly created group. </dd></dl>
</div>
</div>
<a class="anchor" id="a12f6b0988ba179a7a6d8001144009a63"></a><!-- doxytag: member="Gst::Index::on_entry_added" ref="a12f6b0988ba179a7a6d8001144009a63" args="(const Gst::IndexEntry &entry)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Gst::Index::on_entry_added </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGst_1_1IndexEntry.html">Gst::IndexEntry</a>& </td>
<td class="paramname"> <em>entry</em></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ae3b856278c7094a3095b7bee07d170df"></a><!-- doxytag: member="Gst::Index::property_resolver" ref="ae3b856278c7094a3095b7bee07d170df" 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="../../../libsigc++-2.0/reference/html/classsigc_1_1slot.html">Gst::Index::SlotResolver</a>> Gst::Index::property_resolver </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Select a predefined object to string mapper. </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="ace6abab30265006b1a00e517d4b56f29"></a><!-- doxytag: member="Gst::Index::property_resolver" ref="ace6abab30265006b1a00e517d4b56f29" 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="../../../libsigc++-2.0/reference/html/classsigc_1_1slot.html">Gst::Index::SlotResolver</a>> Gst::Index::property_resolver </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Select a predefined object to string mapper. </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="a69415a5cbd07c1324cfe646e16df54f5"></a><!-- doxytag: member="Gst::Index::set_certainty" ref="a69415a5cbd07c1324cfe646e16df54f5" args="(IndexCertainty certainty)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gst::Index::set_certainty </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__gstreamermmEnums.html#gaa4c947a0c8ea32aca7f6218422a0b321">IndexCertainty</a> </td>
<td class="paramname"> <em>certainty</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the certainty of the given index. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>certainty</em> </td><td>The certainty to set. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aab80ec078746e0cb86bb69c404a369ea"></a><!-- doxytag: member="Gst::Index::set_filter" ref="aab80ec078746e0cb86bb69c404a369ea" args="(const SlotFilter &slot)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gst::Index::set_filter </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../libsigc++-2.0/reference/html/classsigc_1_1slot.html">SlotFilter</a> & </td>
<td class="paramname"> <em>slot</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Lets the app register a custom filter slot so that it can select what entries should be stored in the index. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>slot</em> </td><td>The filter slot to register. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad2814d284396a891f8673a69d04c446d"></a><!-- doxytag: member="Gst::Index::set_group" ref="ad2814d284396a891f8673a69d04c446d" args="(int group_number)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gst::Index::set_group </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>group_number</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the current groupnumber to the given argument. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>groupnum</em> </td><td>The groupnumber to set. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the operation succeeded, <code>false</code> if the group did not exist. </dd></dl>
</div>
</div>
<a class="anchor" id="a061e92ca9a7fc57c19d93cdd437bd11d"></a><!-- doxytag: member="Gst::Index::set_resolver" ref="a061e92ca9a7fc57c19d93cdd437bd11d" args="(const SlotResolver &slot)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gst::Index::set_resolver </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../libsigc++-2.0/reference/html/classsigc_1_1slot.html">SlotResolver</a> & </td>
<td class="paramname"> <em>slot</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Lets the app register a custom slot to map index ids to writer descriptions. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>slot</em> </td><td>The resolver slot to register. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4199ed73fe9dd1972ea411562a9e6cd0"></a><!-- doxytag: member="Gst::Index::signal_entry_added" ref="a4199ed73fe9dd1972ea411562a9e6cd0" 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_1SignalProxy1.html">Glib::SignalProxy1</a>< void,const <a class="el" href="classGst_1_1IndexEntry.html">Gst::IndexEntry</a>& > Gst::Index::signal_entry_added </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Emitted when a new entry is added to the index. </p>
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_entry_added(const <a class="el" href="classGst_1_1IndexEntry.html" title="The basic element of an index.">Gst::IndexEntry</a>& entry)</code> </dd></dl>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a2b476c599b3e9ed09d7c3dee4b790df0"></a><!-- doxytag: member="Gst::Index::wrap" ref="a2b476c599b3e9ed09d7c3dee4b790df0" args="(GstIndex *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_1Index.html">Gst::Index</a> > wrap </td>
<td>(</td>
<td class="paramtype">GstIndex * </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/index.h</li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Apr 12 20:33:52 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>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
contrib-release
>
by-pkgid
>
f493f9a612b4ddc437422c0df71f6b6a
>
files
>
498
