<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gstpropertyprobe</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="index.html" title="GStreamer Base Plugins 0.10 Library Reference Manual">
<link rel="up" href="gstreamer-interfaces.html" title="Interfaces Library">
<link rel="prev" href="gst-plugins-base-libs-gstnavigation.html" title="gstnavigation">
<link rel="next" href="gst-plugins-base-libs-gsttuner.html" title="gsttuner">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gstreamer-plugins-base.html" title="Part I. GStreamer Base Plugins Libraries">
<link rel="chapter" href="gstreamer-audio.html" title="Audio Library">
<link rel="chapter" href="gstreamer-cdda.html" title="CDDA Library">
<link rel="chapter" href="gstreamer-ffft.html" title="FFT Library">
<link rel="chapter" href="gstreamer-floatcast.html" title="FloatCast Library">
<link rel="chapter" href="gstreamer-interfaces.html" title="Interfaces Library">
<link rel="chapter" href="gstreamer-netbuffer.html" title="Network Buffer Library">
<link rel="chapter" href="gstreamer-riff.html" title="Riff Media Library">
<link rel="chapter" href="gstreamer-rtp.html" title="RTP Library">
<link rel="chapter" href="gstreamer-rtsp.html" title="RTSP Library">
<link rel="chapter" href="gstreamer-sdp.html" title="SDP Library">
<link rel="chapter" href="gstreamer-tag.html" title="Tag Support Library">
<link rel="chapter" href="gstreamer-base-utils.html" title="Base Utils Library">
<link rel="chapter" href="gstreamer-video.html" title="Video Library">
<link rel="part" href="gstreamer-libs-hierarchy.html" title="Part II. Object Hierarchy">
<link rel="index" href="api-index.html" title="Index">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<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>
<td><a accesskey="u" href="gstreamer-interfaces.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GStreamer Base Plugins 0.10 Library Reference Manual</th>
<td><a accesskey="n" href="gst-plugins-base-libs-gsttuner.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2609819" class="shortcut">Top</a>
 | 
<a href="#id2610220" class="shortcut">Description</a>
 | 
<a href="#id2610167" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2610192" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="gst-plugins-base-libs-gstpropertyprobe"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2609819"></a><span class="refentrytitle">gstpropertyprobe</span>
</h2>
<p>gstpropertyprobe</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<a name="GstPropertyProbe"></a><pre class="synopsis">
#include <gst/interfaces/propertyprobe.h>
<a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe-struct">GstPropertyProbe</a>;
<a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbeInterface">GstPropertyProbeInterface</a>;
const GList* <a href="gst-plugins-base-libs-gstpropertyprobe.html#gst-property-probe-get-properties">gst_property_probe_get_properties</a> (<a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe">GstPropertyProbe</a> *probe);
const GParamSpec* <a href="gst-plugins-base-libs-gstpropertyprobe.html#gst-property-probe-get-property">gst_property_probe_get_property</a> (<a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe">GstPropertyProbe</a> *probe,
const gchar *name);
GValueArray* <a href="gst-plugins-base-libs-gstpropertyprobe.html#gst-property-probe-get-values">gst_property_probe_get_values</a> (<a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe">GstPropertyProbe</a> *probe,
const GParamSpec *pspec);
GValueArray* <a href="gst-plugins-base-libs-gstpropertyprobe.html#gst-property-probe-get-values-name">gst_property_probe_get_values_name</a> (<a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe">GstPropertyProbe</a> *probe,
const gchar *name);
gboolean <a href="gst-plugins-base-libs-gstpropertyprobe.html#gst-property-probe-needs-probe">gst_property_probe_needs_probe</a> (<a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe">GstPropertyProbe</a> *probe,
const GParamSpec *pspec);
gboolean <a href="gst-plugins-base-libs-gstpropertyprobe.html#gst-property-probe-needs-probe-name">gst_property_probe_needs_probe_name</a> (<a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe">GstPropertyProbe</a> *probe,
const gchar *name);
GValueArray* <a href="gst-plugins-base-libs-gstpropertyprobe.html#gst-property-probe-probe-and-get-values">gst_property_probe_probe_and_get_values</a>
(<a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe">GstPropertyProbe</a> *probe,
const GParamSpec *pspec);
GValueArray* <a href="gst-plugins-base-libs-gstpropertyprobe.html#gst-property-probe-probe-and-get-values-name">gst_property_probe_probe_and_get_values_name</a>
(<a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe">GstPropertyProbe</a> *probe,
const gchar *name);
void <a href="gst-plugins-base-libs-gstpropertyprobe.html#gst-property-probe-probe-property">gst_property_probe_probe_property</a> (<a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe">GstPropertyProbe</a> *probe,
const GParamSpec *pspec);
void <a href="gst-plugins-base-libs-gstpropertyprobe.html#gst-property-probe-probe-property-name">gst_property_probe_probe_property_name</a>
(<a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe">GstPropertyProbe</a> *probe,
const gchar *name);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2610167"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----GstPropertyProbe
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2610192"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe-probe-needed">probe-needed</a>" : Run Last
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2610220"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2610235"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2610245"></a><h3>
<a name="GstPropertyProbe-struct"></a>GstPropertyProbe</h3>
<a class="indexterm" name="id2610258"></a><pre class="programlisting">typedef struct _GstPropertyProbe GstPropertyProbe;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610274"></a><h3>
<a name="GstPropertyProbeInterface"></a>GstPropertyProbeInterface</h3>
<a class="indexterm" name="id2610286"></a><pre class="programlisting">typedef struct {
GTypeInterface klass;
/* signals */
void (*probe_needed) (GstPropertyProbe *probe,
const GParamSpec *pspec);
/* virtual functions */
const GList * (*get_properties) (GstPropertyProbe *probe);
gboolean (*needs_probe) (GstPropertyProbe *probe,
guint prop_id,
const GParamSpec *pspec);
void (*probe_property) (GstPropertyProbe *probe,
guint prop_id,
const GParamSpec *pspec);
GValueArray * (*get_values) (GstPropertyProbe *probe,
guint prop_id,
const GParamSpec *pspec);
gpointer _gst_reserved[GST_PADDING];
} GstPropertyProbeInterface;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610316"></a><h3>
<a name="gst-property-probe-get-properties"></a>gst_property_probe_get_properties ()</h3>
<a class="indexterm" name="id2610329"></a><pre class="programlisting">const GList* gst_property_probe_get_properties (<a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe">GstPropertyProbe</a> *probe);</pre>
<p>
Get a list of properties for which probing is supported.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>probe</code></em> :</span></td>
<td> the <a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> to get the properties for.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the list of properties for which probing is supported
by this element.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610401"></a><h3>
<a name="gst-property-probe-get-property"></a>gst_property_probe_get_property ()</h3>
<a class="indexterm" name="id2610414"></a><pre class="programlisting">const GParamSpec* gst_property_probe_get_property (<a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe">GstPropertyProbe</a> *probe,
const gchar *name);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>probe</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610494"></a><h3>
<a name="gst-property-probe-get-values"></a>gst_property_probe_get_values ()</h3>
<a class="indexterm" name="id2610507"></a><pre class="programlisting">GValueArray* gst_property_probe_get_values (<a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe">GstPropertyProbe</a> *probe,
const GParamSpec *pspec);</pre>
<p>
Gets the possible (probed) values for the given property,
requires the property to have been probed before.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>probe</code></em> :</span></td>
<td> the <a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> object.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>pspec</code></em> :</span></td>
<td> the <span class="type">GParamSpec</span> property identifier.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A list of valid values for the given property.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610609"></a><h3>
<a name="gst-property-probe-get-values-name"></a>gst_property_probe_get_values_name ()</h3>
<a class="indexterm" name="id2610623"></a><pre class="programlisting">GValueArray* gst_property_probe_get_values_name (<a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe">GstPropertyProbe</a> *probe,
const gchar *name);</pre>
<p>
Same as <a href="gst-plugins-base-libs-gstpropertyprobe.html#gst-property-probe-get-values"><code class="function">gst_property_probe_get_values()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>probe</code></em> :</span></td>
<td> the <a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> object.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> the name of the property to get values for.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A list of valid values for the given property.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610726"></a><h3>
<a name="gst-property-probe-needs-probe"></a>gst_property_probe_needs_probe ()</h3>
<a class="indexterm" name="id2610740"></a><pre class="programlisting">gboolean gst_property_probe_needs_probe (<a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe">GstPropertyProbe</a> *probe,
const GParamSpec *pspec);</pre>
<p>
Checks whether a property needs a probe. This might be because
the property wasn't initialized before, or because host setup
changed. This might be, for example, because a new device was
added, and thus device probing needs to be refreshed to display
the new device.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>probe</code></em> :</span></td>
<td> the <a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> object to which the given property belongs.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>pspec</code></em> :</span></td>
<td> a <span class="type">GParamSpec</span> that identifies the property to check.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE if the property needs a new probe, FALSE if not.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610845"></a><h3>
<a name="gst-property-probe-needs-probe-name"></a>gst_property_probe_needs_probe_name ()</h3>
<a class="indexterm" name="id2610859"></a><pre class="programlisting">gboolean gst_property_probe_needs_probe_name (<a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe">GstPropertyProbe</a> *probe,
const gchar *name);</pre>
<p>
Same as <a href="gst-plugins-base-libs-gstpropertyprobe.html#gst-property-probe-needs-probe"><code class="function">gst_property_probe_needs_probe()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>probe</code></em> :</span></td>
<td> the <a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> object to which the given property belongs.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> the name of the property to check.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE if the property needs a new probe, FALSE if not.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610962"></a><h3>
<a name="gst-property-probe-probe-and-get-values"></a>gst_property_probe_probe_and_get_values ()</h3>
<a class="indexterm" name="id2610976"></a><pre class="programlisting">GValueArray* gst_property_probe_probe_and_get_values
(<a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe">GstPropertyProbe</a> *probe,
const GParamSpec *pspec);</pre>
<p>
Check whether the given property requires a new probe. If so,
fo the probe. After that, retrieve a value list. Meant as a
utility function that wraps the above functions.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>probe</code></em> :</span></td>
<td> the <a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> object.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>pspec</code></em> :</span></td>
<td> The <span class="type">GParamSpec</span> property identifier.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the list of valid values for this property.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2611079"></a><h3>
<a name="gst-property-probe-probe-and-get-values-name"></a>gst_property_probe_probe_and_get_values_name ()</h3>
<a class="indexterm" name="id2611094"></a><pre class="programlisting">GValueArray* gst_property_probe_probe_and_get_values_name
(<a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe">GstPropertyProbe</a> *probe,
const gchar *name);</pre>
<p>
Same as <a href="gst-plugins-base-libs-gstpropertyprobe.html#gst-property-probe-probe-and-get-values"><code class="function">gst_property_probe_probe_and_get_values()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>probe</code></em> :</span></td>
<td> the <a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> object.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> the name of the property to get values for.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the list of valid values for this property.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2611199"></a><h3>
<a name="gst-property-probe-probe-property"></a>gst_property_probe_probe_property ()</h3>
<a class="indexterm" name="id2611214"></a><pre class="programlisting">void gst_property_probe_probe_property (<a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe">GstPropertyProbe</a> *probe,
const GParamSpec *pspec);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>probe</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>pspec</code></em> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2611281"></a><h3>
<a name="gst-property-probe-probe-property-name"></a>gst_property_probe_probe_property_name ()</h3>
<a class="indexterm" name="id2611295"></a><pre class="programlisting">void gst_property_probe_probe_property_name
(<a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe">GstPropertyProbe</a> *probe,
const gchar *name);</pre>
<p>
Runs a probe on the given property.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>probe</code></em> :</span></td>
<td> the <a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe"><span class="type">GstPropertyProbe</span></a> to check.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> name of the property to return.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2611379"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2611390"></a><h3>
<a name="GstPropertyProbe-probe-needed"></a>The "probe-needed" signal</h3>
<a class="indexterm" name="id2611400"></a><pre class="programlisting">void user_function (<a href="gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe">GstPropertyProbe</a> *gstpropertyprobe,
gpointer arg1,
gpointer user_data) : Run Last</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>gstpropertyprobe</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>arg1</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>
