Mercurial > octave-nkf
diff scripts/audio/@audioplayer/audioplayer.m @ 19605:72304a4e010a
Use Octave coding conventions for documentation of audio functions.
* audio.txi, audioread.cc, @audioplayer/audioplayer.m, @audioplayer/get.m,
@audioplayer/play.m, @audioplayer/playblocking.m, @audioplayer/set.m,
@audiorecorder/audiorecorder.m, @audiorecorder/get.m,
@audiorecorder/getaudiodata.m, @audiorecorder/play.m, @audiorecorder/record.m,
@audiorecorder/set.m:
Use Octave documentation standards.
* audiodevinfo.cc: Limit lines to 80 chars. Indent according to GNU style.
| author | Rik <rik@octave.org> |
|---|---|
| date | Tue, 13 Jan 2015 08:54:25 -0800 |
| parents | e75df9e43e63 |
| children | b2fe4dbe5266 |
line wrap: on
line diff
--- a/scripts/audio/@audioplayer/audioplayer.m Tue Jan 13 12:50:43 2015 +0100 +++ b/scripts/audio/@audioplayer/audioplayer.m Tue Jan 13 08:54:25 2015 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{player} =} audioplayer (@var{y}, @var{fs}) +## @deftypefn {Function File} {@var{player} =} audioplayer (@var{y}, @var{fs}) ## @deftypefnx {Function File} {@var{player} =} audioplayer (@var{y}, @var{fs}, @var{nbits}) ## @deftypefnx {Function File} {@var{player} =} audioplayer (@var{y}, @var{fs}, @var{nbits}, @var{id}) ## @deftypefnx {Function File} {@var{player} =} audioplayer (@var{recorder}) @@ -28,9 +28,8 @@ ## may be found using the audiodevinfo function. ## Given an audioplayer object, use the data from the object to ## initialize the player. -## @end deftypefn ## -## The signal @var{y} can be a vector or a two dimensional array. +## The signal @var{y} can be a vector or a two-dimensional array. ## ## The following example will create an audioplayer object that will play ## back one second of white noise at 44100 sample rate using 8 bits per @@ -43,6 +42,7 @@ ## play (player); ## @end group ## @end example +## @end deftypefn ## FIXME: callbacks don't work properly, apparently because portaudio ## will execute the callbacks in a separate thread, and calling Octave