summaryrefslogtreecommitdiff
path: root/gr-audio/include/gr_audio_sink.h
diff options
context:
space:
mode:
authorTom Rondeau2011-11-27 15:50:13 -0500
committerTom Rondeau2011-11-27 15:50:13 -0500
commit633fd3b6cfc6c735a5adf2e91328fed4c67d7f51 (patch)
treedccc236f81a7d5559839543414cf60e704c8d7fb /gr-audio/include/gr_audio_sink.h
parent0a21e2584c226496af2aa3b361bed3d6bd91ba41 (diff)
downloadgnuradio-633fd3b6cfc6c735a5adf2e91328fed4c67d7f51.tar.gz
gnuradio-633fd3b6cfc6c735a5adf2e91328fed4c67d7f51.tar.bz2
gnuradio-633fd3b6cfc6c735a5adf2e91328fed4c67d7f51.zip
docs: added python doxygen docs to gr-audio.
Diffstat (limited to 'gr-audio/include/gr_audio_sink.h')
-rw-r--r--gr-audio/include/gr_audio_sink.h17
1 files changed, 11 insertions, 6 deletions
diff --git a/gr-audio/include/gr_audio_sink.h b/gr-audio/include/gr_audio_sink.h
index ec064b64b..7a1caaf80 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 = "",