summaryrefslogtreecommitdiff
path: root/lib/libsndio
diff options
context:
space:
mode:
authorAlexandre Ratchov <ratchov@cvs.openbsd.org>2009-01-21 22:18:32 +0000
committerAlexandre Ratchov <ratchov@cvs.openbsd.org>2009-01-21 22:18:32 +0000
commitddd554bb41a71164b61483f3eb20ea71fcd77378 (patch)
tree62d03fcc913129f81f11f089ae2aa97b1e4175cb /lib/libsndio
parenta624a55349befd009bb777be9959a5509eadbfb8 (diff)
explain what ``frame'' does mean
from Thomas Pfaff <tpfaff(at)tp76.info>, thanks! ok jmc
Diffstat (limited to 'lib/libsndio')
-rw-r--r--lib/libsndio/sio_open.310
1 files changed, 7 insertions, 3 deletions
diff --git a/lib/libsndio/sio_open.3 b/lib/libsndio/sio_open.3
index 789c8627092..0fc9249eaf1 100644
--- a/lib/libsndio/sio_open.3
+++ b/lib/libsndio/sio_open.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: sio_open.3,v 1.14 2009/01/12 20:47:34 ratchov Exp $
+.\" $OpenBSD: sio_open.3,v 1.15 2009/01/21 22:18:31 ratchov Exp $
.\"
.\" Copyright (c) 2007 Alexandre Ratchov <alex@caoua.org>
.\"
@@ -14,7 +14,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: January 12 2009 $
+.Dd $Mdocdate: January 21 2009 $
.Dt SIO_OPEN 3
.Os
.Sh NAME
@@ -109,7 +109,7 @@ parameter gives the path of the
socket or the
.Xr audio 4
device.
-In most cases it should be left to NULL to allow
+In most cases it should be set to NULL to allow
the user to select it using the
.Ev AUDIODEVICE
environment variable.
@@ -147,6 +147,10 @@ associated with the
handle.
.Ss Negotiating audio parameters
Audio streams always use linear interleaved encoding.
+A frame consists of one sample for each channel in the stream.
+For example, a 16-bit stereo stream has two samples per frame
+and, typically, two bytes per sample (thus 4 bytes per frame).
+.Pp
The set of parameters of the stream that can be controlled
is given by the following structure:
.Bd -literal