diff options
Diffstat (limited to 'ext/esd')
| -rw-r--r-- | ext/esd/esdsink.c | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/ext/esd/esdsink.c b/ext/esd/esdsink.c index 7882b33f..6ab2612b 100644 --- a/ext/esd/esdsink.c +++ b/ext/esd/esdsink.c @@ -22,6 +22,31 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-esdsink + * @see_also: #GstAlsaSink, #GstAutoAudioSink + * + * <refsect2> + * <para> + * This element outputs sound to an already-running Enlightened Sound Daemon + * (ESound Daemon, esd). Note that a sound daemon will never be auto-spawned + * through this element (regardless of the system configuration), since this + * is actively prevented by the element. If you must use esd, you need to + * make sure it is started automatically with your session or otherwise. + * </para> + * <para> + * TODO: insert some comments about how sucky esd is and that all the cool + * kids use pulseaudio or whatever these days. + * </para> + * <para> + * Simple example pipeline that plays an Ogg/Vorbis file via esd: + * <programlisting> + * gst-launch -v filesrc location=foo.ogg ! decodebin ! audioconvert ! audioresample ! esdsink + * </programlisting> + * </para> + * </refsect2> + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif |