Initialize Tizen 2.3
[framework/multimedia/gst-plugins-base0.10.git] / docs / libs / html / gst-plugins-base-libs-gstpropertyprobe.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>gstpropertyprobe</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Library Reference Manual">
8 <link rel="up" href="gstreamer-interfaces.html" title="Interfaces Library">
9 <link rel="prev" href="gst-plugins-base-libs-gstnavigation.html" title="gstnavigation">
10 <link rel="next" href="gst-plugins-base-libs-gststreamvolume.html" title="gststreamvolume">
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="gst-plugins-base-libs-gstnavigation.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="gstreamer-interfaces.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 Base Plugins 0.10 Library Reference Manual</th>
21 <td><a accesskey="n" href="gst-plugins-base-libs-gststreamvolume.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="#gst-plugins-base-libs-gstpropertyprobe.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-base-libs-gstpropertyprobe.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#gst-plugins-base-libs-gstpropertyprobe.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#gst-plugins-base-libs-gstpropertyprobe.signals" class="shortcut">Signals</a>
31 </td></tr>
32 </table>
33 <div class="refentry">
34 <a name="gst-plugins-base-libs-gstpropertyprobe"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
36 <td valign="top">
37 <h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gstpropertyprobe.top_of_page"></a>gstpropertyprobe</span></h2>
38 <p>gstpropertyprobe — Interface for probing possible property values</p>
39 </td>
40 <td valign="top" align="right"></td>
41 </tr></table></div>
42 <div class="refsynopsisdiv">
43 <a name="gst-plugins-base-libs-gstpropertyprobe.synopsis"></a><h2>Synopsis</h2>
44 <a name="GstPropertyProbe"></a><pre class="synopsis">
45 #include &lt;gst/interfaces/propertyprobe.h&gt;
46
47                     <a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe-struct" title="GstPropertyProbe">GstPropertyProbe</a>;
48 struct              <a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbeInterface" title="struct GstPropertyProbeInterface">GstPropertyProbeInterface</a>;
49 const <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="gst-plugins-base-libs-gstpropertyprobe.html#gst-property-probe-get-properties" title="gst_property_probe_get_properties ()">gst_property_probe_get_properties</a>   (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> *probe</code></em>);
50 const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="returnvalue">GParamSpec</span></a> *  <a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#gst-property-probe-get-property" title="gst_property_probe_get_property ()">gst_property_probe_get_property</a>     (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> *probe</code></em>,
51                                                          <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>);
52 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"><span class="returnvalue">GValueArray</span></a> *       <a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#gst-property-probe-get-values" title="gst_property_probe_get_values ()">gst_property_probe_get_values</a>       (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> *probe</code></em>,
53                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> *pspec</code></em>);
54 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"><span class="returnvalue">GValueArray</span></a> *       <a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#gst-property-probe-get-values-name" title="gst_property_probe_get_values_name ()">gst_property_probe_get_values_name</a>  (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> *probe</code></em>,
55                                                          <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>);
56 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#gst-property-probe-needs-probe" title="gst_property_probe_needs_probe ()">gst_property_probe_needs_probe</a>      (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> *probe</code></em>,
57                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> *pspec</code></em>);
58 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#gst-property-probe-needs-probe-name" title="gst_property_probe_needs_probe_name ()">gst_property_probe_needs_probe_name</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> *probe</code></em>,
59                                                          <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>);
60 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"><span class="returnvalue">GValueArray</span></a> *       <a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#gst-property-probe-probe-and-get-values" title="gst_property_probe_probe_and_get_values ()">gst_property_probe_probe_and_get_values</a>
61                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> *probe</code></em>,
62                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> *pspec</code></em>);
63 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"><span class="returnvalue">GValueArray</span></a> *       <a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#gst-property-probe-probe-and-get-values-name" title="gst_property_probe_probe_and_get_values_name ()">gst_property_probe_probe_and_get_values_name</a>
64                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> *probe</code></em>,
65                                                          <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>);
66 <span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#gst-property-probe-probe-property" title="gst_property_probe_probe_property ()">gst_property_probe_probe_property</a>   (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> *probe</code></em>,
67                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> *pspec</code></em>);
68 <span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#gst-property-probe-probe-property-name" title="gst_property_probe_probe_property_name ()">gst_property_probe_probe_property_name</a>
69                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> *probe</code></em>,
70                                                          <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>);
71 </pre>
72 </div>
73 <div class="refsect1">
74 <a name="gst-plugins-base-libs-gstpropertyprobe.object-hierarchy"></a><h2>Object Hierarchy</h2>
75 <pre class="synopsis">
76   GInterface
77    +----GstPropertyProbe
78 </pre>
79 </div>
80 <div class="refsect1">
81 <a name="gst-plugins-base-libs-gstpropertyprobe.signals"></a><h2>Signals</h2>
82 <pre class="synopsis">
83   "<a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe-probe-needed" title='The "probe-needed" signal'>probe-needed</a>"                                   : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
84 </pre>
85 </div>
86 <div class="refsect1">
87 <a name="gst-plugins-base-libs-gstpropertyprobe.description"></a><h2>Description</h2>
88 <p>
89 The property probe is a way to autodetect allowed values for a GObject
90 property. It's primary use is to autodetect device-names in several elements.
91 </p>
92 <p>
93 The interface is implemented by many hardware sources and sinks.
94 </p>
95 </div>
96 <div class="refsect1">
97 <a name="gst-plugins-base-libs-gstpropertyprobe.details"></a><h2>Details</h2>
98 <div class="refsect2">
99 <a name="GstPropertyProbe-struct"></a><h3>GstPropertyProbe</h3>
100 <pre class="programlisting">typedef struct _GstPropertyProbe GstPropertyProbe;</pre>
101 <p>
102 Opaque <a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> data structure.
103 </p>
104 </div>
105 <hr>
106 <div class="refsect2">
107 <a name="GstPropertyProbeInterface"></a><h3>struct GstPropertyProbeInterface</h3>
108 <pre class="programlisting">struct GstPropertyProbeInterface {
109   GTypeInterface klass;
110
111   /* signals */
112   void          (*probe_needed)   (GstPropertyProbe *probe,
113                                    const GParamSpec *pspec);
114
115   /* virtual functions */
116   const GList * (*get_properties) (GstPropertyProbe *probe);
117   gboolean      (*needs_probe)    (GstPropertyProbe *probe,
118                                    guint             prop_id,
119                                    const GParamSpec *pspec);
120   void          (*probe_property) (GstPropertyProbe *probe,
121                                    guint             prop_id,
122                                    const GParamSpec *pspec);
123   GValueArray * (*get_values)     (GstPropertyProbe *probe,
124                                    guint             prop_id,
125                                    const GParamSpec *pspec);
126 };
127 </pre>
128 <p>
129 <a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> interface.
130 </p>
131 <div class="variablelist"><table border="0">
132 <col align="left" valign="top">
133 <tbody>
134 <tr>
135 <td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="GstPropertyProbeInterface.klass"></a>klass</code></em>;</span></p></td>
136 <td>parent interface type.</td>
137 </tr>
138 <tr>
139 <td><p><span class="term"><em class="structfield"><code><a name="GstPropertyProbeInterface.probe-needed"></a>probe_needed</code></em> ()</span></p></td>
140 <td>default signal handler</td>
141 </tr>
142 <tr>
143 <td><p><span class="term"><em class="structfield"><code><a name="GstPropertyProbeInterface.get-properties"></a>get_properties</code></em> ()</span></p></td>
144 <td>virtual method to get list of probable properties</td>
145 </tr>
146 <tr>
147 <td><p><span class="term"><em class="structfield"><code><a name="GstPropertyProbeInterface.needs-probe"></a>needs_probe</code></em> ()</span></p></td>
148 <td>virtual method to tell if probe need update</td>
149 </tr>
150 <tr>
151 <td><p><span class="term"><em class="structfield"><code><a name="GstPropertyProbeInterface.probe-property"></a>probe_property</code></em> ()</span></p></td>
152 <td>virtual method to probe a property</td>
153 </tr>
154 <tr>
155 <td><p><span class="term"><em class="structfield"><code><a name="GstPropertyProbeInterface.get-values"></a>get_values</code></em> ()</span></p></td>
156 <td>virtual method to get probe results for a property</td>
157 </tr>
158 </tbody>
159 </table></div>
160 </div>
161 <hr>
162 <div class="refsect2">
163 <a name="gst-property-probe-get-properties"></a><h3>gst_property_probe_get_properties ()</h3>
164 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *       gst_property_probe_get_properties   (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> *probe</code></em>);</pre>
165 <p>
166 Get a list of properties for which probing is supported.
167 </p>
168 <div class="variablelist"><table border="0">
169 <col align="left" valign="top">
170 <tbody>
171 <tr>
172 <td><p><span class="term"><em class="parameter"><code>probe</code></em> :</span></p></td>
173 <td>the <a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> to get the properties for.</td>
174 </tr>
175 <tr>
176 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
177 <td>the list of <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> * pointers representing
178 properties for which probing is supported by this element.</td>
179 </tr>
180 </tbody>
181 </table></div>
182 </div>
183 <hr>
184 <div class="refsect2">
185 <a name="gst-property-probe-get-property"></a><h3>gst_property_probe_get_property ()</h3>
186 <pre class="programlisting">const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="returnvalue">GParamSpec</span></a> *  gst_property_probe_get_property     (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> *probe</code></em>,
187                                                          <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>
188 <p>
189 Get <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> for a property for which probing is supported.
190 </p>
191 <div class="variablelist"><table border="0">
192 <col align="left" valign="top">
193 <tbody>
194 <tr>
195 <td><p><span class="term"><em class="parameter"><code>probe</code></em> :</span></p></td>
196 <td>the <a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> to get the properties for.</td>
197 </tr>
198 <tr>
199 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
200 <td>name of the property.</td>
201 </tr>
202 <tr>
203 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
204 <td>the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> of <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
205 </tr>
206 </tbody>
207 </table></div>
208 </div>
209 <hr>
210 <div class="refsect2">
211 <a name="gst-property-probe-get-values"></a><h3>gst_property_probe_get_values ()</h3>
212 <pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"><span class="returnvalue">GValueArray</span></a> *       gst_property_probe_get_values       (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> *probe</code></em>,
213                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> *pspec</code></em>);</pre>
214 <p>
215 Gets the possible (probed) values for the given property,
216 requires the property to have been probed before.
217 </p>
218 <div class="variablelist"><table border="0">
219 <col align="left" valign="top">
220 <tbody>
221 <tr>
222 <td><p><span class="term"><em class="parameter"><code>probe</code></em> :</span></p></td>
223 <td>the <a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> object.</td>
224 </tr>
225 <tr>
226 <td><p><span class="term"><em class="parameter"><code>pspec</code></em> :</span></p></td>
227 <td>the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> property identifier.</td>
228 </tr>
229 <tr>
230 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
231 <td>A list of valid values for the given property.</td>
232 </tr>
233 </tbody>
234 </table></div>
235 </div>
236 <hr>
237 <div class="refsect2">
238 <a name="gst-property-probe-get-values-name"></a><h3>gst_property_probe_get_values_name ()</h3>
239 <pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"><span class="returnvalue">GValueArray</span></a> *       gst_property_probe_get_values_name  (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> *probe</code></em>,
240                                                          <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>
241 <p>
242 Same as <a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#gst-property-probe-get-values" title="gst_property_probe_get_values ()"><code class="function">gst_property_probe_get_values()</code></a>.
243 </p>
244 <div class="variablelist"><table border="0">
245 <col align="left" valign="top">
246 <tbody>
247 <tr>
248 <td><p><span class="term"><em class="parameter"><code>probe</code></em> :</span></p></td>
249 <td>the <a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> object.</td>
250 </tr>
251 <tr>
252 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
253 <td>the name of the property to get values for.</td>
254 </tr>
255 <tr>
256 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
257 <td>A list of valid values for the given property.</td>
258 </tr>
259 </tbody>
260 </table></div>
261 </div>
262 <hr>
263 <div class="refsect2">
264 <a name="gst-property-probe-needs-probe"></a><h3>gst_property_probe_needs_probe ()</h3>
265 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_property_probe_needs_probe      (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> *probe</code></em>,
266                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> *pspec</code></em>);</pre>
267 <p>
268 Checks whether a property needs a probe. This might be because
269 the property wasn't initialized before, or because host setup
270 changed. This might be, for example, because a new device was
271 added, and thus device probing needs to be refreshed to display
272 the new device.
273 </p>
274 <div class="variablelist"><table border="0">
275 <col align="left" valign="top">
276 <tbody>
277 <tr>
278 <td><p><span class="term"><em class="parameter"><code>probe</code></em> :</span></p></td>
279 <td>the <a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> object to which the given property belongs.</td>
280 </tr>
281 <tr>
282 <td><p><span class="term"><em class="parameter"><code>pspec</code></em> :</span></p></td>
283 <td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> that identifies the property to check.</td>
284 </tr>
285 <tr>
286 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
287 <td>TRUE if the property needs a new probe, FALSE if not.</td>
288 </tr>
289 </tbody>
290 </table></div>
291 </div>
292 <hr>
293 <div class="refsect2">
294 <a name="gst-property-probe-needs-probe-name"></a><h3>gst_property_probe_needs_probe_name ()</h3>
295 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_property_probe_needs_probe_name (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> *probe</code></em>,
296                                                          <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>
297 <p>
298 Same as <a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#gst-property-probe-needs-probe" title="gst_property_probe_needs_probe ()"><code class="function">gst_property_probe_needs_probe()</code></a>.
299 </p>
300 <div class="variablelist"><table border="0">
301 <col align="left" valign="top">
302 <tbody>
303 <tr>
304 <td><p><span class="term"><em class="parameter"><code>probe</code></em> :</span></p></td>
305 <td>the <a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> object to which the given property belongs.</td>
306 </tr>
307 <tr>
308 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
309 <td>the name of the property to check.</td>
310 </tr>
311 <tr>
312 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
313 <td>TRUE if the property needs a new probe, FALSE if not.</td>
314 </tr>
315 </tbody>
316 </table></div>
317 </div>
318 <hr>
319 <div class="refsect2">
320 <a name="gst-property-probe-probe-and-get-values"></a><h3>gst_property_probe_probe_and_get_values ()</h3>
321 <pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"><span class="returnvalue">GValueArray</span></a> *       gst_property_probe_probe_and_get_values
322                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> *probe</code></em>,
323                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> *pspec</code></em>);</pre>
324 <p>
325 Check whether the given property requires a new probe. If so,
326 fo the probe. After that, retrieve a value list. Meant as a
327 utility function that wraps the above functions.
328 </p>
329 <div class="variablelist"><table border="0">
330 <col align="left" valign="top">
331 <tbody>
332 <tr>
333 <td><p><span class="term"><em class="parameter"><code>probe</code></em> :</span></p></td>
334 <td>the <a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> object.</td>
335 </tr>
336 <tr>
337 <td><p><span class="term"><em class="parameter"><code>pspec</code></em> :</span></p></td>
338 <td>The <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> property identifier.</td>
339 </tr>
340 <tr>
341 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
342 <td>the list of valid values for this property.</td>
343 </tr>
344 </tbody>
345 </table></div>
346 </div>
347 <hr>
348 <div class="refsect2">
349 <a name="gst-property-probe-probe-and-get-values-name"></a><h3>gst_property_probe_probe_and_get_values_name ()</h3>
350 <pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"><span class="returnvalue">GValueArray</span></a> *       gst_property_probe_probe_and_get_values_name
351                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> *probe</code></em>,
352                                                          <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>
353 <p>
354 Same as <a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#gst-property-probe-probe-and-get-values" title="gst_property_probe_probe_and_get_values ()"><code class="function">gst_property_probe_probe_and_get_values()</code></a>.
355 </p>
356 <div class="variablelist"><table border="0">
357 <col align="left" valign="top">
358 <tbody>
359 <tr>
360 <td><p><span class="term"><em class="parameter"><code>probe</code></em> :</span></p></td>
361 <td>the <a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> object.</td>
362 </tr>
363 <tr>
364 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
365 <td>the name of the property to get values for.</td>
366 </tr>
367 <tr>
368 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
369 <td>the list of valid values for this property.</td>
370 </tr>
371 </tbody>
372 </table></div>
373 </div>
374 <hr>
375 <div class="refsect2">
376 <a name="gst-property-probe-probe-property"></a><h3>gst_property_probe_probe_property ()</h3>
377 <pre class="programlisting"><span class="returnvalue">void</span>                gst_property_probe_probe_property   (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> *probe</code></em>,
378                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> *pspec</code></em>);</pre>
379 <p>
380 Runs a probe on the property specified by <em class="parameter"><code>pspec</code></em>
381 </p>
382 <div class="variablelist"><table border="0">
383 <col align="left" valign="top">
384 <tbody>
385 <tr>
386 <td><p><span class="term"><em class="parameter"><code>probe</code></em> :</span></p></td>
387 <td>the <a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> to check.</td>
388 </tr>
389 <tr>
390 <td><p><span class="term"><em class="parameter"><code>pspec</code></em> :</span></p></td>
391 <td>
392 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> of the property.</td>
393 </tr>
394 </tbody>
395 </table></div>
396 </div>
397 <hr>
398 <div class="refsect2">
399 <a name="gst-property-probe-probe-property-name"></a><h3>gst_property_probe_probe_property_name ()</h3>
400 <pre class="programlisting"><span class="returnvalue">void</span>                gst_property_probe_probe_property_name
401                                                         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> *probe</code></em>,
402                                                          <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>
403 <p>
404 Runs a probe on the property specified by <em class="parameter"><code>name</code></em>.
405 </p>
406 <div class="variablelist"><table border="0">
407 <col align="left" valign="top">
408 <tbody>
409 <tr>
410 <td><p><span class="term"><em class="parameter"><code>probe</code></em> :</span></p></td>
411 <td>the <a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> to check.</td>
412 </tr>
413 <tr>
414 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
415 <td>name of the property.</td>
416 </tr>
417 </tbody>
418 </table></div>
419 </div>
420 </div>
421 <div class="refsect1">
422 <a name="gst-plugins-base-libs-gstpropertyprobe.signal-details"></a><h2>Signal Details</h2>
423 <div class="refsect2">
424 <a name="GstPropertyProbe-probe-needed"></a><h3>The <code class="literal">"probe-needed"</code> signal</h3>
425 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> *pspec,
426                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>          arg1,
427                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>          user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
428 <div class="variablelist"><table border="0">
429 <col align="left" valign="top">
430 <tbody>
431 <tr>
432 <td><p><span class="term"><em class="parameter"><code>pspec</code></em> :</span></p></td>
433 <td>
434 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> that needs a probe</td>
435 </tr>
436 <tr>
437 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
438 <td>user data set when the signal handler was connected.</td>
439 </tr>
440 </tbody>
441 </table></div>
442 </div>
443 </div>
444 </div>
445 <div class="footer">
446 <hr>
447           Generated by GTK-Doc V1.18</div>
448 </body>
449 </html>