Initialize Tizen 2.3
[framework/multimedia/gstreamer0.10.git] / mobile / docs / gst / html / GstPluginFeature.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>GstPluginFeature</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GStreamer 0.10 Core Reference Manual">
8 <link rel="up" href="libgstreamer.html" title="GStreamer Core Library">
9 <link rel="prev" href="GstPlugin.html" title="GstPlugin">
10 <link rel="next" href="gstreamer-GstPoll.html" title="GstPoll">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="GstPlugin.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="libgstreamer.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">GStreamer 0.10 Core Reference Manual</th>
21 <td><a accesskey="n" href="gstreamer-GstPoll.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#GstPluginFeature.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#GstPluginFeature.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#GstPluginFeature.object-hierarchy" class="shortcut">Object Hierarchy</a>
29 </td></tr>
30 </table>
31 <div class="refentry">
32 <a name="GstPluginFeature"></a><div class="titlepage"></div>
33 <div class="refnamediv"><table width="100%"><tr>
34 <td valign="top">
35 <h2><span class="refentrytitle"><a name="GstPluginFeature.top_of_page"></a>GstPluginFeature</span></h2>
36 <p>GstPluginFeature — Base class for contents of a GstPlugin</p>
37 </td>
38 <td valign="top" align="right"></td>
39 </tr></table></div>
40 <div class="refsynopsisdiv">
41 <a name="GstPluginFeature.synopsis"></a><h2>Synopsis</h2>
42 <pre class="synopsis">
43 #include &lt;gst/gst.h&gt;
44
45 struct              <a class="link" href="GstPluginFeature.html#GstPluginFeature-struct" title="struct GstPluginFeature">GstPluginFeature</a>;
46 #define             <a class="link" href="GstPluginFeature.html#GST-PLUGIN-FEATURE-NAME:CAPS" title="GST_PLUGIN_FEATURE_NAME()">GST_PLUGIN_FEATURE_NAME</a>             (feature)
47                     <a class="link" href="GstPluginFeature.html#GstTypeNameData" title="GstTypeNameData">GstTypeNameData</a>;
48 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (<a class="link" href="GstPluginFeature.html#GstPluginFeatureFilter" title="GstPluginFeatureFilter ()">*GstPluginFeatureFilter</a>)           (<em class="parameter"><code><a class="link" href="GstPluginFeature.html" title="GstPluginFeature"><span class="type">GstPluginFeature</span></a> *feature</code></em>,
49                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
50 enum                <a class="link" href="GstPluginFeature.html#GstRank" title="enum GstRank">GstRank</a>;
51 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GstPluginFeature.html#gst-plugin-feature-type-name-filter" title="gst_plugin_feature_type_name_filter ()">gst_plugin_feature_type_name_filter</a> (<em class="parameter"><code><a class="link" href="GstPluginFeature.html" title="GstPluginFeature"><span class="type">GstPluginFeature</span></a> *feature</code></em>,
52                                                          <em class="parameter"><code><a class="link" href="GstPluginFeature.html#GstTypeNameData" title="GstTypeNameData"><span class="type">GstTypeNameData</span></a> *data</code></em>);
53 <span class="returnvalue">void</span>                <a class="link" href="GstPluginFeature.html#gst-plugin-feature-set-rank" title="gst_plugin_feature_set_rank ()">gst_plugin_feature_set_rank</a>         (<em class="parameter"><code><a class="link" href="GstPluginFeature.html" title="GstPluginFeature"><span class="type">GstPluginFeature</span></a> *feature</code></em>,
54                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> rank</code></em>);
55 <span class="returnvalue">void</span>                <a class="link" href="GstPluginFeature.html#gst-plugin-feature-set-name" title="gst_plugin_feature_set_name ()">gst_plugin_feature_set_name</a>         (<em class="parameter"><code><a class="link" href="GstPluginFeature.html" title="GstPluginFeature"><span class="type">GstPluginFeature</span></a> *feature</code></em>,
56                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
57 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="GstPluginFeature.html#gst-plugin-feature-get-rank" title="gst_plugin_feature_get_rank ()">gst_plugin_feature_get_rank</a>         (<em class="parameter"><code><a class="link" href="GstPluginFeature.html" title="GstPluginFeature"><span class="type">GstPluginFeature</span></a> *feature</code></em>);
58 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="GstPluginFeature.html#gst-plugin-feature-get-name" title="gst_plugin_feature_get_name ()">gst_plugin_feature_get_name</a>         (<em class="parameter"><code><a class="link" href="GstPluginFeature.html" title="GstPluginFeature"><span class="type">GstPluginFeature</span></a> *feature</code></em>);
59 <a class="link" href="GstPluginFeature.html" title="GstPluginFeature"><span class="returnvalue">GstPluginFeature</span></a> *  <a class="link" href="GstPluginFeature.html#gst-plugin-feature-load" title="gst_plugin_feature_load ()">gst_plugin_feature_load</a>             (<em class="parameter"><code><a class="link" href="GstPluginFeature.html" title="GstPluginFeature"><span class="type">GstPluginFeature</span></a> *feature</code></em>);
60 <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="GstPluginFeature.html#gst-plugin-feature-list-copy" title="gst_plugin_feature_list_copy ()">gst_plugin_feature_list_copy</a>        (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *list</code></em>);
61 <span class="returnvalue">void</span>                <a class="link" href="GstPluginFeature.html#gst-plugin-feature-list-free" title="gst_plugin_feature_list_free ()">gst_plugin_feature_list_free</a>        (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *list</code></em>);
62 #define             <a class="link" href="GstPluginFeature.html#GST-PLUGIN-FEATURE-LIST-DEBUG:CAPS" title="GST_PLUGIN_FEATURE_LIST_DEBUG()">GST_PLUGIN_FEATURE_LIST_DEBUG</a>       (list)
63 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GstPluginFeature.html#gst-plugin-feature-check-version" title="gst_plugin_feature_check_version ()">gst_plugin_feature_check_version</a>    (<em class="parameter"><code><a class="link" href="GstPluginFeature.html" title="GstPluginFeature"><span class="type">GstPluginFeature</span></a> *feature</code></em>,
64                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> min_major</code></em>,
65                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> min_minor</code></em>,
66                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> min_micro</code></em>);
67 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="GstPluginFeature.html#gst-plugin-feature-rank-compare-func" title="gst_plugin_feature_rank_compare_func ()">gst_plugin_feature_rank_compare_func</a>
68                                                         (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> p1</code></em>,
69                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> p2</code></em>);
70 </pre>
71 </div>
72 <div class="refsect1">
73 <a name="GstPluginFeature.object-hierarchy"></a><h2>Object Hierarchy</h2>
74 <pre class="synopsis">
75   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
76    +----<a class="link" href="GstObject.html" title="GstObject">GstObject</a>
77          +----GstPluginFeature
78                +----<a class="link" href="GstElementFactory.html" title="GstElementFactory">GstElementFactory</a>
79                +----<a class="link" href="GstTypeFindFactory.html" title="GstTypeFindFactory">GstTypeFindFactory</a>
80                +----<a class="link" href="GstIndexFactory.html" title="GstIndexFactory">GstIndexFactory</a>
81 </pre>
82 </div>
83 <div class="refsect1">
84 <a name="GstPluginFeature.description"></a><h2>Description</h2>
85 <p>
86 This is a base class for anything that can be added to a <a class="link" href="GstPlugin.html" title="GstPlugin"><span class="type">GstPlugin</span></a>.
87 </p>
88 </div>
89 <div class="refsect1">
90 <a name="GstPluginFeature.details"></a><h2>Details</h2>
91 <div class="refsect2">
92 <a name="GstPluginFeature-struct"></a><h3>struct GstPluginFeature</h3>
93 <pre class="programlisting">struct GstPluginFeature;</pre>
94 <p>
95 Opaque <a class="link" href="GstPluginFeature.html" title="GstPluginFeature"><span class="type">GstPluginFeature</span></a> structure.
96 </p>
97 </div>
98 <hr>
99 <div class="refsect2">
100 <a name="GST-PLUGIN-FEATURE-NAME:CAPS"></a><h3>GST_PLUGIN_FEATURE_NAME()</h3>
101 <pre class="programlisting">#define GST_PLUGIN_FEATURE_NAME(feature)  (GST_PLUGIN_FEATURE (feature)-&gt;name)
102 </pre>
103 <p>
104 Get the name of the feature
105 </p>
106 <div class="variablelist"><table border="0">
107 <col align="left" valign="top">
108 <tbody><tr>
109 <td><p><span class="term"><em class="parameter"><code>feature</code></em> :</span></p></td>
110 <td>The feature to query</td>
111 </tr></tbody>
112 </table></div>
113 </div>
114 <hr>
115 <div class="refsect2">
116 <a name="GstTypeNameData"></a><h3>GstTypeNameData</h3>
117 <pre class="programlisting">typedef struct {
118   const gchar   *name;
119   GType          type;
120 } GstTypeNameData;
121 </pre>
122 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
123 <h3 class="title">Warning</h3>
124 <p><code class="literal">GstTypeNameData</code> is deprecated and should not be used in newly-written code.</p>
125 </div>
126 <p>
127 Structure used for filtering based on <em class="parameter"><code>name</code></em> and <em class="parameter"><code>type</code></em>.
128 </p>
129 <div class="variablelist"><table border="0">
130 <col align="left" valign="top">
131 <tbody>
132 <tr>
133 <td><p><span class="term">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GstTypeNameData.name"></a>name</code></em>;</span></p></td>
134 <td>a name</td>
135 </tr>
136 <tr>
137 <td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> <em class="structfield"><code><a name="GstTypeNameData.type"></a>type</code></em>;</span></p></td>
138 <td>a GType</td>
139 </tr>
140 </tbody>
141 </table></div>
142 </div>
143 <hr>
144 <div class="refsect2">
145 <a name="GstPluginFeatureFilter"></a><h3>GstPluginFeatureFilter ()</h3>
146 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (*GstPluginFeatureFilter)           (<em class="parameter"><code><a class="link" href="GstPluginFeature.html" title="GstPluginFeature"><span class="type">GstPluginFeature</span></a> *feature</code></em>,
147                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
148 <p>
149 A function that can be used with e.g. <a class="link" href="GstRegistry.html#gst-registry-feature-filter" title="gst_registry_feature_filter ()"><code class="function">gst_registry_feature_filter()</code></a>
150 to get a list of pluginfeature that match certain criteria.
151 </p>
152 <div class="variablelist"><table border="0">
153 <col align="left" valign="top">
154 <tbody>
155 <tr>
156 <td><p><span class="term"><em class="parameter"><code>feature</code></em> :</span></p></td>
157 <td>the pluginfeature to check</td>
158 </tr>
159 <tr>
160 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
161 <td>the user_data that has been passed on e.g.
162 <a class="link" href="GstRegistry.html#gst-registry-feature-filter" title="gst_registry_feature_filter ()"><code class="function">gst_registry_feature_filter()</code></a>
163 </td>
164 </tr>
165 <tr>
166 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
167 <td>
168 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for a positive match, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
169 </tr>
170 </tbody>
171 </table></div>
172 </div>
173 <hr>
174 <div class="refsect2">
175 <a name="GstRank"></a><h3>enum GstRank</h3>
176 <pre class="programlisting">typedef enum {
177   GST_RANK_NONE                 = 0,
178   GST_RANK_MARGINAL             = 64,
179   GST_RANK_SECONDARY            = 128,
180   GST_RANK_PRIMARY              = 256
181 } GstRank;
182 </pre>
183 <p>
184 Element priority ranks. Defines the order in which the autoplugger (or
185 similar rank-picking mechanisms, such as e.g. <a class="link" href="gstreamer-GstUriHandler.html#gst-element-make-from-uri" title="gst_element_make_from_uri ()"><code class="function">gst_element_make_from_uri()</code></a>)
186 will choose this element over an alternative one with the same function.
187 </p>
188 <p>
189 These constants serve as a rough guidance for defining the rank of a
190 <a class="link" href="GstPluginFeature.html" title="GstPluginFeature"><span class="type">GstPluginFeature</span></a>. Any value is valid, including values bigger than
191 <em class="parameter"><code>GST_RANK_PRIMARY</code></em>.
192 </p>
193 <div class="variablelist"><table border="0">
194 <col align="left" valign="top">
195 <tbody>
196 <tr>
197 <td><p><a name="GST-RANK-NONE:CAPS"></a><span class="term"><code class="literal">GST_RANK_NONE</code></span></p></td>
198 <td>will be chosen last or not at all
199 </td>
200 </tr>
201 <tr>
202 <td><p><a name="GST-RANK-MARGINAL:CAPS"></a><span class="term"><code class="literal">GST_RANK_MARGINAL</code></span></p></td>
203 <td>unlikely to be chosen
204 </td>
205 </tr>
206 <tr>
207 <td><p><a name="GST-RANK-SECONDARY:CAPS"></a><span class="term"><code class="literal">GST_RANK_SECONDARY</code></span></p></td>
208 <td>likely to be chosen
209 </td>
210 </tr>
211 <tr>
212 <td><p><a name="GST-RANK-PRIMARY:CAPS"></a><span class="term"><code class="literal">GST_RANK_PRIMARY</code></span></p></td>
213 <td>will be chosen first
214 </td>
215 </tr>
216 </tbody>
217 </table></div>
218 </div>
219 <hr>
220 <div class="refsect2">
221 <a name="gst-plugin-feature-type-name-filter"></a><h3>gst_plugin_feature_type_name_filter ()</h3>
222 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_plugin_feature_type_name_filter (<em class="parameter"><code><a class="link" href="GstPluginFeature.html" title="GstPluginFeature"><span class="type">GstPluginFeature</span></a> *feature</code></em>,
223                                                          <em class="parameter"><code><a class="link" href="GstPluginFeature.html#GstTypeNameData" title="GstTypeNameData"><span class="type">GstTypeNameData</span></a> *data</code></em>);</pre>
224 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
225 <h3 class="title">Warning</h3>
226 <p><code class="literal">gst_plugin_feature_type_name_filter</code> is deprecated and should not be used in newly-written code.</p>
227 </div>
228 <p>
229 Compares type and name of plugin feature. Can be used with <a class="link" href="gstreamer-GstFilter.html#gst-filter-run" title="gst_filter_run ()"><code class="function">gst_filter_run()</code></a>.
230 </p>
231 <div class="variablelist"><table border="0">
232 <col align="left" valign="top">
233 <tbody>
234 <tr>
235 <td><p><span class="term"><em class="parameter"><code>feature</code></em> :</span></p></td>
236 <td>the <a class="link" href="GstPluginFeature.html" title="GstPluginFeature"><span class="type">GstPluginFeature</span></a>
237 </td>
238 </tr>
239 <tr>
240 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
241 <td>the type and name to check against. <span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span>
242 </td>
243 </tr>
244 <tr>
245 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
246 <td>TRUE if equal.</td>
247 </tr>
248 </tbody>
249 </table></div>
250 </div>
251 <hr>
252 <div class="refsect2">
253 <a name="gst-plugin-feature-set-rank"></a><h3>gst_plugin_feature_set_rank ()</h3>
254 <pre class="programlisting"><span class="returnvalue">void</span>                gst_plugin_feature_set_rank         (<em class="parameter"><code><a class="link" href="GstPluginFeature.html" title="GstPluginFeature"><span class="type">GstPluginFeature</span></a> *feature</code></em>,
255                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> rank</code></em>);</pre>
256 <p>
257 Specifies a rank for a plugin feature, so that autoplugging uses
258 the most appropriate feature.
259 </p>
260 <div class="variablelist"><table border="0">
261 <col align="left" valign="top">
262 <tbody>
263 <tr>
264 <td><p><span class="term"><em class="parameter"><code>feature</code></em> :</span></p></td>
265 <td>feature to rank</td>
266 </tr>
267 <tr>
268 <td><p><span class="term"><em class="parameter"><code>rank</code></em> :</span></p></td>
269 <td>rank value - higher number means more priority rank</td>
270 </tr>
271 </tbody>
272 </table></div>
273 </div>
274 <hr>
275 <div class="refsect2">
276 <a name="gst-plugin-feature-set-name"></a><h3>gst_plugin_feature_set_name ()</h3>
277 <pre class="programlisting"><span class="returnvalue">void</span>                gst_plugin_feature_set_name         (<em class="parameter"><code><a class="link" href="GstPluginFeature.html" title="GstPluginFeature"><span class="type">GstPluginFeature</span></a> *feature</code></em>,
278                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
279 <p>
280 Sets the name of a plugin feature. The name uniquely identifies a feature
281 within all features of the same type. Renaming a plugin feature is not
282 allowed. A copy is made of the name so you should free the supplied <em class="parameter"><code>name</code></em>
283 after calling this function.
284 </p>
285 <div class="variablelist"><table border="0">
286 <col align="left" valign="top">
287 <tbody>
288 <tr>
289 <td><p><span class="term"><em class="parameter"><code>feature</code></em> :</span></p></td>
290 <td>a feature</td>
291 </tr>
292 <tr>
293 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
294 <td>the name to set</td>
295 </tr>
296 </tbody>
297 </table></div>
298 </div>
299 <hr>
300 <div class="refsect2">
301 <a name="gst-plugin-feature-get-rank"></a><h3>gst_plugin_feature_get_rank ()</h3>
302 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gst_plugin_feature_get_rank         (<em class="parameter"><code><a class="link" href="GstPluginFeature.html" title="GstPluginFeature"><span class="type">GstPluginFeature</span></a> *feature</code></em>);</pre>
303 <p>
304 Gets the rank of a plugin feature.
305 </p>
306 <div class="variablelist"><table border="0">
307 <col align="left" valign="top">
308 <tbody>
309 <tr>
310 <td><p><span class="term"><em class="parameter"><code>feature</code></em> :</span></p></td>
311 <td>a feature</td>
312 </tr>
313 <tr>
314 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
315 <td>The rank of the feature</td>
316 </tr>
317 </tbody>
318 </table></div>
319 </div>
320 <hr>
321 <div class="refsect2">
322 <a name="gst-plugin-feature-get-name"></a><h3>gst_plugin_feature_get_name ()</h3>
323 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gst_plugin_feature_get_name         (<em class="parameter"><code><a class="link" href="GstPluginFeature.html" title="GstPluginFeature"><span class="type">GstPluginFeature</span></a> *feature</code></em>);</pre>
324 <p>
325 Gets the name of a plugin feature.
326 </p>
327 <div class="variablelist"><table border="0">
328 <col align="left" valign="top">
329 <tbody>
330 <tr>
331 <td><p><span class="term"><em class="parameter"><code>feature</code></em> :</span></p></td>
332 <td>a feature</td>
333 </tr>
334 <tr>
335 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
336 <td>the name</td>
337 </tr>
338 </tbody>
339 </table></div>
340 </div>
341 <hr>
342 <div class="refsect2">
343 <a name="gst-plugin-feature-load"></a><h3>gst_plugin_feature_load ()</h3>
344 <pre class="programlisting"><a class="link" href="GstPluginFeature.html" title="GstPluginFeature"><span class="returnvalue">GstPluginFeature</span></a> *  gst_plugin_feature_load             (<em class="parameter"><code><a class="link" href="GstPluginFeature.html" title="GstPluginFeature"><span class="type">GstPluginFeature</span></a> *feature</code></em>);</pre>
345 <p>
346 Loads the plugin containing <em class="parameter"><code>feature</code></em> if it's not already loaded. <em class="parameter"><code>feature</code></em> is
347 unaffected; use the return value instead.
348 </p>
349 <p>
350 Normally this function is used like this:
351 </p>
352 <div class="informalexample">
353   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
354     <tbody>
355       <tr>
356         <td class="listing_lines" align="right"><pre>1
357 2
358 3
359 4
360 5
361 6</pre></td>
362         <td class="listing_code"><pre class="programlisting">GstPluginFeature <span class="gtkdoc opt">*</span>loaded_feature<span class="gtkdoc opt">;</span>
363
364 loaded_feature <span class="gtkdoc opt">=</span> <span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPluginFeature.html#gst-plugin-feature-load">gst_plugin_feature_load</a></span> <span class="gtkdoc opt">(</span>feature<span class="gtkdoc opt">);</span>
365 <span class="gtkdoc slc">// presumably, we're no longer interested in the potentially-unloaded feature</span>
366 <span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html#gst-object-unref">gst_object_unref</a></span> <span class="gtkdoc opt">(</span>feature<span class="gtkdoc opt">);</span>
367 feature <span class="gtkdoc opt">=</span> loaded_feature<span class="gtkdoc opt">;</span></pre></td>
368       </tr>
369     </tbody>
370   </table>
371 </div>
372
373 <p>
374 </p>
375 <div class="variablelist"><table border="0">
376 <col align="left" valign="top">
377 <tbody>
378 <tr>
379 <td><p><span class="term"><em class="parameter"><code>feature</code></em> :</span></p></td>
380 <td>the plugin feature to check. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
381 </td>
382 </tr>
383 <tr>
384 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
385 <td>a reference to the loaded feature, or NULL on error. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
386 </td>
387 </tr>
388 </tbody>
389 </table></div>
390 </div>
391 <hr>
392 <div class="refsect2">
393 <a name="gst-plugin-feature-list-copy"></a><h3>gst_plugin_feature_list_copy ()</h3>
394 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             gst_plugin_feature_list_copy        (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *list</code></em>);</pre>
395 <p>
396 Copies the list of features. Caller should call <em class="parameter"><code>gst_plugin_feature_list_free</code></em>
397 when done with the list.
398 </p>
399 <div class="variablelist"><table border="0">
400 <col align="left" valign="top">
401 <tbody>
402 <tr>
403 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
404 <td>list
405 of <a class="link" href="GstPluginFeature.html" title="GstPluginFeature"><span class="type">GstPluginFeature</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Gst.PluginFeature]</span>
406 </td>
407 </tr>
408 <tr>
409 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
410 <td>a copy of <em class="parameter"><code>list</code></em>,
411 with each feature's reference count incremented. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Gst.PluginFeature]</span>
412 </td>
413 </tr>
414 </tbody>
415 </table></div>
416 <p class="since">Since 0.10.26</p>
417 </div>
418 <hr>
419 <div class="refsect2">
420 <a name="gst-plugin-feature-list-free"></a><h3>gst_plugin_feature_list_free ()</h3>
421 <pre class="programlisting"><span class="returnvalue">void</span>                gst_plugin_feature_list_free        (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *list</code></em>);</pre>
422 <p>
423 Unrefs each member of <em class="parameter"><code>list</code></em>, then frees the list.
424 </p>
425 <div class="variablelist"><table border="0">
426 <col align="left" valign="top">
427 <tbody><tr>
428 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
429 <td>list
430 of <a class="link" href="GstPluginFeature.html" title="GstPluginFeature"><span class="type">GstPluginFeature</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Gst.PluginFeature]</span>
431 </td>
432 </tr></tbody>
433 </table></div>
434 </div>
435 <hr>
436 <div class="refsect2">
437 <a name="GST-PLUGIN-FEATURE-LIST-DEBUG:CAPS"></a><h3>GST_PLUGIN_FEATURE_LIST_DEBUG()</h3>
438 <pre class="programlisting">#define GST_PLUGIN_FEATURE_LIST_DEBUG(list) gst_plugin_feature_list_debug(list)
439 </pre>
440 <p>
441 Debug the plugin feature names in <em class="parameter"><code>list</code></em>.
442 </p>
443 <div class="variablelist"><table border="0">
444 <col align="left" valign="top">
445 <tbody><tr>
446 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
447 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of
448 plugin features. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Gst.PluginFeature]</span>
449 </td>
450 </tr></tbody>
451 </table></div>
452 <p class="since">Since 0.10.31</p>
453 </div>
454 <hr>
455 <div class="refsect2">
456 <a name="gst-plugin-feature-check-version"></a><h3>gst_plugin_feature_check_version ()</h3>
457 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_plugin_feature_check_version    (<em class="parameter"><code><a class="link" href="GstPluginFeature.html" title="GstPluginFeature"><span class="type">GstPluginFeature</span></a> *feature</code></em>,
458                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> min_major</code></em>,
459                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> min_minor</code></em>,
460                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> min_micro</code></em>);</pre>
461 <p>
462 Checks whether the given plugin feature is at least
463  the required version
464 </p>
465 <div class="variablelist"><table border="0">
466 <col align="left" valign="top">
467 <tbody>
468 <tr>
469 <td><p><span class="term"><em class="parameter"><code>feature</code></em> :</span></p></td>
470 <td>a feature</td>
471 </tr>
472 <tr>
473 <td><p><span class="term"><em class="parameter"><code>min_major</code></em> :</span></p></td>
474 <td>minimum required major version</td>
475 </tr>
476 <tr>
477 <td><p><span class="term"><em class="parameter"><code>min_minor</code></em> :</span></p></td>
478 <td>minimum required minor version</td>
479 </tr>
480 <tr>
481 <td><p><span class="term"><em class="parameter"><code>min_micro</code></em> :</span></p></td>
482 <td>minimum required micro version</td>
483 </tr>
484 <tr>
485 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
486 <td>
487 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if the plugin feature has at least
488 the required version, otherwise <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a>.</td>
489 </tr>
490 </tbody>
491 </table></div>
492 </div>
493 <hr>
494 <div class="refsect2">
495 <a name="gst-plugin-feature-rank-compare-func"></a><h3>gst_plugin_feature_rank_compare_func ()</h3>
496 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                gst_plugin_feature_rank_compare_func
497                                                         (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> p1</code></em>,
498                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> p2</code></em>);</pre>
499 <p>
500 Compares the two given <a class="link" href="GstPluginFeature.html" title="GstPluginFeature"><span class="type">GstPluginFeature</span></a> instances. This function can be
501 used as a <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GCompareFunc"><span class="type">GCompareFunc</span></a> when sorting by rank and then by name.
502 </p>
503 <div class="variablelist"><table border="0">
504 <col align="left" valign="top">
505 <tbody>
506 <tr>
507 <td><p><span class="term"><em class="parameter"><code>p1</code></em> :</span></p></td>
508 <td>a <a class="link" href="GstPluginFeature.html" title="GstPluginFeature"><span class="type">GstPluginFeature</span></a>
509 </td>
510 </tr>
511 <tr>
512 <td><p><span class="term"><em class="parameter"><code>p2</code></em> :</span></p></td>
513 <td>a <a class="link" href="GstPluginFeature.html" title="GstPluginFeature"><span class="type">GstPluginFeature</span></a>
514 </td>
515 </tr>
516 <tr>
517 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
518 <td>negative value if the rank of p1 &gt; the rank of p2 or the ranks are
519 equal but the name of p1 comes before the name of p2; zero if the rank
520 and names are equal; positive value if the rank of p1 &lt; the rank of p2 or the
521 ranks are equal but the name of p2 comes after the name of p1</td>
522 </tr>
523 </tbody>
524 </table></div>
525 <p class="since">Since 0.10.31</p>
526 </div>
527 </div>
528 <div class="refsect1">
529 <a name="GstPluginFeature.see-also"></a><h2>See Also</h2>
530 <a class="link" href="GstPlugin.html" title="GstPlugin"><span class="type">GstPlugin</span></a>
531 </div>
532 </div>
533 <div class="footer">
534 <hr>
535           Generated by GTK-Doc V1.18</div>
536 </body>
537 </html>