version 1.10, 2020/04/21 13:24:29 |
version 1.11, 2020/04/21 14:04:17 |
|
|
.Os |
.Os |
.Sh NAME |
.Sh NAME |
.Nm sndioctl |
.Nm sndioctl |
.Nd control audio parameters |
.Nd manipulate audio device controls |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm |
.Nm |
.Bk -words |
.Bk -words |
|
|
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm |
.Nm |
utility can display or change parameters of |
utility can display or manipulate controls of |
.Xr sndio 7 |
.Xr sndio 7 |
audio devices. |
audio devices, like the output level. |
The options are as follows: |
The options are as follows: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Fl d |
.It Fl d |
Dump the raw list of available parameters and exit. |
Dump the raw list of available controls and exit. |
Useful as a debugging tool. |
Useful as a debugging tool. |
.It Fl f Ar device |
.It Fl f Ar device |
Use this |
Use this |
.Xr sndio 7 |
.Xr sndio 7 |
audio device. |
audio device. |
.It Fl i |
.It Fl i |
Display characteristics of requested parameters |
Display characteristics of requested controls |
instead of their values. |
instead of their values. |
.It Fl m |
.It Fl m |
Monitor and display audio parameter changes. |
Monitor and display audio controls changes. |
.It Fl n |
.It Fl n |
Suppress printing of the variable name. |
Suppress printing of the variable name. |
.It Fl q |
.It Fl q |
Suppress all printing when setting a variable. |
Suppress all printing when setting a variable. |
.It Fl v |
.It Fl v |
Enable verbose mode, a.k.a. multi-channel mode. |
Enable verbose mode, a.k.a. multi-channel mode. |
By default parameters affecting different channels |
By default controls affecting different channels |
of the same stream are disguised as a single mono |
of the same stream are disguised as a single mono |
parameter to hide details that are not essential. |
control to hide details that are not essential. |
.El |
.El |
.Pp |
.Pp |
If no commands are specified all valid parameters are displayed on |
If no commands are specified all valid controls are displayed on |
.Em stdout . |
.Em stdout . |
Unless |
Unless |
.Fl d , |
.Fl d , |
|
|
.Fl n , |
.Fl n , |
or |
or |
.Fl i |
.Fl i |
are used, displayed parameters are valid commands. |
are used, displayed lines are valid commands. |
The set of available controls depends on the control device. |
The set of available controls depends on the audio device. |
.Pp |
.Pp |
Commands use the following two formats to display and set |
Commands use the following two formats to display and change |
parameters respectively: |
controls respectively: |
.Pp |
.Pp |
.Dl group/stream[channel].function |
.Dl group/stream[channel].function |
.Dl group/stream[channel].function=value |
.Dl group/stream[channel].function=value |
.Pp |
.Pp |
On the left-hand side are specified the parameter group (if any), |
On the left-hand side are specified the control group (if any), |
the affected stream name, and the optional channel number. |
the affected stream name, and the optional channel number. |
Examples of left-hand side terms: |
Examples of left-hand side terms: |
.Pp |
.Pp |