summaryrefslogtreecommitdiffstats
path: root/ext/hal/gsthalaudiosrc.c
diff options
context:
space:
mode:
authorStefan Kost <ensonic@users.sf.net>2009-01-28 17:46:06 +0200
committerStefan Kost <ensonic@users.sf.net>2009-01-28 18:05:09 +0200
commit9cf73bdd8f18505269fa4b6d1d80127945e735b1 (patch)
tree799b0f7efa6d37844173fbd636bc58254cbccd78 /ext/hal/gsthalaudiosrc.c
parent1f32369451bd5ddf7a59defef7900d508ee144da (diff)
Update and add documentation for plugins with deps (ext).
Link to properties. Correct titles for examples. Document a few trivial cases. Keep lists in section file and docs/plugins/Makefile.am alphabetically ordered. Fix warnings that gtk-doc points out.
Diffstat (limited to 'ext/hal/gsthalaudiosrc.c')
-rw-r--r--ext/hal/gsthalaudiosrc.c20
1 files changed, 7 insertions, 13 deletions
diff --git a/ext/hal/gsthalaudiosrc.c b/ext/hal/gsthalaudiosrc.c
index 626e9d35..bd0a70b5 100644
--- a/ext/hal/gsthalaudiosrc.c
+++ b/ext/hal/gsthalaudiosrc.c
@@ -22,28 +22,22 @@
/**
* SECTION:element-halaudiosrc
*
- * <refsect2>
- * <para>
* HalAudioSrc allows access to input of sound devices by specifying the
* corresponding persistent Unique Device Id (UDI) from the Hardware Abstraction
- * Layer (HAL) in the <link linkend="GstHalAudioSrc--udi">udi</link> property.
+ * Layer (HAL) in the #GstHalAudioSrc:udi property.
* It currently always embeds alsasrc or osssrc as HAL doesn't support other
* sound systems yet. You can also specify the UDI of a device that has ALSA or
* OSS subdevices. If both are present ALSA is preferred.
- * </para>
+ *
+ * <refsect2>
* <title>Examples</title>
- * <para>
- * To list the UDIs of all your ALSA input devices :
- * <programlisting>
+ * |[
* hal-find-by-property --key alsa.type --string capture
- * </programlisting>
- * Here is a pipeline to test your sound input :
- * <programlisting>
+ * ]| list the UDIs of all your ALSA input devices
+ * |[
* gst-launch -v halaudiosrc udi=/org/freedesktop/Hal/devices/pci_8086_27d8_alsa_capture_0 ! autoaudiosink
- * </programlisting>
- * You should now hear yourself with a small delay if you have a microphone
+ * ]| You should now hear yourself with a small delay if you have a microphone
* connected to the specified sound device.
- * </para>
* </refsect2>
*/