diff options
| author | Thomas Vander Stichele <thomas@apestaart.org> | 2005-11-25 21:02:16 +0000 |
|---|---|---|
| committer | Thomas Vander Stichele <thomas@apestaart.org> | 2005-11-25 21:02:16 +0000 |
| commit | 695afd0edf89656a157ee65a7de537f9989ebb41 (patch) | |
| tree | b669c05100f5ed6c7e27a8eeaa1ab0509911dd18 /gst/autodetect/gstautoaudiosink.c | |
| parent | 7b858529510534d9e8e45d1df5883b62fd910396 (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/gstautoaudiosink.c')
| -rw-r--r-- | gst/autodetect/gstautoaudiosink.c | 22 |
1 files changed, 21 insertions, 1 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", |