diff options
| author | Tom Rondeau | 2011-10-09 21:58:40 -0400 |
|---|---|---|
| committer | Tom Rondeau | 2011-10-09 21:58:40 -0400 |
| commit | 79b68aa7f9f67a3ce2f48582bc062e8c5cba2413 (patch) | |
| tree | f3b3745af48e52aeee445f6efec307865dc821dd /gr-audio/doc/README.audio | |
| parent | 7ba45cf3452123a4c08a4aa535da76b793d2eaf2 (diff) | |
| download | gnuradio-79b68aa7f9f67a3ce2f48582bc062e8c5cba2413.tar.gz gnuradio-79b68aa7f9f67a3ce2f48582bc062e8c5cba2413.tar.bz2 gnuradio-79b68aa7f9f67a3ce2f48582bc062e8c5cba2413.zip | |
docs: adding doc directory, Doxygen page, and README for audio package.
Diffstat (limited to 'gr-audio/doc/README.audio')
| -rw-r--r-- | gr-audio/doc/README.audio | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/gr-audio/doc/README.audio b/gr-audio/doc/README.audio new file mode 100644 index 000000000..ebd0fe5d7 --- /dev/null +++ b/gr-audio/doc/README.audio @@ -0,0 +1,20 @@ +This is the gr-audio package. This package includes all of the +supported audio interfaces, including: + - alsa + - oss + - jack + - portaudio + - osx + - windows + +Typically, the audio package will auto-detect the proper driver to use +based on the system it is run on. Import this package with: + + from gnuradio import audio + +See the Doxygen documentation for details about the blocks available +in this package. A quick listing of the details can be found in Python +after importing by using: + + help(audio) + |