summaryrefslogtreecommitdiff
path: root/gr-audio/doc/audio.dox
blob: 3a0cb5e488a1edd3455fa898f121c58d61d15ac4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
/*! \page page_audio Audio Interface

\section Introduction

This is the gr-audio package. This package includes all of the
supported audio interfaces, including:

\li alsa
\li oss
\li jack
\li portaudio
\li osx
\li windows

\code
    from gnuradio import audio
\endcode

See the Doxygen documentation for details about the blocks available
in this package. The relevant blocks are listed in the \ref audio_blk group.

A quick listing of the details can be found in Python after importing
by using:

\code
    help(digital)
\endcode


\section Usage
For an audio source, a typical OptionParser option and it's use looks
like:

\code
    parser.add_option("-O", "--audio-output", type="string", default="",
                       help="pcm device name.  E.g., hw:0,0 or surround51 or /dev/dsp")
    audio_rate = 32e3
    audio_sink = audio.sink (int (audio_rate), options.audio_output)
\endcode

Similarly, an audio sink would have a typical OptionParser option and
its use would look like:

\code
    parser.add_option("-I", "--audio-input", type="string", default="",
                      help="pcm input device name.  E.g., hw:0,0 or /dev/dsp")
    audio_rate = 32e3
    audio_source = audio.source(int(audio_rate), audio_input)
\endcode

*/