Mercurial > octave-nkf
view scripts/audio/@audiorecorder/record.m @ 19538:d7b55fc1b37d
Add missing texinfo docstrings to all audio functions
* libinterp/dldfcn/__player_audioplayer__.cc,
libinterp/dldfcn/__recorder_audiorecorder__.cc,
scripts/audio/@audioplayer/subsasgn.m, scripts/audio/@audioplayer/subsref.m,
scripts/audio/@audiorecorder/__get_properties__.m,
scripts/audio/@audiorecorder/subsasgn.m,
scripts/audio/@audiorecorder/subsref.m: Add texinfo docstrings to all
functions, internal or otherwise.
author | Mike Miller <mtmiller@ieee.org> |
---|---|
date | Thu, 03 Oct 2013 08:33:46 -0400 |
parents | 36a26a131209 |
children | ce02743b6f2a |
line wrap: on
line source
## Copyright (C) 2013 Vytautas JanĨauskas ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn{Function File} record (@var{recorderObj}) ## Record audio without blocking. The recording will continue until you use the stop method on @var{recorderObj}. ## @end deftypefn ## @deftypefn{Function File} record (@var{playerObj}, @var{length}) ## Record audio without blocking. The recording will continue for @var{length} seconds. ## @end deftypefn function record (varargin) if (nargin < 1 || nargin > 2) print_usage (); endif __recorder_record__ (struct (varargin{1}).recorder, varargin{2:end}); endfunction