xfnw/plan9fox
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

audio(3): document audiostat/audioctl and speed+delay controls on volume

Browse source
This commit is contained in:
cinap_lenrek 2011-11-02 00:17:51 +01:00
parent 096ce16818
commit 06e7cb6728
1 changed files with 39 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

57
sys/man/3/audio
View file

@ -6,6 +6,8 @@ audio \- audio device
.B bind -a #A /dev .B bind -a #A /dev
.sp 0.3v .sp 0.3v
.B /dev/audio .B /dev/audio
.B /dev/audioctl
.B /dev/audiostat
.B /dev/volume .B /dev/volume
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
@ -21,39 +23,56 @@ The length of the
.B audio .B audio
file as returned by file as returned by
.IR stat (2) .IR stat (2)
represents the number of bytes buffered for input or output. represents the number of bytes buffered for output.
.PP
.B Audioctl
is driver specific control file and left undocumented here.
.PP
.B Audiostat
is a read only status file. The first line has a length of 32 bytes
including the newline and starts with the string
.B bufsize
followed by the prefered write unit (in bytes) and the string
.B buffered
followed by the number of bytes currently queued for output. The
numbers are decimal and right-padded with spaces to fit.
After this fixed header, the contents of the file is driver specific.
.PP .PP
.B Volume .B Volume
is the control file associated with the audio port. is the control file associated with the audio port. Each source has
Each input and output source has an associated stereo volume control, an associated stereo volume control,
ranging from 0 (quiet) to 100 (loud). ranging from 0 (quiet) to 100 (loud).
In addition, there are controls for the sampling rate of the D/A and A/D converters In addition, there are controls for the sampling rate,
latency control and for any tone controls. latency control and for any tone controls.
Reads Reads
return lines of the form return lines of the form
.IP .IP
.I source .I source
.B in left .I left
.I value .I right
.B right .PP
.I value or
.B out left .IP
.I value .I source
.B right
.I value .I value
.PP .PP
possibly abbreviated if the values are shared or non-existent.
For example, if all of the values are shared, the form degenerates to
.RI ` source
.IR value '.
Valid sources depend on the particular audio device, Valid sources depend on the particular audio device,
though all devices have an though all devices have an
.B audio .B audio
stereo source, which controls the output volume from the D/A converter stereo source, which controls the output volume from the D/A converter.
connected to Values for
.BR audio . .B speed
set the sampling frequency of the audio device and
.B delay
limits the audio data output buffering to a number of samples.
.PP .PP
Writes accept the same format with same abbreviations. Writes accept the same format except that for stereo sources
.I left
and
.I right
can be abbreviated to a single
.I value
if both should be set the same.
.SH SOURCE .SH SOURCE
.B /sys/src/9/port/devaudio.c .B /sys/src/9/port/devaudio.c
.SH SEE ALSO .SH SEE ALSO