# HG changeset patch # User Vytautas JanĨauskas # Date 1379440391 -10800 # Node ID d24bf3fb4c09a9be93a4abe6d4eb7463bd2807d8 # Parent abde714a4f889c364460ac767060f732ee6b3bde 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 diff -r abde714a4f88 -r d24bf3fb4c09 doc/interpreter/Makefile.am --- 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 \ diff -r abde714a4f88 -r d24bf3fb4c09 doc/interpreter/audio.txi --- 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 diff -r abde714a4f88 -r d24bf3fb4c09 doc/interpreter/audiodevinfo.txi --- /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 diff -r abde714a4f88 -r d24bf3fb4c09 doc/interpreter/audiofile.txi --- /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 diff -r abde714a4f88 -r d24bf3fb4c09 doc/interpreter/audioplayer.txi --- /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 diff -r abde714a4f88 -r d24bf3fb4c09 doc/interpreter/audiorecorder.txi --- /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