Mercurial > octave-nkf
comparison doc/interpreter/audio.txi @ 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 | 651f12640c90 |
children | 0e1f5a750d00 |
comparison
equal
deleted
inserted
replaced
19604:62ca016dbb2a | 19605:72304a4e010a |
---|---|
31 | 31 |
32 @node Audio File Utilities | 32 @node Audio File Utilities |
33 @section Audio File Utilities | 33 @section Audio File Utilities |
34 | 34 |
35 The following functions allow you to read, write and retrieve | 35 The following functions allow you to read, write and retrieve |
36 information about audio files. Various formats are supported including | 36 information about audio files. Various formats are supported including |
37 wav, flac and ogg vorbis. | 37 wav, flac and ogg vorbis. |
38 | 38 |
39 @DOCSTRING(audioinfo) | 39 @DOCSTRING(audioinfo) |
40 | 40 |
41 @DOCSTRING(audioread) | 41 @DOCSTRING(audioread) |
49 | 49 |
50 @node Audio Player | 50 @node Audio Player |
51 @section Audio Player | 51 @section Audio Player |
52 | 52 |
53 The following methods are used to create and use audioplayer | 53 The following methods are used to create and use audioplayer |
54 objects. These objects can be used to play back audio data stored in | 54 objects. These objects can be used to play back audio data stored in |
55 Octave matrices and arrays. The audioplayer object supports playback | 55 Octave matrices and arrays. The audioplayer object supports playback |
56 from various devices available to the system, blocking and non-blocking | 56 from various devices available to the system, blocking and non-blocking |
57 playback, convenient pausing and resuming and much more. | 57 playback, convenient pausing and resuming and much more. |
58 | 58 |
59 @DOCSTRING(@audioplayer/audioplayer) | 59 @DOCSTRING(@audioplayer/audioplayer) |
60 | 60 |
92 | 92 |
93 @node Audio Recorder | 93 @node Audio Recorder |
94 @section Audio Recorder | 94 @section Audio Recorder |
95 | 95 |
96 The following methods are used to create and use audiorecorder | 96 The following methods are used to create and use audiorecorder |
97 objects. These objects can be used to record audio data from various | 97 objects. These objects can be used to record audio data from various |
98 devices available to the system. You can use convenient methods to | 98 devices available to the system. You can use convenient methods to |
99 retrieve that data or audioplayer objects created from that | 99 retrieve that data or audioplayer objects created from that |
100 data. Methods for blocking and non-blocking recording, pausing and | 100 data. Methods for blocking and non-blocking recording, pausing and |
101 resuming recording and much more is available. | 101 resuming recording and much more is available. |
102 | 102 |
103 @DOCSTRING(@audiorecorder/audiorecorder) | 103 @DOCSTRING(@audiorecorder/audiorecorder) |
104 | 104 |
105 @menu | 105 @menu |