[BACK]Return to audioctl.1 CVS log [TXT][DIR] Up to [local] / src / usr.bin / audioctl

Diff for /src/usr.bin/audioctl/Attic/audioctl.1 between version 1.28 and 1.29

version 1.28, 2016/01/29 10:45:38 version 1.29, 2016/06/21 06:32:00
Line 31 
Line 31 
 .Os  .Os
 .Sh NAME  .Sh NAME
 .Nm audioctl  .Nm audioctl
 .Nd control audio device  .Nd get or set audio driver variables
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm audioctl  .Nm audioctl
 .Op Fl an  
 .Op Fl f Ar file  .Op Fl f Ar file
 .Nm audioctl  .Nm audioctl
 .Op Fl n  .Op Fl n
 .Op Fl f Ar file  .Op Fl f Ar file
 .Ar name ...  .Ar name ...
 .Nm audioctl  .Nm audioctl
 .Op Fl n  .Op Fl nq
 .Op Fl f Ar file  .Op Fl f Ar file
 .Ar name Ns = Ns Ar value ...  .Ar name Ns = Ns Ar value ...
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm  .Nm
 command displays or sets various audio system driver variables.  utility retrieves or sets
 If a list of variables is present on the command line,  .Xr audio 4
 .Nm  driver variables.
 prints the current value of those variables for the specified device.  
 By default,  
 .Nm  
 operates on the  
 .Pa /dev/audioctl  
 device.  
 .Pp  
 The options are as follows:  The options are as follows:
 .Bl -tag -width "name=valueXX"  .Bl -tag -width Ds
 .It Fl a  
 Print all device variables and their current values.  
 This is the default, if no parameters are given to  
 .Nm .  
 .It Fl f Ar file  .It Fl f Ar file
 Specify an alternative audio control device.  Specifies the audio control device or the audio device.
   The default is
   .Pa /dev/audioctl0 .
 .It Fl n  .It Fl n
 Suppress printing of the variable name.  Suppress printing of the variable name.
   .It Fl q
   Suppress all output when setting a variable.
 .It Ar name Ns = Ns Ar value  .It Ar name Ns = Ns Ar value
 Attempt to set the specified variable  Attempt to set the specified variable
 .Ar name  .Ar name
Line 74 
Line 66 
 .Ar value .  .Ar value .
 .El  .El
 .Pp  .Pp
   If the audio control device is used, then values are only stored in the
   .Xr audio 4
   driver; they will be submitted to the hardware the next time the
   device is opened for playback or recording.
   If the audio device is used instead of the control device,
   then values are negotiated with the hardware immediately; this requires
   exclusive access to the device.
 Variables may only be changed if the device is not opened for  Variables may only be changed if the device is not opened for
 playback or recording by another process.  playback or recording by another process.
 .Sh ENVIRONMENT  .Pp
 .Bl -tag -width AUDIOCTLDEVICE  The following variable names are available:
 .It Ev AUDIOCTLDEVICE  .Bl -column "record.channels"
 Audio control device to use.  .It Sy Name Ta Sy Meaning
   .It name Ta device name as shown by
   .Xr dmesg 8
   .It mode Ta current device mode (
   .Va play ,
   .Va record
   or both)
   .It pause Ta set if not attempting to start
   .It active Ta set if playing or recording
   .It nblks Ta number of blocks (in frames) in the play buffer
   .It blksz Ta number of frames per block
   .It rate Ta sample rate in Hz
   .It encoding Ta current sample format
   .It play.channels Ta number of play channels
   .It play.bytes Ta bytes played since playback started
   .It play.errors Ta bytes inserted during underruns
   .It record.channels Ta number of recording channels
   .It record.bytes Ta bytes recorded since device started
   .It record.errors Ta bytes dropped during overruns
 .El  .El
   .Pp
   Encoding names use the following scheme: signedness
   .Po
   .Va s
   or
   .Va u
   .Pc
   followed
   by the precision in bits, the byte-order
   .Po
   .Va le
   or
   .Va be
   .Pc ,
   the number of
   bytes per sample, and the alignment
   .Po
   .Va msb
   or
   .Va lsb
   .Pc .
   Only the signedness and the precision are mandatory.
   Examples:
   .Va u8 , s16le , s24le3 , s24le4lsb .
 .Sh FILES  .Sh FILES
 .Bl -tag -width /dev/audioctl  .Bl -tag -width /dev/audioctl0
 .It Pa /dev/audioctl  .It Pa /dev/audioctlN
 default audio control device  audio control devices
   .It Pa /dev/audioN
   audio devices
 .El  .El
 .Sh EXAMPLES  .Sh EXAMPLES
 To set the playing sampling rate to 11025 you can enter:  Display the number of bytes of silence inserted during play buffer
   underruns since device started:
   .Bd -literal -offset indent
   $ audioctl play.errors
   .Ed
 .Pp  .Pp
 .Dl $ audioctl play.rate=11025  Use signed 24-bit samples and 44100Hz sample rate:
   .Bd -literal -offset indent
   $ audioctl -f /dev/audio0 encoding=s24 rate=44100
   .Ed
   .Pp
   Note the use of
   .Pa /dev/audio0 ,
   to force negotiation with the hardware.
   If the above parameters are not supported by the
   hardware, then supported ones will be selected instead.
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr aucat 1 ,  .Xr aucat 1 ,
 .Xr cdio 1 ,  .Xr cdio 1 ,
Legend:
Removed from v.1.28  
changed lines
  Added in v.1.29