Mercurial > octave-nkf

comparison scripts/audio/@audiorecorder/audiorecorder.m @ 19531:77b52b86b419

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
change @audiorecorder method docstrings to work with new texinfo * audiorecorder.m, get.m, getaudiodata.m, play.m, record.m, set.m: change stand-alone deftypefnx tags to deftypefn tags
author Vytautas Jančauskas <unaudio@gmail.com>
date Fri, 20 Sep 2013 00:51:21 +0300
parents ee3ec3f02358
children 8bb399569393
comparison
equal deleted inserted replaced
19530:a9c67ed90fc0 19531:77b52b86b419
1 ## -*- texinfo -*- 1 ## -*- texinfo -*-
2 ## @deftypefn{Function File} recorder = audiorecorder 2 ## @deftypefn{Function File} recorder = audiorecorder
3 ## Create an audiorecorder object recording 8 bit mono audio at 8000 Hz sample rate. 3 ## Create an audiorecorder object recording 8 bit mono audio at 8000 Hz sample rate.
4 ## @deftypefnx{Function File} recorder = audiorecorder (@var{Fs}, @var{nBytes}, @var{Channels}) 4 ## @end deftypefn
5 ## @deftypefn{Function File} recorder = audiorecorder (@var{Fs}, @var{nBytes}, @var{Channels})
5 ## Create an audiorecorder object recording at specified sample rate @var{Fs}, specified bit depth @var{nBytes} and specified number of @var{Channels}. 6 ## Create an audiorecorder object recording at specified sample rate @var{Fs}, specified bit depth @var{nBytes} and specified number of @var{Channels}.
6 ## @deftypefnx{Function File} recorder = audiorecorder (@var{Fs}, @var{nBytes}, @var{Channels}, @var{ID}) 7 ## @end deftypefn
8 ## @deftypefn{Function File} recorder = audiorecorder (@var{Fs}, @var{nBytes}, @var{Channels}, @var{ID})
7 ## Create an audiorecorder object recording at specified sample rate @var{Fs}, specified bit depth @var{nBytes}, number of @var{Channels} and recording on the device specified by @var{ID}. You can get device IDs by using the audiodevinfo function. 9 ## Create an audiorecorder object recording at specified sample rate @var{Fs}, specified bit depth @var{nBytes}, number of @var{Channels} and recording on the device specified by @var{ID}. You can get device IDs by using the audiodevinfo function.
8 ## @deftypefnx{Function File} recorder = audiorecorder (@var{function}, @var{Fs}) 10 ## @end deftypefn
11 ## @deftypefn{Function File} recorder = audiorecorder (@var{function}, @var{Fs})
9 ## 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. 12 ## 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.
10 ## @deftypefnx{Function File} recorder = audiorecorder (@var{function}, @var{Fs}, @var{nBytes}) 13 ## @end deftypefn
14 ## @deftypefn{Function File} recorder = audiorecorder (@var{function}, @var{Fs}, @var{nBytes})
11 ## Same as above but also allows you to specify the number of bytes per sample. 15 ## Same as above but also allows you to specify the number of bytes per sample.
12 ## @deftypefnx{Function File} recorder = audiorecorder (@var{function}, @var{Fs}, @var{nBytes}, @var{ID}) 16 ## @end deftypefn
17 ## @deftypefn{Function File} recorder = audiorecorder (@var{function}, @var{Fs}, @var{nBytes}, @var{ID})
13 ## Same as above but also allows you to specify device ID that will be used. 18 ## Same as above but also allows you to specify device ID that will be used.
14 ## @end deftypefn 19 ## @end deftypefn
15 20
16 function recorder = audiorecorder (varargin) 21 function recorder = audiorecorder (varargin)
17 if (nargin > 5) 22 if (nargin > 5)