summaryrefslogtreecommitdiff
path: root/gr-audio/README
diff options
context:
space:
mode:
authorTom Rondeau2011-03-15 13:46:02 -0400
committerTom Rondeau2011-03-15 13:46:02 -0400
commit338b01e7b5ecad7e324098a2671d3fa650be035e (patch)
tree247b61f2fbfdadc6ce4f39ad2f637a22cd3163ae /gr-audio/README
parent1ecc511ad673f37498ebc29147c776ca9b4b6490 (diff)
parentb4bd3e47189932b42ce821bb7076fce811b3e3eb (diff)
downloadgnuradio-338b01e7b5ecad7e324098a2671d3fa650be035e.tar.gz
gnuradio-338b01e7b5ecad7e324098a2671d3fa650be035e.tar.bz2
gnuradio-338b01e7b5ecad7e324098a2671d3fa650be035e.zip
Merge branch 'next' of gnuradio.org:gnuradio into next
Diffstat (limited to 'gr-audio/README')
-rw-r--r--gr-audio/README11
1 files changed, 11 insertions, 0 deletions
diff --git a/gr-audio/README b/gr-audio/README
new file mode 100644
index 000000000..ae929a94a
--- /dev/null
+++ b/gr-audio/README
@@ -0,0 +1,11 @@
+The gnuradio audio component provides an audio_source and audio_sink block.
+The audio blocks stream floating point samples to and from audio hardware.
+
+The gr-audio will be built automatically when gnuradio-core is enabled.
+Support for underlying audio architectures depends on OS and installed libraries.
+At the time of writing, gr-audio supports oss, alsa, jack, portaudio, audiounit, and winmm.
+
+At runtime, gr-audio will automatically select from the available architectures.
+The user can override the selection via configuration file by setting "audio_module"
+to one of the following strings: oss, alsa, jack, portaudio, osx, or windows.
+See gr-audio.conf for an example.