Skip to content

Commit

Permalink
mixer.3: Fix mixer_get_mode() description
Browse files Browse the repository at this point in the history
Improve wording and also fix the constants' names.

Sponsored by:	The FreeBSD Foundation
MFC after:	2 days
Reviewed by:	dev_submerge.ch
Differential Revision:	https://reviews.freebsd.org/D46220
  • Loading branch information
christosmarg committed Aug 5, 2024
1 parent 1f3bfc6 commit 6e744de
Showing 1 changed file with 10 additions and 13 deletions.
23 changes: 10 additions & 13 deletions lib/libmixer/mixer.3
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
.\" OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
.\" THE SOFTWARE.
.\"
.Dd May 22, 2024
.Dd August 4, 2024
.Dt MIXER 3
.Os
.Sh NAME
Expand Down Expand Up @@ -388,18 +388,15 @@ controls.
.Pp
The
.Fn mixer_get_mode
function returns the playback/recording mode of the audio device the mixer \
belongs to.
The available values are the following:
.Bl -tag -width "MIX_STATUS_PLAY | MIX_STATUS_REC" -offset indent
.It Dv MIX_STATUS_NONE
Neither playback nor recording.
.It Dv MIX_STATUS_PLAY
Playback.
.It Dv MIX_STATUS_REC
Recording.
.It Dv MIX_STATUS_PLAY | MIX_STATUS_REC
Playback and recording.
function returns the operating mode of the audio device the mixer belongs to.
The following values can be OR'ed in case more than one mode is supported:
.Bl -tag -width "MIX_MODE_MIXER" -offset indent
.It Dv MIX_MODE_MIXER
The audio device has a mixer.
.It Dv MIX_MODE_PLAY
The audio device supports playback.
.It Dv MIX_MODE_REC
The audio device supports recording.
.El
.Pp
The
Expand Down

0 comments on commit 6e744de

Please sign in to comment.