diff options
| author | Stefan Kost <ensonic@users.sf.net> | 2009-01-29 10:10:08 +0200 |
|---|---|---|
| committer | Stefan Kost <ensonic@users.sf.net> | 2009-01-29 10:12:43 +0200 |
| commit | 6335307b9739beb568f986bfc8a4c1e1fb2b8e31 (patch) | |
| tree | 9b0187c295a459d31b016e15295131b912a57535 /sys/osxaudio | |
| parent | bdb07d50bef697c10658dce14f0e5c879a10fc44 (diff) | |
Update and add documentation for platform specific plugins (sys).
Link to properties. Correct titles for examples. Fix examples.
Diffstat (limited to 'sys/osxaudio')
| -rw-r--r-- | sys/osxaudio/gstosxaudio.c | 20 | ||||
| -rw-r--r-- | sys/osxaudio/gstosxaudiosink.c | 16 | ||||
| -rw-r--r-- | sys/osxaudio/gstosxaudiosrc.c | 12 |
3 files changed, 15 insertions, 33 deletions
diff --git a/sys/osxaudio/gstosxaudio.c b/sys/osxaudio/gstosxaudio.c index 262c7d91..1ddfce41 100644 --- a/sys/osxaudio/gstosxaudio.c +++ b/sys/osxaudio/gstosxaudio.c @@ -23,26 +23,6 @@ * */ -/** - * SECTION:element-osxaudiosink - * @short_description: play audio to an CoreAudio device - * - * <refsect2> - * <para> - * This element renders raw audio samples using the CoreAudio api. - * </para> - * <title>Example pipelines</title> - * <para> - * Play an Ogg/Vorbis file. - * </para> - * <programlisting> - * gst-launch -v filesrc location=sine.ogg ! oggdemux ! vorbisdec ! audioconvert ! audioresample ! osxaudiosink - * </programlisting> - * </refsect2> - * - * Last reviewed on 2006-03-01 (0.10.4) - */ - #ifdef HAVE_CONFIG_H #include "config.h" #endif diff --git a/sys/osxaudio/gstosxaudiosink.c b/sys/osxaudio/gstosxaudiosink.c index aec8874d..9447e652 100644 --- a/sys/osxaudio/gstosxaudiosink.c +++ b/sys/osxaudio/gstosxaudiosink.c @@ -47,16 +47,18 @@ */ /** - * SECTION:element-plugin + * SECTION:element-osxaudiosink + * + * This element renders raw audio samples using the CoreAudio api. * * <refsect2> - * <title>Example launch line</title> - * <para> - * <programlisting> - * gst-launch -v -m audiotestsrc ! audioconvert ! osxaudiosink - * </programlisting> - * </para> + * <title>Example pipelines</title> + * |[ + * gst-launch filesrc location=sine.ogg ! oggdemux ! vorbisdec ! audioconvert ! audioresample ! osxaudiosink + * ]| Play an Ogg/Vorbis file. * </refsect2> + * + * Last reviewed on 2006-03-01 (0.10.4) */ #ifdef HAVE_CONFIG_H diff --git a/sys/osxaudio/gstosxaudiosrc.c b/sys/osxaudio/gstosxaudiosrc.c index 1d99e8d8..9acf4405 100644 --- a/sys/osxaudio/gstosxaudiosrc.c +++ b/sys/osxaudio/gstosxaudiosrc.c @@ -43,15 +43,15 @@ */ /** - * SECTION:element-plugin + * SECTION:element-osxaudiosrc + * + * This element captures raw audio samples using the CoreAudio api. * * <refsect2> * <title>Example launch line</title> - * <para> - * <programlisting> - * gst-launch -v -m osxaudiosrc ! fakesink - * </programlisting> - * </para> + * |[ + * gst-launch osxaudiosrc ! wavenc ! filesink location=audio.wav + * ]| * </refsect2> */ |