diff options
| author | Josh Blum <josh@joshknows.com> | 2011-10-11 21:35:35 -0700 |
|---|---|---|
| committer | Josh Blum <josh@joshknows.com> | 2011-10-11 21:35:35 -0700 |
| commit | 1259a01a9479071bd1729a9c9496444f0a72509b (patch) | |
| tree | 55350454454a119fb230cdbaadfb27d361f191ec /gr-audio/include | |
| parent | 71c0f14a46f85027b95f2f5f6d3d219cc9e3783e (diff) | |
| parent | 06860c309153890a6a42babfbedf230eb24f0042 (diff) | |
Merge branch 'next' of http://gnuradio.org/git/gnuradio into next
Conflicts:
gr-digital/include/digital_constellation.h
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; |