GNU Radio 3.7.1 C++ API
|
00001 /* -*- c++ -*- */ 00002 /* 00003 * Copyright 2011,2013 Free Software Foundation, Inc. 00004 * 00005 * This file is part of GNU Radio 00006 * 00007 * GNU Radio is free software; you can redistribute it and/or modify 00008 * it under the terms of the GNU General Public License as published by 00009 * the Free Software Foundation; either version 3, or (at your option) 00010 * any later version. 00011 * 00012 * GNU Radio is distributed in the hope that it will be useful, 00013 * but WITHOUT ANY WARRANTY; without even the implied warranty of 00014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00015 * GNU General Public License for more details. 00016 * 00017 * You should have received a copy of the GNU General Public License 00018 * along with GNU Radio; see the file COPYING. If not, write to 00019 * the Free Software Foundation, Inc., 51 Franklin Street, 00020 * Boston, MA 02110-1301, USA. 00021 */ 00022 00023 #ifndef INCLUDED_GR_AUDIO_SINK_H 00024 #define INCLUDED_GR_AUDIO_SINK_H 00025 00026 #include <gnuradio/audio/api.h> 00027 #include <gnuradio/sync_block.h> 00028 00029 namespace gr { 00030 namespace audio { 00031 00032 /*! 00033 * \brief Creates a sink from an audio device. 00034 * \ingroup audio_blk 00035 */ 00036 class GR_AUDIO_API sink : virtual public sync_block 00037 { 00038 public: 00039 typedef boost::shared_ptr<sink> sptr; 00040 00041 /*! 00042 * Creates a sink from an audio device at a specified 00043 * sample_rate. The specific audio device to use can be 00044 * specified as the device_name parameter. Typical choices are: 00045 * \li pulse 00046 * \li hw:0,0 00047 * \li plughw:0,0 00048 * \li surround51 00049 * \li /dev/dsp 00050 * 00051 * \xmlonly 00052 * - pulse, hw:0,0, plughw:0,0, surround51, /dev/dsp 00053 * \endxmlonly 00054 */ 00055 static sptr make(int sampling_rate, 00056 const std::string device_name = "", 00057 bool ok_to_block = true); 00058 }; 00059 00060 } /* namespace audio */ 00061 } /* namespace gr */ 00062 00063 #endif /* INCLUDED_GR_AUDIO_SINK_H */