git: 6e744de1a3dc - main - mixer.3: Fix mixer_get_mode() description
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Mon, 05 Aug 2024 11:13:52 UTC
The branch main has been updated by christos: URL: https://cgit.FreeBSD.org/src/commit/?id=6e744de1a3dc5dde8d2ee51e97a1224a01bdfb21 commit 6e744de1a3dc5dde8d2ee51e97a1224a01bdfb21 Author: Christos Margiolis <christos@FreeBSD.org> AuthorDate: 2024-08-05 11:13:44 +0000 Commit: Christos Margiolis <christos@FreeBSD.org> CommitDate: 2024-08-05 11:13:44 +0000 mixer.3: Fix mixer_get_mode() description 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 --- lib/libmixer/mixer.3 | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/lib/libmixer/mixer.3 b/lib/libmixer/mixer.3 index 4008867ef2fb..04aa3bd1dca7 100644 --- a/lib/libmixer/mixer.3 +++ b/lib/libmixer/mixer.3 @@ -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 @@ -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