Mercurial > octave
diff scripts/audio/@audiorecorder/play.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 diff
--- a/scripts/audio/@audiorecorder/play.m Wed Dec 29 11:05:20 2021 -0800 +++ b/scripts/audio/@audiorecorder/play.m Wed Dec 29 18:17:53 2021 -0800 @@ -27,14 +27,16 @@ ## @deftypefn {} {@var{player} =} play (@var{recorder}) ## @deftypefnx {} {@var{player} =} play (@var{recorder}, @var{start}) ## @deftypefnx {} {@var{player} =} play (@var{recorder}, [@var{start}, @var{end}]) -## Play the audio recorded in @var{recorder} and return a corresponding -## audioplayer object. +## Play the audio recorded in @var{recorder} without blocking and return a +## corresponding audioplayer object. ## ## If the optional argument @var{start} is provided, begin playing -## @var{start} seconds in to the recording. +## @var{start} seconds into the recording. ## ## If the optional argument @var{end} is provided, stop playing at -## @var{end} seconds in the recording. +## @var{end} seconds into the recording. +## @seealso{@audiorecorder/getplayer, @audioplayer/audioplayer, +## @audiorecorder/audiorecorder} ## @end deftypefn function player = play (varargin)