diff options
Diffstat (limited to 'sys/oss/gstosssink.c')
| -rw-r--r-- | sys/oss/gstosssink.c | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/sys/oss/gstosssink.c b/sys/oss/gstosssink.c index f2621071..9f2902a0 100644 --- a/sys/oss/gstosssink.c +++ b/sys/oss/gstosssink.c @@ -20,6 +20,37 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-osssink + * @short_description: output sound using OSS + * + * <refsect2> + * <para> + * This element lets you output sound using the Open Sound System (OSS). + * </para> + * <para> + * Note that you should almost always use generic audio conversion elements + * like audioconvert and audioresample in front of an audiosink to make sure + * your pipeline works under all circumstances (those conversion elements will + * act in passthrough-mode if no conversion is necessary). + * </para> + * <title>Example pipelines</title> + * <para> + * <programlisting> + * gst-launch -v audiotestsrc ! audioconvert ! volume volume=0.1 ! osssink + * </programlisting> + * will output a sine wave (continuous beep sound) to your sound card (with + * a very low volume as precaution). + * </para> + * <para> + * <programlisting> + * gst-launch -v filesrc location=music.ogg ! decodebin ! audioconvert ! audioresample ! osssink + * </programlisting> + * will play an Ogg/Vorbis audio file and output it using the Open Sound System. + * </para> + * </refsect2> + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif |