diff options
| author | Tom Rondeau <trondeau@vt.edu> | 2011-10-09 21:58:40 -0400 |
|---|---|---|
| committer | Tom Rondeau <trondeau@vt.edu> | 2011-10-09 21:58:40 -0400 |
| commit | 79b68aa7f9f67a3ce2f48582bc062e8c5cba2413 (patch) | |
| tree | f3b3745af48e52aeee445f6efec307865dc821dd /gr-audio/include | |
| parent | 7ba45cf3452123a4c08a4aa535da76b793d2eaf2 (diff) | |
docs: adding doc directory, Doxygen page, and README for audio package.
Diffstat (limited to 'gr-audio/include')
| -rw-r--r-- | gr-audio/include/gr_audio_sink.h | 13 | ||||
| -rw-r--r-- | gr-audio/include/gr_audio_source.h | 13 |
2 files changed, 26 insertions, 0 deletions
diff --git a/gr-audio/include/gr_audio_sink.h b/gr-audio/include/gr_audio_sink.h index ca3b15a37a..ec064b64bf 100644 --- a/gr-audio/include/gr_audio_sink.h +++ b/gr-audio/include/gr_audio_sink.h @@ -25,6 +25,19 @@ #include <gr_audio_api.h> #include <gr_sync_block.h> +/*! + * \brief Creates a sink from an audio device. + * \ingroup audio_blk + * + * Creates a sink 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_sink : virtual public gr_sync_block{ public: typedef boost::shared_ptr<audio_sink> sptr; diff --git a/gr-audio/include/gr_audio_source.h b/gr-audio/include/gr_audio_source.h index b8ae2ca5fa..eca22e3eb8 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; |