Mercurial > octave-nkf

comparison scripts/audio/@audiorecorder/audiorecorder.m @ 19540:fdb8a62ef17a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
19539:ce02743b6f2a 19540:fdb8a62ef17a
16 ## along with Octave; see the file COPYING. If not, see 16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {@var{recorder} =} audiorecorder () 20 ## @deftypefn {Function File} {@var{recorder} =} audiorecorder ()
21 ## @deftypefnx {Function File} {@var{recorder} =} audiorecorder (@var{fs}, @var{nbits}, @var{channels})
22 ## @deftypefnx {Function File} {@var{recorder} =} audiorecorder (@var{fs}, @var{nbits}, @var{channels}, @var{id})
23 ## @deftypefnx {Function File} {@var{recorder} =} audiorecorder (@var{function}, @dots{})
21 ## Create an audiorecorder object recording 8 bit mono audio at 8000 Hz 24 ## Create an audiorecorder object recording 8 bit mono audio at 8000 Hz
22 ## sample rate. 25 ## sample rate. The optional arguments @var{fs}, @var{nbits},
23 ## @end deftypefn 26 ## @var{channels}, and @var{id} specify the sample rate, bit depth,
24 ## @deftypefn {Function File} {@var{recorder} =} audiorecorder (@var{fs}, @var{nbits}, @var{channels}) 27 ## number of channels and recording device id, respectively. Device IDs
25 ## Create an audiorecorder object recording at specified sample rate 28 ## may be found using the audiodevinfo function.
26 ## @var{fs}, specified bit depth @var{nbits}, and specified number of 29 ## Given a function handle, use that function to process the audio.
27 ## @var{channels}.
28 ## @end deftypefn
29 ## @deftypefn {Function File} {@var{recorder} =} audiorecorder (@var{fs}, @var{nbits}, @var{channels}, @var{id})
30 ## Create an audiorecorder object recording at specified sample rate @var{fs},
31 ## specified bit depth @var{nbits}, number of @var{channels}, and recording
32 ## on the device specified by @var{id}. You can get device IDs by using the
33 ## audiodevinfo function.
34 ## @end deftypefn
35 ## @deftypefn {Function File} {@var{recorder} =} audiorecorder (@var{function}, @var{fs})
36 ## Argument @var{function} is a function handle, inline function, or a string
37 ## value of a function name that will get called to process audio. Audio
38 ## will be recorded at @var{fs} sampling rate.
39 ## @end deftypefn
40 ## @deftypefn {Function File} {@var{recorder} =} audiorecorder (@var{function}, @var{fs}, @var{nbits})
41 ## Same as above but also allows you to specify the number of bits per
42 ## sample.
43 ## @end deftypefn
44 ## @deftypefn {Function File} {@var{recorder} =} audiorecorder (@var{function}, @var{fs}, @var{nbits}, @var{id})
45 ## Same as above but also allows you to specify device @var{id} that will be
46 ## used.
47 ## @end deftypefn 30 ## @end deftypefn
48 31
49 function recorder = audiorecorder (varargin) 32 function recorder = audiorecorder (varargin)
50 if (nargin > 5) 33 if (nargin > 5)
51 print_usage (); 34 print_usage ();