changeset 23607:ff6bcf3d7e1f stable

playblocking.m: Correct documentation about start and limits inputs (bug #51217). * playblocking.m: Document that start and limit refer to the sample number, not to the number of seconds.
author Rik <rik@octave.org>
date Thu, 15 Jun 2017 16:13:26 -0700
parents afacc2f244bb
children 520c53706014 fecca33388f7
files scripts/audio/@audioplayer/playblocking.m
diffstat 1 files changed, 2 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/audio/@audioplayer/playblocking.m	Thu Jun 15 16:10:58 2017 -0700
+++ b/scripts/audio/@audioplayer/playblocking.m	Thu Jun 15 16:13:26 2017 -0700
@@ -22,9 +22,9 @@
 ## @deftypefnx {} {} 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
+## Given optional argument start, begin playing at @var{start} samples 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.
+## at the number of samples specified by the elements of the vector.
 ## @end deftypefn
 
 function playblocking (varargin)