Mercurial > octave-nkf

comparison scripts/audio/@audioplayer/play.m @ 19540:fdb8a62ef17a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fix docstring style in .m files * @audioplayer/__get_properties__.m, @audioplayer/audioplayer.m, @audioplayer/get.m, @audioplayer/isplaying.m, @audioplayer/pause.m, @audioplayer/play.m, @audioplayer/playblocking.m, @audioplayer/resume.m, @audioplayer/set.m, @audioplayer/stop.m, @audiorecorder/audiorecorder.m,@audiorecorder/get.m, @audiorecorder/getaudiodata.m, @audiorecorder/getplayer.m, @audiorecorder/isrecording.m, @audiorecorder/pause.m, @audiorecorder/play.m, @audiorecorder/record.m, @audiorecorder/recordblocking.m, @audiorecorder/resume.m, @audiorecorder/set.m, @audiorecorder/stop.m: Fix docstring style.
author John W. Eaton <jwe@octave.org>
date Wed, 31 Dec 2014 13:45:45 -0500
parents ce02743b6f2a
children 5802ea7037d4
comparison
equal deleted inserted replaced
19539:ce02743b6f2a 19540:fdb8a62ef17a
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} {} play (@var{player}) 20 ## @deftypefn {Function File} {} play (@var{player})
21 ## Play back audio stored in an audioplayer object without blocking. 21 ## @deftypefnx {Function File} {} play (@var{player}, @var{start})
22 ## @end deftypefn 22 ## @deftypefnx {Function File} {} play (@var{player}, @var{limits})
23 ## @deftypefn {Function File} {} play (@var{player}, @var{start}) 23 ## Play audio stored in the audioplayer object @var{player} without blocking.
24 ## Play back audio stored in an audioplayer object starting at the time in 24 ## Given optional argument start, begin playing at @var{start} seconds
25 ## seconds specified by @var{start}. 25 ## in the recording. Given a two-element vector @var{limits}, begin and
26 ## @end deftypefn 26 ## end playing at the number of seconds specified by the elements of the
27 ## @deftypefn {Function File} {} play (@var{player}, [@var{start}, @var{end}]) 27 ## vector.
28 ## Play back audio stored in an audioplayer object starting at the time in
29 ## seconds specified by @var{start} and ending at the time specified by
30 ## @var{end}.
31 ## @end deftypefn 28 ## @end deftypefn
32 29
33 function play (varargin) 30 function play (varargin)
34 if (nargin < 1 || nargin > 2) 31 if (nargin < 1 || nargin > 2)
35 print_usage (); 32 print_usage ();