diff options
| author | Stefan Kost <ensonic@users.sourceforge.net> | 2008-10-27 09:26:19 +0000 |
|---|---|---|
| committer | Stefan Kost <ensonic@users.sourceforge.net> | 2008-10-27 09:26:19 +0000 |
| commit | af1a12033d94712d219aea9deb2f0633dd302df6 (patch) | |
| tree | f970035d15a526caa1a8866c5338dc74e1dbd2a5 | |
| parent | 7f237108ea507136a6e9308a64ab9ce4cdcb5119 (diff) | |
ext/esd/esdmon.c: Add doc blob.
Original commit message from CVS:
* ext/esd/esdmon.c:
Add doc blob.
| -rw-r--r-- | ChangeLog | 5 | ||||
| -rw-r--r-- | ext/esd/esdmon.c | 20 |
2 files changed, 24 insertions, 1 deletions
@@ -1,5 +1,10 @@ 2008-10-27 Stefan Kost <ensonic@users.sf.net> + * ext/esd/esdmon.c: + Add doc blob. + +2008-10-27 Stefan Kost <ensonic@users.sf.net> + * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-good-plugins-docs.sgml: * docs/plugins/gst-plugins-good-plugins-sections.txt: diff --git a/ext/esd/esdmon.c b/ext/esd/esdmon.c index 2e10f2b1..880af9d8 100644 --- a/ext/esd/esdmon.c +++ b/ext/esd/esdmon.c @@ -19,7 +19,25 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ - +/** + * SECTION:element-esdmod + * + * 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. + * + * TODO: insert some comments about how sucky esd is and that all the cool + * kids use pulseaudio or whatever these days. + * + * <refsect2> + * <title>Example launch line</title> + * |[ + * gst-launch esdmon ! audioconvert ! waveenc ! filesink location=record.wav + * ]| Record from audioinput + * </refsect2> + */ #ifdef HAVE_CONFIG_H #include "config.h" #endif |