<?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>Phonon.ObjectDescriptionData</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.7 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>ObjectDescriptionData Class Reference</h1> <code>from PyKDE4.phonon import *</code> <p> Namespace: <a href="../phonon/Phonon.html">Phonon</a><br /> <h2>Detailed Description</h2> <p><dl class="internal" compact><dt><b>Internal:</b></dt><dd> </dd></dl> \class ObjectDescriptionData objectdescription.h phonon/ObjectDescription Data class for objects describing devices or features of the backend. </p> <p> <dl class="author" compact><dt><b>Author:</b></dt><dd> Matthias Kretz <kretz@kde.org> </dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> BackendCapabilities </dd></dl> </p> <table border="0" cellpadding="0" cellspacing="0"><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="#ObjectDescriptionData">__init__</a> (self, int index, {QByteArray:QVariant} properties)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#description">description</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#index">index</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isValid">isValid</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">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#operator ==">operator ==</a> (self, <a href="../phonon/Phonon.ObjectDescriptionData.html">Phonon.ObjectDescriptionData</a> otherDescription)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QVariant </td><td class="memItemRight" valign="bottom"><a class="el" href="#property">property</a> (self, QString name)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">[QByteArray] </td><td class="memItemRight" valign="bottom"><a class="el" href="#propertyNames">propertyNames</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="../phonon/Phonon.ObjectDescriptionData.html">Phonon.ObjectDescriptionData</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#fromIndex">fromIndex</a> (<a href="../phonon/Phonon.html#ObjectDescriptionType">Phonon.ObjectDescriptionType</a> type, int index)</td></tr> </table> <hr><h2>Method Documentation</h2><a class="anchor" name="ObjectDescriptionData"></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">int </td> <td class="paramname"><em>index</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">{QByteArray:QVariant} </td> <td class="paramname"><em>properties</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"></div></div><a class="anchor" name="description"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString description</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>Returns a description of the capture source. This text should make clear what sound source this is, which is sometimes hard to describe or understand from just the name. </p> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> A string describing the capture source. </dd></dl> </p></div></div><a class="anchor" name="index"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">int index</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>A unique identifier for this device/. Used internally to distinguish between the devices/. </p> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> An integer that uniquely identifies every device/ </dd></dl> </p></div></div><a class="anchor" name="isValid"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isValid</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>Returns true if the Tuple is valid (index != -1); otherwise returns false. </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>Returns the name of the capture source. </p> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> A string that should be presented to the user to choose the capture source. </dd></dl> </p></div></div><a class="anchor" name="operator =="></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool operator ==</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="../phonon/Phonon.ObjectDescriptionData.html">Phonon.ObjectDescriptionData</a> </td> <td class="paramname"><em>otherDescription</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Returns true if this ObjectDescription describes the same as <b>otherDescription;</b> otherwise returns false. </p></div></div><a class="anchor" name="property"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QVariant property</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">QString </td> <td class="paramname"><em>name</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Returns a named property. </p> <p> If the property is not set an invalid value is returned. </p> <p> <dl class="see" compact><dt><b>See also:</b></dt><dd> propertyNames() </dd></dl> </p></div></div><a class="anchor" name="propertyNames"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">[QByteArray] propertyNames</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>Returns all names that return valid data when property() is called. </p> <p> <dl class="see" compact><dt><b>See also:</b></dt><dd> property() </dd></dl> </p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="fromIndex"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../phonon/Phonon.ObjectDescriptionData.html">Phonon.ObjectDescriptionData</a> fromIndex</td> <td>(</td> <td class="paramtype"><a href="../phonon/Phonon.html#ObjectDescriptionType">Phonon.ObjectDescriptionType</a> </td> <td class="paramname"><em>type</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>index</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"></div></div> </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>