Mercurial > octave
view scripts/audio/@audiorecorder/recordblocking.m @ 30568:82b685157e2b
doc: Update documentation in audio/ directory.
* __get_properties__.m, audioplayer.m, disp.m, get.m, isplaying.m, pause.m,
play.m, playblocking.m, resume.m, set.m, stop.m, subsasgn.m, subsref.m,
__get_properties__.m, audiorecorder.m, disp.m, get.m, getaudiodata.m,
getplayer.m, isrecording.m, pause.m, play.m, record.m, recordblocking.m,
resume.m, set.m, stop.m, subsasgn.m, subsref.m, record.m, sound.m, soundsc.m:
Re-write lots of documentation for clarity. Add @seealso links in @audioplayer
and @audiorecorder classes.
author | Rik <rik@octave.org> |
---|---|
date | Wed, 29 Dec 2021 18:17:53 -0800 |
parents | 796f54d4ddbf |
children | 2d6e60776588 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2013-2022 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## 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 ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {} recordblocking (@var{recorder}, @var{length}) ## Record audio with blocking (synchronous I/O). ## ## The length of the recording in seconds (@var{length}) must be specified. ## @seealso{@audiorecorder/record, @audiorecorder/audiorecorder} ## @end deftypefn function recordblocking (varargin) if (nargin != 2) print_usage (); endif __recorder_recordblocking__ (struct (varargin{1}).recorder, varargin{2}); endfunction