annotate scripts/audio/@audioplayer/play.m @ 19530:a9c67ed90fc0

fix audioplayer docstrings to work with new texinfo * audioplayer.m, get.m, play.m, playblocking.m, set.m: fix docstrings using stand alone deftypefnx tags
author Vytautas Jančauskas <unaudio@gmail.com>
date Fri, 20 Sep 2013 00:46:16 +0300
parents ee3ec3f02358
children 8bb399569393
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19510
e1f98e402a7e New files - @audiorecorder and @audioplayer classes
Vytautas Jančauskas <unaudio@gmail.com>
parents:
diff changeset
1 ## -*- texinfo -*-
e1f98e402a7e New files - @audiorecorder and @audioplayer classes
Vytautas Jančauskas <unaudio@gmail.com>
parents:
diff changeset
2 ## @deftypefn{Function File} play (@var{playerObj})
e1f98e402a7e New files - @audiorecorder and @audioplayer classes
Vytautas Jančauskas <unaudio@gmail.com>
parents:
diff changeset
3 ## Play back audio stored in an audioplayer object without blocking.
19530
a9c67ed90fc0 fix audioplayer docstrings to work with new texinfo
Vytautas Jančauskas <unaudio@gmail.com>
parents: 19522
diff changeset
4 ## @end deftypefn
a9c67ed90fc0 fix audioplayer docstrings to work with new texinfo
Vytautas Jančauskas <unaudio@gmail.com>
parents: 19522
diff changeset
5 ## @deftypefn{Function File} play (@var{playerObj}, @var{start})
19510
e1f98e402a7e New files - @audiorecorder and @audioplayer classes
Vytautas Jančauskas <unaudio@gmail.com>
parents:
diff changeset
6 ## Play back audio stored in an audioplayer object starting at the time in seconds specified by @var{start}.
19530
a9c67ed90fc0 fix audioplayer docstrings to work with new texinfo
Vytautas Jančauskas <unaudio@gmail.com>
parents: 19522
diff changeset
7 ## @end deftypefn
a9c67ed90fc0 fix audioplayer docstrings to work with new texinfo
Vytautas Jančauskas <unaudio@gmail.com>
parents: 19522
diff changeset
8 ## @deftypefn{Function File} play (@var{playerObj}, [@var{start}, @var{end}])
19510
e1f98e402a7e New files - @audiorecorder and @audioplayer classes
Vytautas Jančauskas <unaudio@gmail.com>
parents:
diff changeset
9 ## Play back audio stored in an audioplayer object starting at the time in seconds specified by @var{start} and ending at the time specified by @var{end}.
e1f98e402a7e New files - @audiorecorder and @audioplayer classes
Vytautas Jančauskas <unaudio@gmail.com>
parents:
diff changeset
10 ## @end deftypefn
e1f98e402a7e New files - @audiorecorder and @audioplayer classes
Vytautas Jančauskas <unaudio@gmail.com>
parents:
diff changeset
11
e1f98e402a7e New files - @audiorecorder and @audioplayer classes
Vytautas Jančauskas <unaudio@gmail.com>
parents:
diff changeset
12 function play(varargin)
e1f98e402a7e New files - @audiorecorder and @audioplayer classes
Vytautas Jančauskas <unaudio@gmail.com>
parents:
diff changeset
13 if (nargin < 1 || nargin > 2)
e1f98e402a7e New files - @audiorecorder and @audioplayer classes
Vytautas Jančauskas <unaudio@gmail.com>
parents:
diff changeset
14 print_usage ();
e1f98e402a7e New files - @audiorecorder and @audioplayer classes
Vytautas Jančauskas <unaudio@gmail.com>
parents:
diff changeset
15 endif
e1f98e402a7e New files - @audiorecorder and @audioplayer classes
Vytautas Jančauskas <unaudio@gmail.com>
parents:
diff changeset
16 __player_play__(struct(varargin{1}).player, varargin{2:end});
e1f98e402a7e New files - @audiorecorder and @audioplayer classes
Vytautas Jančauskas <unaudio@gmail.com>
parents:
diff changeset
17 endfunction