<?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.4 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: Solid.DeviceInterface → <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a><br />
Namespace: Solid.AudioInterface<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, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a> backendObject)</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> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../solid/Solid.AudioInterface.AudioInterfaceTypes.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"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qvariant.html">QVariant</a> </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"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </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>
</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"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a> </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="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"><em>self</em> )</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><a class="anchor" name="deviceType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../solid/Solid.AudioInterface.AudioInterfaceTypes.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.AudioInterfaceTypes
</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"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qvariant.html">QVariant</a> 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"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> 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>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>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
b77dda48f87d4eda8cc559e40c49a652
>
files
>
1111
