summaryrefslogtreecommitdiff
path: root/gr-audio/include/gr_audio_source.h
diff options
context:
space:
mode:
Diffstat (limited to 'gr-audio/include/gr_audio_source.h')
-rw-r--r--gr-audio/include/gr_audio_source.h13
1 files changed, 13 insertions, 0 deletions
diff --git a/gr-audio/include/gr_audio_source.h b/gr-audio/include/gr_audio_source.h
index b8ae2ca5f..eca22e3eb 100644
--- a/gr-audio/include/gr_audio_source.h
+++ b/gr-audio/include/gr_audio_source.h
@@ -25,6 +25,19 @@
#include <gr_audio_api.h>
#include <gr_sync_block.h>
+/*!
+ * \brief Creates a source from an audio device.
+ * \ingroup audio_blk
+ *
+ * Creates a source from an audio device at a specified
+ * sample_rate. The specific audio device to use can be specified as
+ * the device_name parameter. Typical choices are:
+ * \li pulse
+ * \li hw:0,0
+ * \li plughw:0,0
+ * \li surround51
+ * \li /dev/dsp
+ */
class GR_AUDIO_API audio_source : virtual public gr_sync_block{
public:
typedef boost::shared_ptr<audio_source> sptr;