Mercurial > octave
diff scripts/audio/@audiorecorder/audiorecorder.m @ 19506:fdb8a62ef17a
fix docstring style in .m files
* @audioplayer/__get_properties__.m, @audioplayer/audioplayer.m,
@audioplayer/get.m, @audioplayer/isplaying.m, @audioplayer/pause.m,
@audioplayer/play.m, @audioplayer/playblocking.m,
@audioplayer/resume.m, @audioplayer/set.m, @audioplayer/stop.m,
@audiorecorder/audiorecorder.m,@audiorecorder/get.m,
@audiorecorder/getaudiodata.m, @audiorecorder/getplayer.m,
@audiorecorder/isrecording.m, @audiorecorder/pause.m,
@audiorecorder/play.m, @audiorecorder/record.m,
@audiorecorder/recordblocking.m, @audiorecorder/resume.m,
@audiorecorder/set.m, @audiorecorder/stop.m: Fix docstring style.
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Wed, 31 Dec 2014 13:45:45 -0500 |
| parents | ce02743b6f2a |
| children | dac3191a5301 |
line wrap: on
line diff
--- a/scripts/audio/@audiorecorder/audiorecorder.m Thu Oct 03 09:50:01 2013 -0400 +++ b/scripts/audio/@audiorecorder/audiorecorder.m Wed Dec 31 13:45:45 2014 -0500 @@ -18,32 +18,15 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{recorder} =} audiorecorder () +## @deftypefnx {Function File} {@var{recorder} =} audiorecorder (@var{fs}, @var{nbits}, @var{channels}) +## @deftypefnx {Function File} {@var{recorder} =} audiorecorder (@var{fs}, @var{nbits}, @var{channels}, @var{id}) +## @deftypefnx {Function File} {@var{recorder} =} audiorecorder (@var{function}, @dots{}) ## Create an audiorecorder object recording 8 bit mono audio at 8000 Hz -## sample rate. -## @end deftypefn -## @deftypefn {Function File} {@var{recorder} =} audiorecorder (@var{fs}, @var{nbits}, @var{channels}) -## Create an audiorecorder object recording at specified sample rate -## @var{fs}, specified bit depth @var{nbits}, and specified number of -## @var{channels}. -## @end deftypefn -## @deftypefn {Function File} {@var{recorder} =} audiorecorder (@var{fs}, @var{nbits}, @var{channels}, @var{id}) -## Create an audiorecorder object recording at specified sample rate @var{fs}, -## specified bit depth @var{nbits}, number of @var{channels}, and recording -## on the device specified by @var{id}. You can get device IDs by using the -## audiodevinfo function. -## @end deftypefn -## @deftypefn {Function File} {@var{recorder} =} audiorecorder (@var{function}, @var{fs}) -## Argument @var{function} is a function handle, inline function, or a string -## value of a function name that will get called to process audio. Audio -## will be recorded at @var{fs} sampling rate. -## @end deftypefn -## @deftypefn {Function File} {@var{recorder} =} audiorecorder (@var{function}, @var{fs}, @var{nbits}) -## Same as above but also allows you to specify the number of bits per -## sample. -## @end deftypefn -## @deftypefn {Function File} {@var{recorder} =} audiorecorder (@var{function}, @var{fs}, @var{nbits}, @var{id}) -## Same as above but also allows you to specify device @var{id} that will be -## used. +## sample rate. The optional arguments @var{fs}, @var{nbits}, +## @var{channels}, and @var{id} specify the sample rate, bit depth, +## number of channels and recording device id, respectively. Device IDs +## may be found using the audiodevinfo function. +## Given a function handle, use that function to process the audio. ## @end deftypefn function recorder = audiorecorder (varargin)