octave: scripts/audio/@audiorecorder/resume.m annotate

annotate scripts/audio/@audiorecorder/resume.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

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ########################################################################
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 ##
30564 796f54d4ddbf update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	3 ## Copyright (C) 2013-2022 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	4 ##
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 ## distribution or <https://octave.org/copyright/>.
19500 8bb399569393 Add Octave copyright header block to audio project files Mike Miller <mtmiller@ieee.org> parents: 19488 diff changeset	7 ##
8bb399569393 Add Octave copyright header block to audio project files Mike Miller <mtmiller@ieee.org> parents: 19488 diff changeset	8 ## This file is part of Octave.
8bb399569393 Add Octave copyright header block to audio project files Mike Miller <mtmiller@ieee.org> parents: 19488 diff changeset	9 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	10 ## Octave is free software: you can redistribute it and/or modify it
19500 8bb399569393 Add Octave copyright header block to audio project files Mike Miller <mtmiller@ieee.org> parents: 19488 diff changeset	11 ## under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	12 ## the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	13 ## (at your option) any later version.
19500 8bb399569393 Add Octave copyright header block to audio project files Mike Miller <mtmiller@ieee.org> parents: 19488 diff changeset	14 ##
8bb399569393 Add Octave copyright header block to audio project files Mike Miller <mtmiller@ieee.org> parents: 19488 diff changeset	15 ## Octave is distributed in the hope that it will be useful, but
8bb399569393 Add Octave copyright header block to audio project files Mike Miller <mtmiller@ieee.org> parents: 19488 diff changeset	16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	18 ## GNU General Public License for more details.
19500 8bb399569393 Add Octave copyright header block to audio project files Mike Miller <mtmiller@ieee.org> parents: 19488 diff changeset	19 ##
8bb399569393 Add Octave copyright header block to audio project files Mike Miller <mtmiller@ieee.org> parents: 19488 diff changeset	20 ## You should have received a copy of the GNU General Public License
8bb399569393 Add Octave copyright header block to audio project files Mike Miller <mtmiller@ieee.org> parents: 19488 diff changeset	21 ## along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	22 ## <https://www.gnu.org/licenses/>.
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 ##
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ########################################################################
19500 8bb399569393 Add Octave copyright header block to audio project files Mike Miller <mtmiller@ieee.org> parents: 19488 diff changeset	25
19476 e1f98e402a7e New files - @audiorecorder and @audioplayer classes Vytautas Jančauskas <unaudio@gmail.com> parents: diff changeset	26 ## -- texinfo --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 19697 diff changeset	27 ## @deftypefn {} {} resume (@var{recorder})
19506 fdb8a62ef17a fix docstring style in .m files John W. Eaton <jwe@octave.org> parents: 19505 diff changeset	28 ## Resume recording with the paused audiorecorder object @var{recorder}.
30568 82b685157e2b doc: Update documentation in audio/ directory. Rik <rik@octave.org> parents: 30564 diff changeset	29 ## @seealso{@audiorecorder/pause, @audiorecorder/stop,
82b685157e2b doc: Update documentation in audio/ directory. Rik <rik@octave.org> parents: 30564 diff changeset	30 ## @audiorecorder/audiorecorder}
19476 e1f98e402a7e New files - @audiorecorder and @audioplayer classes Vytautas Jančauskas <unaudio@gmail.com> parents: diff changeset	31 ## @end deftypefn
e1f98e402a7e New files - @audiorecorder and @audioplayer classes Vytautas Jančauskas <unaudio@gmail.com> parents: diff changeset	32
19503 36a26a131209 Apply Octave coding style to audio project additions Mike Miller <mtmiller@ieee.org> parents: 19500 diff changeset	33 function resume (recorder)
19523 5802ea7037d4 style fixes for audioplayer and audiorecorder classes John W. Eaton <jwe@octave.org> parents: 19506 diff changeset	34
28891 de5f2f9a64ff maint: Use same coding style when checking for a minimum of 1 input. Rik <rik@octave.org> parents: 27923 diff changeset	35 if (nargin < 1)
19523 5802ea7037d4 style fixes for audioplayer and audiorecorder classes John W. Eaton <jwe@octave.org> parents: 19506 diff changeset	36 print_usage ();
5802ea7037d4 style fixes for audioplayer and audiorecorder classes John W. Eaton <jwe@octave.org> parents: 19506 diff changeset	37 endif
5802ea7037d4 style fixes for audioplayer and audiorecorder classes John W. Eaton <jwe@octave.org> parents: 19506 diff changeset	38
19503 36a26a131209 Apply Octave coding style to audio project additions Mike Miller <mtmiller@ieee.org> parents: 19500 diff changeset	39 __recorder_resume__ (struct (recorder).recorder);
19523 5802ea7037d4 style fixes for audioplayer and audiorecorder classes John W. Eaton <jwe@octave.org> parents: 19506 diff changeset	40
19500 8bb399569393 Add Octave copyright header block to audio project files Mike Miller <mtmiller@ieee.org> parents: 19488 diff changeset	41 endfunction

Mercurial > octave

annotate scripts/audio/@audiorecorder/resume.m @ 30568:82b685157e2b