summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDimitris Papastamos <sin@2f30.org>2016-06-22 17:42:29 +0100
committerMax Kellermann <max@duempel.org>2016-06-22 18:43:44 +0200
commit2d3b6879f539f9343c37cb1d87dc557288a9e46b (patch)
treeffd988692850f008ef73cf020f096853b3d83a11 /doc
parent26c09244614950b173b7ce9a9f9d5844510d9a43 (diff)
doc: Initial sndio documentation
Diffstat (limited to 'doc')
-rw-r--r--doc/user.xml45
1 files changed, 45 insertions, 0 deletions
diff --git a/doc/user.xml b/doc/user.xml
index e126f76c8..3b59df677 100644
--- a/doc/user.xml
+++ b/doc/user.xml
@@ -2738,6 +2738,51 @@ buffer_size: 16384</programlisting>
</section>
<section>
+ <title><varname>sndio</varname></title>
+
+ <para>
+ The <varname>sndio</varname> plugin uses the <ulink
+ url="http://www.sndio.org/">sndio</ulink> library. It should normally be used
+ on OpenBSD.
+ </para>
+
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Setting</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <varname>device</varname>
+ <parameter>NAME</parameter>
+ </entry>
+ <entry>
+ The audio output device <filename>libsndio</filename>
+ will attempt to use. The default is "default" which
+ causes libsndio to select the first output device.
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <varname>buffer_time</varname>
+ <parameter>MS</parameter>
+ </entry>
+ <entry>
+ Set the application buffer time in milliseconds.
+ </entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
+
+ <section>
<title><varname>fifo</varname></title>
<para>