Imported Upstream version 3.2.2
[debian/gnuradio] / grc / blocks / audio_sink.xml
1 <?xml version="1.0"?>
2 <!--
3 ###################################################
4 ##Audio Sink
5 ###################################################
6  -->
7 <block>
8         <name>Audio Sink</name>
9         <key>audio_sink</key>
10         <import>from gnuradio import audio</import>
11         <make>audio.sink($samp_rate, $device_name, $ok_to_block)</make>
12         <param>
13                 <name>Sample Rate</name>
14                 <key>samp_rate</key>
15                 <value>32000</value>
16                 <type>int</type>
17                 <option>
18                         <name>16KHz</name>
19                         <key>16000</key>
20                 </option>
21                 <option>
22                         <name>22.05KHz</name>
23                         <key>22050</key>
24                 </option>
25                 <option>
26                         <name>24KHz</name>
27                         <key>24000</key>
28                 </option>
29                 <option>
30                         <name>32KHz</name>
31                         <key>32000</key>
32                 </option>
33                 <option>
34                         <name>44.1KHz</name>
35                         <key>44100</key>
36                 </option>
37                 <option>
38                         <name>48KHz</name>
39                         <key>48000</key>
40                 </option>
41         </param>
42         <param>
43                 <name>Device Name</name>
44                 <key>device_name</key>
45                 <value></value>
46                 <type>string</type>
47                 <hide>#if $device_name() then 'none' else 'part'#</hide>
48         </param>
49         <param>
50                 <name>OK to Block</name>
51                 <key>ok_to_block</key>
52                 <value>True</value>
53                 <type>enum</type>
54                 <hide>part</hide>
55                 <option>
56                         <name>Yes</name>
57                         <key>True</key>
58                 </option>
59                 <option>
60                         <name>No</name>
61                         <key>False</key>
62                 </option>
63         </param>
64         <param>
65                 <name>Num Inputs</name>
66                 <key>num_inputs</key>
67                 <value>1</value>
68                 <type>int</type>
69         </param>
70         <check>0 &lt; $num_inputs</check>
71         <sink>
72                 <name>in</name>
73                 <type>float</type>
74                 <nports>$num_inputs</nports>
75         </sink>
76         <doc>
77 Not all sampling rates will be supported by your hardware.
78
79 Leave the device name blank to choose deafult audio device. \
80 ALSA users with audio trouble may try setting the device name to plughw:0,0
81
82 The audio sink can have multiple inputs depending upon your hardware. \
83 For example, set the inputs to 2 for stereo audio.
84         </doc>
85 </block>