Sophie

Sophie

distrib > Mageia > 5 > i586 > media > core-release > by-pkgid > 50facae208d4a6f280e44a513b104320 > files > 598

qt-mobility-doc-1.2.0-13.mga5.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qaudioendpointselector.cpp -->
  <title>Qt Mobility 1.2: QAudioEndpointSelector Class Reference</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>QtMobility Reference Documentation</span></a>
  </div>
  <div class="breadcrumb toolblock">
    <ul>
      <li class="first"><a href="index.html">Home</a></li>
      <!--  Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtmultimediakit.html">QtMultimediaKit</a></li>
<li>QAudioEndpointSelector</li>
    </ul>
  </div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#macros">Macros</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QAudioEndpointSelector Class Reference</h1>
<!-- $$$QAudioEndpointSelector-brief -->
<p>The QAudioEndpointSelector class provides an audio endpoint selector media control. <a href="#details">More...</a></p>
<!-- @@@QAudioEndpointSelector -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QAudioEndpointSelector&gt;</span></pre><p><b>Inherits: </b><a href="qmediacontrol.html">QMediaControl</a>.</p>
<p>This class was introduced in Qt Mobility 1.0.</p>
<ul>
<li><a href="qaudioendpointselector-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qaudioendpointselector.html#dtor.QAudioEndpointSelector">~QAudioEndpointSelector</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qaudioendpointselector.html#activeEndpoint">activeEndpoint</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QList&lt;QString&gt; </td><td class="memItemRight bottomAlign"><b><a href="qaudioendpointselector.html#availableEndpoints">availableEndpoints</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qaudioendpointselector.html#defaultEndpoint">defaultEndpoint</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qaudioendpointselector.html#endpointDescription">endpointDescription</a></b> ( const QString &amp; <i>name</i> ) const = 0</td></tr>
</table>
<ul>
<li class="fn">29 public functions inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-functions">QObject</a></li>
</ul>
<a name="public-slots"></a>
<h2>Public Slots</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qaudioendpointselector.html#setActiveEndpoint">setActiveEndpoint</a></b> ( const QString &amp; <i>name</i> ) = 0</td></tr>
</table>
<ul>
<li class="fn">1 public slot inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-slots">QObject</a></li>
</ul>
<a name="signals"></a>
<h2>Signals</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudioendpointselector.html#activeEndpointChanged">activeEndpointChanged</a></b> ( const QString &amp; <i>name</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudioendpointselector.html#availableEndpointsChanged">availableEndpointsChanged</a></b> ()</td></tr>
</table>
<ul>
<li class="fn">1 signal inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#signals">QObject</a></li>
</ul>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qaudioendpointselector.html#QAudioEndpointSelector">QAudioEndpointSelector</a></b> ( QObject * <i>parent</i> = 0 )</td></tr>
</table>
<ul>
<li class="fn">7 protected functions inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#protected-functions">QObject</a></li>
</ul>
<a name="macros"></a>
<h2>Macros</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qaudioendpointselector.html#QAudioEndpointSelector_iid">QAudioEndpointSelector_iid</a></b></td></tr>
</table>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 property inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#properties">QObject</a></li>
<li class="fn">1 public variable inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-variables">QObject</a></li>
<li class="fn">4 static public members inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#static-public-members">QObject</a></li>
<li class="fn">2 protected variables inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QAudioEndpointSelector-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QAudioEndpointSelector class provides an audio endpoint selector media control.</p>
<p>The QAudioEndpointSelector class provides descriptions of the audio endpoints available on a system and allows one to be selected as the audio of a media service.</p>
<p>The interface name of QAudioEndpointSelector is <tt>com.nokia.Qt.QAudioEndpointSelector/1.0</tt> as defined in <a href="qaudioendpointselector.html#QAudioEndpointSelector_iid">QAudioEndpointSelector_iid</a>.</p>
</div>
<p><b>See also </b><a href="qmediaservice.html#requestControl">QMediaService::requestControl</a>().</p>
<!-- @@@QAudioEndpointSelector -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QAudioEndpointSelector[overload1]$$$QAudioEndpointSelectorQObject* -->
<h3 class="fn"><a name="QAudioEndpointSelector"></a>QAudioEndpointSelector::<span class="name">QAudioEndpointSelector</span> ( <span class="type"><a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a></span> * <i>parent</i> = 0 )<tt> [protected]</tt></h3>
<p>Constructs a new audio endpoint selector with the given <i>parent</i>.</p>
<!-- @@@QAudioEndpointSelector -->
<!-- $$$~QAudioEndpointSelector[overload1]$$$~QAudioEndpointSelector -->
<h3 class="fn"><a name="dtor.QAudioEndpointSelector"></a>QAudioEndpointSelector::<span class="name">~QAudioEndpointSelector</span> ()<tt> [virtual]</tt></h3>
<p>Destroys an audio endpoint selector.</p>
<!-- @@@~QAudioEndpointSelector -->
<!-- $$$activeEndpoint[overload1]$$$activeEndpoint -->
<h3 class="fn"><a name="activeEndpoint"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> QAudioEndpointSelector::<span class="name">activeEndpoint</span> () const<tt> [pure virtual]</tt></h3>
<p>Returns the name of the currently selected audio endpoint.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qaudioendpointselector.html#setActiveEndpoint">setActiveEndpoint</a>().</p>
<!-- @@@activeEndpoint -->
<!-- $$$activeEndpointChanged[overload1]$$$activeEndpointChangedconstQString& -->
<h3 class="fn"><a name="activeEndpointChanged"></a><span class="type">void</span> QAudioEndpointSelector::<span class="name">activeEndpointChanged</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> &amp; <i>name</i> )<tt> [signal]</tt></h3>
<p>Signals that the audio endpoint has changed to <i>name</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@activeEndpointChanged -->
<!-- $$$availableEndpoints[overload1]$$$availableEndpoints -->
<h3 class="fn"><a name="availableEndpoints"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qlist.html">QList</a></span>&lt;<span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span>&gt; QAudioEndpointSelector::<span class="name">availableEndpoints</span> () const<tt> [pure virtual]</tt></h3>
<p>Returns a list of available audio endpoints.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@availableEndpoints -->
<!-- $$$availableEndpointsChanged[overload1]$$$availableEndpointsChanged -->
<h3 class="fn"><a name="availableEndpointsChanged"></a><span class="type">void</span> QAudioEndpointSelector::<span class="name">availableEndpointsChanged</span> ()<tt> [signal]</tt></h3>
<p>Signals that list of available endpoints has changed.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@availableEndpointsChanged -->
<!-- $$$defaultEndpoint[overload1]$$$defaultEndpoint -->
<h3 class="fn"><a name="defaultEndpoint"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> QAudioEndpointSelector::<span class="name">defaultEndpoint</span> () const<tt> [pure virtual]</tt></h3>
<p>Returns the name of the default audio endpoint.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@defaultEndpoint -->
<!-- $$$endpointDescription[overload1]$$$endpointDescriptionconstQString& -->
<h3 class="fn"><a name="endpointDescription"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> QAudioEndpointSelector::<span class="name">endpointDescription</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> &amp; <i>name</i> ) const<tt> [pure virtual]</tt></h3>
<p>Returns the description of the endpoint <i>name</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@endpointDescription -->
<!-- $$$setActiveEndpoint[overload1]$$$setActiveEndpointconstQString& -->
<h3 class="fn"><a name="setActiveEndpoint"></a><span class="type">void</span> QAudioEndpointSelector::<span class="name">setActiveEndpoint</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> &amp; <i>name</i> )<tt> [pure virtual slot]</tt></h3>
<p>Set the audio endpoint to <i>name</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qaudioendpointselector.html#activeEndpoint">activeEndpoint</a>().</p>
<!-- @@@setActiveEndpoint -->
</div>
<div class="macros">
<h2>Macro Documentation</h2>
<!-- $$$QAudioEndpointSelector_iid[overload1]$$$QAudioEndpointSelector_iid -->
<h3 class="fn"><a name="QAudioEndpointSelector_iid"></a><span class="name">QAudioEndpointSelector_iid</span></h3>
<p><tt>com.nokia.Qt.QAudioEndpointSelector/1.0</tt></p>
<p>Defines the interface name of the <a href="qaudioendpointselector.html">QAudioEndpointSelector</a> class.</p>
<!-- @@@QAudioEndpointSelector_iid -->
</div>
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
  <p>
     <acronym title="Copyright">&copy;</acronym> 2008-2011 Nokia Corporation and/or its
     subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
     in Finland and/or other countries worldwide.</p>
  <p>
     All other trademarks are property of their respective owners. <a title="Privacy Policy"
     href="http://qt.nokia.com/about/privacy-policy">Privacy Policy</a></p>
  <br />
  <p>
    Licensees holding valid Qt Commercial licenses may use this document in accordance with the    Qt Commercial License Agreement provided with the Software or, alternatively, in accordance    with the terms contained in a written agreement between you and Nokia.</p>
  <p>
    Alternatively, this document may be used under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU
    Free Documentation License version 1.3</a>
    as published by the Free Software Foundation.</p>
</div>
</body>
</html>