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