|  |  |  | GStreamer Base Plugins 0.10 Library Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Signals | ||||
#include <gst/interfaces/propertyprobe.h>
                    GstPropertyProbe;
                    GstPropertyProbeInterface;
const GList *       gst_property_probe_get_properties   (GstPropertyProbe *probe);
const GParamSpec *  gst_property_probe_get_property     (GstPropertyProbe *probe,
                                                         const gchar *name);
GValueArray *       gst_property_probe_get_values       (GstPropertyProbe *probe,
                                                         const GParamSpec *pspec);
GValueArray *       gst_property_probe_get_values_name  (GstPropertyProbe *probe,
                                                         const gchar *name);
gboolean            gst_property_probe_needs_probe      (GstPropertyProbe *probe,
                                                         const GParamSpec *pspec);
gboolean            gst_property_probe_needs_probe_name (GstPropertyProbe *probe,
                                                         const gchar *name);
GValueArray *       gst_property_probe_probe_and_get_values
                                                        (GstPropertyProbe *probe,
                                                         const GParamSpec *pspec);
GValueArray *       gst_property_probe_probe_and_get_values_name
                                                        (GstPropertyProbe *probe,
                                                         const gchar *name);
void                gst_property_probe_probe_property   (GstPropertyProbe *probe,
                                                         const GParamSpec *pspec);
void                gst_property_probe_probe_property_name
                                                        (GstPropertyProbe *probe,
                                                         const gchar *name);
The property probe is a way to autodetect allowed values for a GObject property. It's primary use is to autodetect device-names in several elements.
The interface is implemented by many hardware sources and sinks.
typedef struct _GstPropertyProbe GstPropertyProbe;
Opaque GstPropertyProbe data structure.
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);
} GstPropertyProbeInterface;
GstPropertyProbe interface.
| GTypeInterface  | parent interface type. | 
| 
 | default signal handler | 
| 
 | virtual method to get list of probable properties | 
| 
 | virtual method to tell if probe need update | 
| 
 | virtual method to probe a property | 
| 
 | virtual method to get probe results for a property | 
const GList * gst_property_probe_get_properties (GstPropertyProbe *probe);
Get a list of properties for which probing is supported.
| 
 | the GstPropertyProbe to get the properties for. | 
| Returns : | the list of properties for which probing is supported by this element. | 
const GParamSpec * gst_property_probe_get_property (GstPropertyProbe *probe, const gchar *name);
Get GParamSpec for a property for which probing is supported.
| 
 | the GstPropertyProbe to get the properties for. | 
| 
 | name of the property. | 
| Returns : | the GParamSpec of NULL. | 
GValueArray * gst_property_probe_get_values (GstPropertyProbe *probe, const GParamSpec *pspec);
Gets the possible (probed) values for the given property, requires the property to have been probed before.
| 
 | the GstPropertyProbe object. | 
| 
 | the GParamSpec property identifier. | 
| Returns : | A list of valid values for the given property. | 
GValueArray * gst_property_probe_get_values_name (GstPropertyProbe *probe, const gchar *name);
Same as gst_property_probe_get_values().
| 
 | the GstPropertyProbe object. | 
| 
 | the name of the property to get values for. | 
| Returns : | A list of valid values for the given property. | 
gboolean gst_property_probe_needs_probe (GstPropertyProbe *probe, const GParamSpec *pspec);
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.
| 
 | the GstPropertyProbe object to which the given property belongs. | 
| 
 | a GParamSpec that identifies the property to check. | 
| Returns : | TRUE if the property needs a new probe, FALSE if not. | 
gboolean gst_property_probe_needs_probe_name (GstPropertyProbe *probe, const gchar *name);
Same as gst_property_probe_needs_probe().
| 
 | the GstPropertyProbe object to which the given property belongs. | 
| 
 | the name of the property to check. | 
| Returns : | TRUE if the property needs a new probe, FALSE if not. | 
GValueArray * gst_property_probe_probe_and_get_values (GstPropertyProbe *probe, const GParamSpec *pspec);
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.
| 
 | the GstPropertyProbe object. | 
| 
 | The GParamSpec property identifier. | 
| Returns : | the list of valid values for this property. | 
GValueArray * gst_property_probe_probe_and_get_values_name (GstPropertyProbe *probe, const gchar *name);
Same as gst_property_probe_probe_and_get_values().
| 
 | the GstPropertyProbe object. | 
| 
 | the name of the property to get values for. | 
| Returns : | the list of valid values for this property. | 
void gst_property_probe_probe_property (GstPropertyProbe *probe, const GParamSpec *pspec);
Runs a probe on the property specified by pspec
| 
 | the GstPropertyProbe to check. | 
| 
 | GParamSpec of the property. | 
void                gst_property_probe_probe_property_name
                                                        (GstPropertyProbe *probe,
                                                         const gchar *name);
Runs a probe on the property specified by name.
| 
 | the GstPropertyProbe to check. | 
| 
 | name of the property. | 
"probe-needed" signalvoid user_function (GstPropertyProbe *pspec, gpointer arg1, gpointer user_data) : Run Last
| 
 | GParamSpec that needs a probe | 
| 
 | user data set when the signal handler was connected. |