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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Solid.AudioInterface</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
<div id="header_top">
<div>
<div>
<img alt ="" src="../common/top-kde.jpg"/>
KDE 4.9 PyKDE API Reference
</div>
</div>
</div>
<div id="header_bottom">
<div id="location">
<ul>
<li>KDE's Python API</li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h1>AudioInterface Class Reference</h1>
<code>from PyKDE4.solid import *</code>
<p>
Inherits: <a href="../solid/Solid.DeviceInterface.html">Solid.DeviceInterface</a> → QObject<br />
Namespace: <a href="../solid/Solid.html">Solid</a><br />
<h2>Detailed Description</h2>
<p>This device interface is available on interfaces exposed by sound cards.
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#AudioDriver">AudioDriver</a> </td><td class="memItemRight" valign="bottom">{ Alsa, OpenSoundSystem, UnknownAudioDriver }</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#AudioInterfaceType">AudioInterfaceType</a> </td><td class="memItemRight" valign="bottom">{ UnknownAudioInterfaceType, AudioControl, AudioInput, AudioOutput }</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#SoundcardType">SoundcardType</a> </td><td class="memItemRight" valign="bottom">{ InternalSoundcard, UsbSoundcard, FirewireSoundcard, Headset, Modem }</td></tr>
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#AudioInterface">__init__</a> (self, QObject backendObject)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../solid/Solid.AudioInterface.html">Solid.AudioInterface.AudioInterfaceTypes</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#deviceType">deviceType</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../solid/Solid.AudioInterface.html#AudioDriver">Solid.AudioInterface.AudioDriver</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#driver">driver</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QVariant </td><td class="memItemRight" valign="bottom"><a class="el" href="#driverHandle">driverHandle</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#name">name</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../solid/Solid.AudioInterface.html#SoundcardType">Solid.AudioInterface.SoundcardType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#soundcardType">soundcardType</a> (self)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../solid/Solid.DeviceInterface.html#Type">Solid.DeviceInterface.Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#deviceInterfaceType">deviceInterfaceType</a> ()</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="AudioInterface"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QObject </td>
<td class="paramname"><em>backendObject</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Creates a new AudioInterface object.
You generally won't need this. It's created when necessary using
Device.as().
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>backendObject</em> </td><td> the device interface object provided by the backend
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> Solid.Device.as()
</dd></dl>
</p></div></div><a class="anchor" name="deviceType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../solid/Solid.AudioInterface.html">Solid.AudioInterface.AudioInterfaceTypes</a> deviceType</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Retrieves the type of this audio interface (in/out/control).
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the type of this audio interface
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> Solid.AudioInterface.AudioInterfaceType
</dd></dl>
</p></div></div><a class="anchor" name="driver"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../solid/Solid.AudioInterface.html#AudioDriver">Solid.AudioInterface.AudioDriver</a> driver</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Retrieves the audio driver that should be used to access the device.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the driver needed to access the device
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> Solid.AudioInterface.AudioDriver
</dd></dl>
</p></div></div><a class="anchor" name="driverHandle"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QVariant driverHandle</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Retrieves a driver specific handle to access the device.
</p>
<p>
For Alsa devices it is a list with (card, device, subdevice).
<pre class="fragment">
QVariantList list = dev->driverHandle().toList();
QString card = list[0].toString();
int device = list[1].toInt();
int subdevice = list[2].toInt();
</pre>
The card entry sometimes can be converted to an integer, but it may just as well be the
textual id for the card. So don't rely on it to work with QVariant.toInt().
</p>
<p>
For OSS devices it is simply a string like "/dev/dsp". Use QVariant.toString() to
retrieve the string.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the driver specific data to handle this device
</dd></dl>
</p></div></div><a class="anchor" name="name"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString name</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Retrieves the name of this audio interface.
</p>
<p>
The product name of the parent device is normally better suited for the user to identify
the soundcard. If the soundcard has multiple devices, though you need to add this name to
differentiate between the devices.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the name of the audio interface if available, QString() otherwise
</dd></dl>
</p></div></div><a class="anchor" name="soundcardType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../solid/Solid.AudioInterface.html#SoundcardType">Solid.AudioInterface.SoundcardType</a> soundcardType</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Retrieves the type of soundcard (internal/headset/...).
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the type of soundcard
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> Solid.AudioInterface.SoundcardType
</dd></dl>
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="deviceInterfaceType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../solid/Solid.DeviceInterface.html#Type">Solid.DeviceInterface.Type</a> deviceInterfaceType</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Get the Solid.DeviceInterface.Type of the AudioInterface device interface.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the AudioInterface device interface type
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> Solid.DeviceInterface.Type
</dd></dl>
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="AudioDriver"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">AudioDriver</td>
</tr>
</table>
</div>
<div class="memdoc"><p>This enum type defines the type of driver required to
interact with the device.
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>Alsa</em> </td><td><tr><td valign="top"><em>OpenSoundSystem</em> </td><td><tr><td valign="top"><em>UnknownAudioDriver</em> </td><td></table>
</dl>
</div></div><p><a class="anchor" name="AudioInterfaceType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">AudioInterfaceType</td>
</tr>
</table>
</div>
<div class="memdoc"><p>This enum type defines the type of audio interface this
device expose.
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>UnknownAudioInterfaceType</em> = 0</td><td><tr><td valign="top"><em>AudioControl</em> = 1</td><td><tr><td valign="top"><em>AudioInput</em> = 2</td><td><tr><td valign="top"><em>AudioOutput</em> = 4</td><td></table>
</dl>
</div></div><p><a class="anchor" name="SoundcardType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">SoundcardType</td>
</tr>
</table>
</div>
<div class="memdoc"><p>This enum defines the type of soundcard of this device.
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>InternalSoundcard</em> </td><td><tr><td valign="top"><em>UsbSoundcard</em> </td><td><tr><td valign="top"><em>FirewireSoundcard</em> </td><td><tr><td valign="top"><em>Headset</em> </td><td><tr><td valign="top"><em>Modem</em> </td><td></table>
</dl>
</div></div><p>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>
</div>
</div>
<div class="clearer"/>
</div>
<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div></div>
</body>
</html>
|
