Mercurial > octave-nkf
comparison scripts/audio/@audiorecorder/audiorecorder.m @ 19605:72304a4e010a
Use Octave coding conventions for documentation of audio functions.
* audio.txi, audioread.cc, @audioplayer/audioplayer.m, @audioplayer/get.m,
@audioplayer/play.m, @audioplayer/playblocking.m, @audioplayer/set.m,
@audiorecorder/audiorecorder.m, @audiorecorder/get.m,
@audiorecorder/getaudiodata.m, @audiorecorder/play.m, @audiorecorder/record.m,
@audiorecorder/set.m:
Use Octave documentation standards.
* audiodevinfo.cc: Limit lines to 80 chars. Indent according to GNU style.
| author | Rik <rik@octave.org> |
|---|---|
| date | Tue, 13 Jan 2015 08:54:25 -0800 |
| parents | e75df9e43e63 |
| children | 7f5006dfa2eb |
comparison
equal
deleted
inserted
replaced
| 19604:62ca016dbb2a | 19605:72304a4e010a |
|---|---|
| 15 ## You should have received a copy of the GNU General Public License | 15 ## You should have received a copy of the GNU General Public License |
| 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}) | 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}) | 22 ## @deftypefnx {Function File} {@var{recorder} =} audiorecorder (@var{fs}, @var{nbits}, @var{channels}, @var{id}) |
| 23 ## Create an audiorecorder object recording 8 bit mono audio at 8000 Hz | 23 ## Create an audiorecorder object recording 8 bit mono audio at 8000 Hz |
| 24 ## sample rate. The optional arguments @var{fs}, @var{nbits}, | 24 ## sample rate. The optional arguments @var{fs}, @var{nbits}, |
| 25 ## @var{channels}, and @var{id} specify the sample rate, bit depth, | 25 ## @var{channels}, and @var{id} specify the sample rate, bit depth, |