Mercurial > hg > octave-nkf
diff doc/interpreter/audio.txi @ 3332:7c03933635c6
[project @ 1999-11-02 06:57:12 by jwe]
author | jwe |
---|---|
date | Tue, 02 Nov 1999 06:57:16 +0000 |
parents | bfe1573bd2ae |
children | a892190f4977 |
line wrap: on
line diff
--- a/doc/interpreter/audio.txi +++ b/doc/interpreter/audio.txi @@ -28,39 +28,13 @@ files holding data in mu-law encoding end in @file{au}, @file{mu}, or @file{snd}. -@deftypefn {Function File} {} lin2mu (@var{x}) -If the vector @var{x} represents mono audio data in 8- or 16-bit -linear encoding, @code{lin2mu (@var{x})} is the corresponding mu-law -encoding. -@end deftypefn +@DOCSTRING(lin2mu) -@deftypefn {Function File} {} mu2lin (@var{x}, @var{bps}) -If the vector @var{x} represents mono audio data in mu-law encoding, -@code{mu2lin} converts it to linear encoding. The optional argument -@var{bps} specifies whether the input data uses 8 bit per sample -(default) or 16 bit. -@end deftypefn - -@deftypefn {Function File} {} loadaudio (@var{name}, @var{ext}, @var{bps}) -Loads audio data from the file @file{@var{name}.@var{ext}} into the -vector @var{x}. +@DOCSTRING(mu2lin) -The extension @var{ext} determines how the data in the audio file is -interpreted; the extensions @file{lin} (default) and @file{raw} -correspond to linear, the extensions @file{au}, @file{mu}, or @file{snd} -to mu-law encoding. +@DOCSTRING(loadaudio) -The argument @var{bps} can be either 8 (default) or 16, and specifies -the number of bits per sample used in the audio file. -@end deftypefn - -@deftypefn {Function File} {} saveaudio (@var{name}, @var{x}, @var{ext}, @var{bps}) -Saves a vector @var{x} of audio data to the file -@file{@var{name}.@var{ext}}. The optional parameters @var{ext} and -@var{bps} determine the encoding and the number of bits per sample used -in the audio file (see @code{loadaudio}); defaults are @file{lin} and -8, respectively. -@end deftypefn +@DOCSTRING(saveaudio) The following functions for audio I/O require special A/D hardware and operating system support. It is assumed that audio data in linear @@ -70,29 +44,9 @@ these functions will work without modification on a wide variety of hardware are welcome. -@deftypefn {Function File} {} playaudio (@var{name}, @var{ext}) -@deftypefnx {Function File} {} playaudio (@var{x}) -Plays the audio file @file{@var{name}.@var{ext}} or the audio data -stored in the vector @var{x}. -@end deftypefn - -@deftypefn {Function File} {} record (@var{sec}, @var{sampling_rate}) -Records @var{sec} seconds of audio input into the vector @var{x}. The -default value for @var{sampling_rate} is 8000 samples per second, or -8kHz. The program waits until the user types @key{RET} and then -immediately starts to record. -@end deftypefn +@DOCSTRING(playaudio) -@deftypefn {Function File} {} setaudio (@var{type}) -@deftypefnx {Function File} {} setaudio (@var{type}, @var{value}) -Set or display various properties of your mixer hardware. - -For example, if @code{vol} corresponds to the volume property, you can -set it to 50 (percent) by @code{setaudio ("vol", 50)}. +@DOCSTRING(record) -This is an simple experimental program to control the audio hardware -settings. It assumes that there is a @code{mixer} program which can be -used as @code{mixer @var{type} @var{value}}, and simply executes -@code{system ("mixer @var{type} @var{value}")}. Future releases might -get rid of this assumption by using the @code{fcntl} interface. -@end deftypefn +@DOCSTRING(setaudio) +