Mercurial > octave-nkf

changeset 19518:d24bf3fb4c09

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
audio functionality documentation * Makefile.am: added audiodevinfo.texi, audioplayer.texi, audiorecorder.texi and audiofile.texi as targets * audio.txi: added a menu to access audio documentation, include new audio related txi files * audiodevinfo.txi, audiofile.txi, audioplayer.txi, audiorecorder.txi: new files documenting audio functionality
author Vytautas Jančauskas <unaudio@gmail.com>
date Tue, 17 Sep 2013 20:53:11 +0300
parents abde714a4f88
children b3399e03eb21
files doc/interpreter/Makefile.am doc/interpreter/audio.txi doc/interpreter/audiodevinfo.txi doc/interpreter/audiofile.txi doc/interpreter/audioplayer.txi doc/interpreter/audiorecorder.txi
diffstat 6 files changed, 38 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/Makefile.am	Mon Sep 16 16:46:44 2013 +0300
+++ b/doc/interpreter/Makefile.am	Tue Sep 17 20:53:11 2013 +0300
@@ -116,6 +116,10 @@
 MUNGED_TEXI_SRC = \
   arith.texi \
   audio.texi \
+  audiodevinfo.texi \
+  audioplayer.texi \
+  audiorecorder.texi \
+  audiofile.texi \
   basics.texi \
   bugs.texi \
   container.texi \
--- a/doc/interpreter/audio.txi	Mon Sep 16 16:46:44 2013 +0300
+++ b/doc/interpreter/audio.txi	Tue Sep 17 20:53:11 2013 +0300
@@ -21,6 +21,13 @@
 @node Audio Processing
 @chapter Audio Processing
 
+@menu
+* Audio Device Information::
+* Audio Player::
+* Audio Recorder::
+* Audio File Utilities::
+@end menu
+
 Octave provides a few functions for dealing with audio data.  An audio
 `sample' is a single output value from an A/D converter, i.e., a small
 integer number (usually 8 or 16 bits), and audio data is just a series
@@ -68,3 +75,8 @@
 @DOCSTRING(wavread)
 
 @DOCSTRING(wavwrite)
+
+@include audiodevinfo.texi
+@include audioplayer.texi
+@include audiorecorder.texi
+@include audiofile.texi
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/interpreter/audiodevinfo.txi	Tue Sep 17 20:53:11 2013 +0300
@@ -0,0 +1,4 @@
+@node Audio Device Information
+@section Audio Device Information
+
+@DOCSTRING(audiodevinfo)
\ No newline at end of file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/interpreter/audiofile.txi	Tue Sep 17 20:53:11 2013 +0300
@@ -0,0 +1,8 @@
+@node Audio File Utilities
+@section Audio File Utilities
+
+The following functions provide functionality for reading and writing audio files in various formats including .wav, .flag, .ogg and many others. Also for retrieving information about audio files, such as number of channels, sampling rate, metadata and other.
+
+@DOCSTRING(audioinfo)
+@DOCSTRING(audioread)
+@DOCSTRING(audiowrite)
\ No newline at end of file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/interpreter/audioplayer.txi	Tue Sep 17 20:53:11 2013 +0300
@@ -0,0 +1,5 @@
+@node Audio Player
+@section Audio Player
+
+@DOCSTRING("@audioplayer/audioplayer")
+@DOCSTRING("@audioplayer/play")
\ No newline at end of file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/interpreter/audiorecorder.txi	Tue Sep 17 20:53:11 2013 +0300
@@ -0,0 +1,5 @@
+@node Audio Recorder
+@section Audio Recorder
+
+@DOCSTRING("@audioplayer/audiorecorder")
+@DOCSTRING("@audioplayer/record")
\ No newline at end of file