summaryrefslogtreecommitdiffstats
path: root/gst/autodetect
diff options
context:
space:
mode:
authorThomas Vander Stichele <thomas@apestaart.org>2005-11-25 21:02:16 +0000
committerThomas Vander Stichele <thomas@apestaart.org>2005-11-25 21:02:16 +0000
commit695afd0edf89656a157ee65a7de537f9989ebb41 (patch)
treeb669c05100f5ed6c7e27a8eeaa1ab0509911dd18 /gst/autodetect
parent7b858529510534d9e8e45d1df5883b62fd910396 (diff)
documenting auto*sink using strstr for the video sink lookup, class field is not ordered update other plugins
Original commit message from CVS: * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-good-plugins-docs.sgml: * docs/plugins/gst-plugins-good-plugins-sections.txt: * gst/autodetect/gstautoaudiosink.c: (gst_auto_audio_sink_base_init): * gst/autodetect/gstautovideosink.c: (gst_auto_video_sink_base_init), (gst_auto_video_sink_factory_filter): documenting auto*sink using strstr for the video sink lookup, class field is not ordered update other plugins
Diffstat (limited to 'gst/autodetect')
-rw-r--r--gst/autodetect/gstautoaudiosink.c22
-rw-r--r--gst/autodetect/gstautovideosink.c24
2 files changed, 43 insertions, 3 deletions
diff --git a/gst/autodetect/gstautoaudiosink.c b/gst/autodetect/gstautoaudiosink.c
index 3e540822..28892f4f 100644
--- a/gst/autodetect/gstautoaudiosink.c
+++ b/gst/autodetect/gstautoaudiosink.c
@@ -17,6 +17,26 @@
* Boston, MA 02111-1307, USA.
*/
+/**
+ * SECTION:element-autoaudiosink
+ * @see_also: autovideosink, alsasink, osssink
+ *
+ * <refsect2>
+ * <para>
+ * autoaudiosink is an audio sink that automatically detects an appropriate
+ * audio sink to use. It does so by scanning the registry for all elements
+ * that have <quote>Sink</quote> and <quote>Audio</quote> in the class field
+ * of their element information, and also have a non-zero autoplugging rank.
+ * </para>
+ * <title>Example launch line</title>
+ * <para>
+ * <programlisting>
+ * gst-launch -v -m audiotestsrc ! autoaudiosink
+ * </programlisting>
+ * </para>
+ * </refsect2>
+ */
+
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
@@ -39,7 +59,7 @@ gst_auto_audio_sink_base_init (gpointer klass)
GstElementDetails gst_auto_audio_sink_details = {
"Auto audio sink",
"Sink/Audio",
- "Audio sink embedding the Auto-settings for audio output",
+ "Wrapper audio sink for automatically detected audio sink",
"Ronald Bultje <rbultje@ronald.bitfreak.net>"
};
GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
diff --git a/gst/autodetect/gstautovideosink.c b/gst/autodetect/gstautovideosink.c
index 0a303770..8859492f 100644
--- a/gst/autodetect/gstautovideosink.c
+++ b/gst/autodetect/gstautovideosink.c
@@ -17,6 +17,26 @@
* Boston, MA 02111-1307, USA.
*/
+/**
+ * SECTION:element-autovideosink
+ * @see_also: autoaudiosink, ximagesink, xvimagesink, sdlvideosink
+ *
+ * <refsect2>
+ * <para>
+ * autovideosink is a video sink that automatically detects an appropriate
+ * video sink to use. It does so by scanning the registry for all elements
+ * that have <quote>Sink</quote> and <quote>Audio</quote> in the class field
+ * of their element information, and also have a non-zero autoplugging rank.
+ * </para>
+ * <title>Example launch line</title>
+ * <para>
+ * <programlisting>
+ * gst-launch -v -m videotestsrc ! autovideosink
+ * </programlisting>
+ * </para>
+ * </refsect2>
+ */
+
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
@@ -39,7 +59,7 @@ gst_auto_video_sink_base_init (gpointer klass)
GstElementDetails gst_auto_video_sink_details = {
"Auto video sink",
"Sink/Video",
- "Video sink embedding the Auto-settings for video output",
+ "Wrapper video sink for automatically detected video sink",
"Ronald Bultje <rbultje@ronald.bitfreak.net>"
};
GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
@@ -108,7 +128,7 @@ gst_auto_video_sink_factory_filter (GstPluginFeature * feature, gpointer data)
/* video sinks */
klass = gst_element_factory_get_klass (GST_ELEMENT_FACTORY (feature));
- if (strcmp (klass, "Sink/Video") != 0)
+ if (!(strstr (klass, "Sink") && strstr (klass, "Video")))
return FALSE;
/* only select elements with autoplugging rank */