system/freebsd-src
system/freebsd-src
1
0
Fork 0
mirror of https://github.com/freebsd/freebsd-src synced 2024-10-01 14:14:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

mixer.3: Fix mandoc -Tlint warnings

Browse source 
Sponsored by:	The FreeBSD Foundation
MFC after:	1 day
Reviewed by:	emaste
Differential Revision:	https://reviews.freebsd.org/D45290
This commit is contained in:
Christos Margiolis 2024-05-23 02:57:49 +02:00
parent e3b94b375e
commit 1ab62c8d06
1 changed files with 16 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
lib/libmixer/mixer.3
View file

@ -19,7 +19,6 @@
.\" OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN .\" OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
.\" THE SOFTWARE. .\" THE SOFTWARE.
.\" .\"
.Dd May 22, 2024 .Dd May 22, 2024
.Dt MIXER 3 .Dt MIXER 3
.Os .Os
@ -168,13 +167,15 @@ is always equal to the number of that pcmX device.
For example, if the audio device's number is 0 (i.e pcm0), then For example, if the audio device's number is 0 (i.e pcm0), then
.Ar unit .Ar unit
is 0 as well. is 0 as well.
This number is useful when checking if the mixer's audio card is the default one. This number is useful when checking if the mixer's audio card is the default
one.
.It Fa ndev .It Fa ndev
Number of devices in Number of devices in
.Ar devs . .Ar devs .
.It Fa devmask .It Fa devmask
Bit mask containing all supported devices for the mixer. Bit mask containing all supported devices for the mixer.
For example, if device 10 is supported, then the 10th bit in the mask will be set. For example, if device 10 is supported, then the 10th bit in the mask will be
set.
By default, By default,
.Fn mixer_open .Fn mixer_open
stores only the supported devices in devs, so it is very unlikely this mask will stores only the supported devices in devs, so it is very unlikely this mask will
@ -318,23 +319,27 @@ opens the default mixer (hw.snd.default_unit).
The The
.Fn mixer_close .Fn mixer_close
function frees resources and closes the mixer device. function frees resources and closes the mixer device.
It is a good practice to always call it when the application is done using the mixer. It is a good practice to always call it when the application is done using the
mixer.
.Ss Manipulating the mixer .Ss Manipulating the mixer
The The
.Fn mixer_get_dev .Fn mixer_get_dev
and and
.Fn mixer_get_dev_byname .Fn mixer_get_dev_byname
functions select a mixer device, either by its number or by its name respectively. functions select a mixer device, either by its number or by its name
The mixer structure keeps a list of all the devices, but only \ respectively.
one can be manipulated at a time. The mixer structure keeps a list of all the devices, but only one can be
Each time a new device is to be manipulated, one of the two functions has to be called. manipulated at a time.
Each time a new device is to be manipulated, one of the two functions has to be
called.
.Pp .Pp
The The
.Fn mixer_set_vol .Fn mixer_set_vol
function changes the volume of the selected mixer device. function changes the volume of the selected mixer device.
The The
.Ar vol .Ar vol
parameter is a structure that stores the left and right volumes of a given device. parameter is a structure that stores the left and right volumes of a given
device.
The allowed volume values are between MIX_VOLMIN (0.0) and MIX_VOLMAX (1.0). The allowed volume values are between MIX_VOLMIN (0.0) and MIX_VOLMAX (1.0).
.Pp .Pp
The The
@ -355,7 +360,8 @@ Toggle the device's mute (e.g mute if unmuted and unmute if muted).
The The
.Fn mixer_mod_recsrc .Fn mixer_mod_recsrc
function modifies a recording device. function modifies a recording device.
The selected device has to be a recording device, otherwise the function will fail. The selected device has to be a recording device, otherwise the function will
fail.
The The
.Ar opt .Ar opt
parameter has to be one of the following options: parameter has to be one of the following options: