view scripts/audio/@audioplayer/playblocking.m @ 19540:fdb8a62ef17a

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
line wrap: on
line source

## Copyright (C) 2013 Vytautas JanĨauskas
##
## 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
## <http://www.gnu.org/licenses/>.

## -*- texinfo -*-
## @deftypefn {Function File} {} playblocking (@var{player})
## @deftypefnx {Function File} {} playblocking (@var{player}, @var{start})
## @deftypefnx {Function File} {} playblocking (@var{player}, @var{limits})
## Play audio stored in the audioplayer object @var{player} with blocking.
## Given optional argument start, begin playing at @var{start} seconds
## in the recording.  Given a two-element vector @var{limits}, begin and
## end playing at the number of seconds specified by the elements of the
## vector.
## @end deftypefn

function playblocking (varargin)
  if (nargin < 1 || nargin > 2)
    print_usage ();
  endif
  __player_playblocking__ (struct (varargin{1}).player, varargin{2:end});
endfunction