diff options
| author | Tom Rondeau <trondeau@vt.edu> | 2011-11-27 15:50:13 -0500 |
|---|---|---|
| committer | Tom Rondeau <trondeau@vt.edu> | 2011-11-27 15:50:13 -0500 |
| commit | 633fd3b6cfc6c735a5adf2e91328fed4c67d7f51 (patch) | |
| tree | dccc236f81a7d5559839543414cf60e704c8d7fb /gr-audio/include | |
| parent | 0a21e2584c226496af2aa3b361bed3d6bd91ba41 (diff) | |
docs: added python doxygen docs to gr-audio.
Diffstat (limited to 'gr-audio/include')
| -rw-r--r-- | gr-audio/include/gr_audio_sink.h | 17 | ||||
| -rw-r--r-- | gr-audio/include/gr_audio_source.h | 17 |
2 files changed, 22 insertions, 12 deletions
diff --git a/gr-audio/include/gr_audio_sink.h b/gr-audio/include/gr_audio_sink.h index ec064b64bf..7a1caaf80c 100644 --- a/gr-audio/include/gr_audio_sink.h +++ b/gr-audio/include/gr_audio_sink.h @@ -28,7 +28,13 @@ /*! * \brief Creates a sink from an audio device. * \ingroup audio_blk - * + */ +class GR_AUDIO_API audio_sink : virtual public gr_sync_block{ +public: + typedef boost::shared_ptr<audio_sink> sptr; +}; + +/*! * 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: @@ -37,12 +43,11 @@ * \li plughw:0,0 * \li surround51 * \li /dev/dsp + * + * \xmlonly + * - pulse, hw:0,0, plughw:0,0, surround51, /dev/dsp + * \endxmlonly */ -class GR_AUDIO_API audio_sink : virtual public gr_sync_block{ -public: - typedef boost::shared_ptr<audio_sink> sptr; -}; - GR_AUDIO_API audio_sink::sptr audio_make_sink( int sampling_rate, const std::string device_name = "", diff --git a/gr-audio/include/gr_audio_source.h b/gr-audio/include/gr_audio_source.h index eca22e3eb8..8fe2b9b478 100644 --- a/gr-audio/include/gr_audio_source.h +++ b/gr-audio/include/gr_audio_source.h @@ -28,7 +28,13 @@ /*! * \brief Creates a source from an audio device. * \ingroup audio_blk - * + */ +class GR_AUDIO_API audio_source : virtual public gr_sync_block{ +public: + typedef boost::shared_ptr<audio_source> sptr; +}; + +/*! * 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: @@ -37,12 +43,11 @@ * \li plughw:0,0 * \li surround51 * \li /dev/dsp + * + * \xmlonly + * - pulse, hw:0,0, plughw:0,0, surround51, /dev/dsp + * \endxmlonly */ -class GR_AUDIO_API audio_source : virtual public gr_sync_block{ -public: - typedef boost::shared_ptr<audio_source> sptr; -}; - GR_AUDIO_API audio_source::sptr audio_make_source( int sampling_rate, const std::string device_name = "", |