GNU Radio 3.6.5.1 C++ API
gr_audio_source.h
Go to the documentation of this file.
1 /*
2  * Copyright 2011 Free Software Foundation, Inc.
3  *
4  * This file is part of GNU Radio
5  *
6  * GNU Radio is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3, or (at your option)
9  * any later version.
10  *
11  * GNU Radio is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with GNU Radio; see the file COPYING. If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street,
19  * Boston, MA 02110-1301, USA.
20  */
21 
22 #ifndef INCLUDED_GR_AUDIO_SOURCE_H
23 #define INCLUDED_GR_AUDIO_SOURCE_H
24 
25 #include <gr_audio_api.h>
26 #include <gr_sync_block.h>
27 
28 /*!
29  * \brief Creates a source from an audio device.
30  * \ingroup audio_blk
31  */
32 class GR_AUDIO_API audio_source : virtual public gr_sync_block{
33 public:
35 };
36 
37 /*!
38  * Creates a source from an audio device at a specified
39  * sample_rate. The specific audio device to use can be specified as
40  * the device_name parameter. Typical choices are:
41  * \li pulse
42  * \li hw:0,0
43  * \li plughw:0,0
44  * \li surround51
45  * \li /dev/dsp
46  *
47  * \xmlonly
48  * - pulse, hw:0,0, plughw:0,0, surround51, /dev/dsp
49  * \endxmlonly
50  */
52  int sampling_rate,
53  const std::string device_name = "",
54  bool ok_to_block = true
55 );
56 
57 #endif /* INCLUDED_GR_AUDIO_SOURCE_H */