Sophie

Sophie

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

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" />
<!-- qmediaplaylistcontrol.cpp -->
  <title>Qt Mobility 1.2: QMediaPlaylistControl 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>QMediaPlaylistControl</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="#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">QMediaPlaylistControl Class Reference</h1>
<!-- $$$QMediaPlaylistControl-brief -->
<p>The QMediaPlaylistControl class provides access to the playlist functionality of a <a href="qmediaservice.html">QMediaService</a>. <a href="#details">More...</a></p>
<!-- @@@QMediaPlaylistControl -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QMediaPlaylistControl&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="qmediaplaylistcontrol-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="qmediaplaylistcontrol.html#dtor.QMediaPlaylistControl">~QMediaPlaylistControl</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylistcontrol.html#currentIndex">currentIndex</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylistcontrol.html#next">next</a></b> () = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylistcontrol.html#nextIndex">nextIndex</a></b> ( int <i>step</i> ) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QMediaPlaylist::PlaybackMode </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylistcontrol.html#playbackMode">playbackMode</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QMediaPlaylistProvider * </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylistcontrol.html#playlistProvider">playlistProvider</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylistcontrol.html#previous">previous</a></b> () = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylistcontrol.html#previousIndex">previousIndex</a></b> ( int <i>step</i> ) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylistcontrol.html#setCurrentIndex">setCurrentIndex</a></b> ( int <i>position</i> ) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylistcontrol.html#setPlaybackMode">setPlaybackMode</a></b> ( QMediaPlaylist::PlaybackMode <i>mode</i> ) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylistcontrol.html#setPlaylistProvider">setPlaylistProvider</a></b> ( QMediaPlaylistProvider * <i>playlist</i> ) = 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="signals"></a>
<h2>Signals</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylistcontrol.html#currentIndexChanged">currentIndexChanged</a></b> ( int <i>position</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylistcontrol.html#currentMediaChanged">currentMediaChanged</a></b> ( const QMediaContent &amp; <i>content</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylistcontrol.html#playbackModeChanged">playbackModeChanged</a></b> ( QMediaPlaylist::PlaybackMode <i>mode</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylistcontrol.html#playlistProviderChanged">playlistProviderChanged</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="qmediaplaylistcontrol.html#QMediaPlaylistControl">QMediaPlaylistControl</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="qmediaplaylistcontrol.html#QMediaPlaylistControl_iid">QMediaPlaylistControl_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 slot inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-slots">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>
<!-- $$$QMediaPlaylistControl-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QMediaPlaylistControl class provides access to the playlist functionality of a <a href="qmediaservice.html">QMediaService</a>.</p>
<p>If a <a href="qmediaservice.html">QMediaService</a> contains an internal playlist it will implement QMediaPlaylistControl. This control provides access to the contents of the <a href="qmediaplaylistcontrol.html#playlistProvider">playlist</a>, as well as the <a href="qmediaplaylistcontrol.html#currentIndex">position</a> of the current media, and a means of navigating to the <a href="qmediaplaylistcontrol.html#next">next</a> and <a href="qmediaplaylistcontrol.html#previous">previous</a> media.</p>
<p>The functionality provided by the control is exposed to application code through the <a href="qmediaplaylist.html">QMediaPlaylist</a> class.</p>
<p>The interface name of QMediaPlaylistControl is <tt>com.nokia.Qt.QMediaPlaylistControl/1.0</tt> as defined in <a href="qmediaplaylistcontrol.html#QMediaPlaylistControl_iid">QMediaPlaylistControl_iid</a>.</p>
</div>
<p><b>See also </b><a href="qmediaservice.html#requestControl">QMediaService::requestControl</a>() and <a href="qmediaplayer.html">QMediaPlayer</a>.</p>
<!-- @@@QMediaPlaylistControl -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QMediaPlaylistControl[overload1]$$$QMediaPlaylistControlQObject* -->
<h3 class="fn"><a name="QMediaPlaylistControl"></a>QMediaPlaylistControl::<span class="name">QMediaPlaylistControl</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>Create a new playlist control object with the given <i>parent</i>.</p>
<!-- @@@QMediaPlaylistControl -->
<!-- $$$~QMediaPlaylistControl[overload1]$$$~QMediaPlaylistControl -->
<h3 class="fn"><a name="dtor.QMediaPlaylistControl"></a>QMediaPlaylistControl::<span class="name">~QMediaPlaylistControl</span> ()<tt> [virtual]</tt></h3>
<p>Destroys the playlist control.</p>
<!-- @@@~QMediaPlaylistControl -->
<!-- $$$currentIndex[overload1]$$$currentIndex -->
<h3 class="fn"><a name="currentIndex"></a><span class="type">int</span> QMediaPlaylistControl::<span class="name">currentIndex</span> () const<tt> [pure virtual]</tt></h3>
<p>Returns position of the current media source in the playlist.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmediaplaylistcontrol.html#setCurrentIndex">setCurrentIndex</a>().</p>
<!-- @@@currentIndex -->
<!-- $$$currentIndexChanged[overload1]$$$currentIndexChangedint -->
<h3 class="fn"><a name="currentIndexChanged"></a><span class="type">void</span> QMediaPlaylistControl::<span class="name">currentIndexChanged</span> ( <span class="type">int</span> <i>position</i> )<tt> [signal]</tt></h3>
<p>Signal emitted when the playlist <i>position</i> is changed.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@currentIndexChanged -->
<!-- $$$currentMediaChanged[overload1]$$$currentMediaChangedconstQMediaContent& -->
<h3 class="fn"><a name="currentMediaChanged"></a><span class="type">void</span> QMediaPlaylistControl::<span class="name">currentMediaChanged</span> ( const <span class="type"><a href="qmediacontent.html">QMediaContent</a></span> &amp; <i>content</i> )<tt> [signal]</tt></h3>
<p>Signal emitted when current media changes to <i>content</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@currentMediaChanged -->
<!-- $$$next[overload1]$$$next -->
<h3 class="fn"><a name="next"></a><span class="type">void</span> QMediaPlaylistControl::<span class="name">next</span> ()<tt> [pure virtual]</tt></h3>
<p>Moves to the next item in playlist.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@next -->
<!-- $$$nextIndex[overload1]$$$nextIndexint -->
<h3 class="fn"><a name="nextIndex"></a><span class="type">int</span> QMediaPlaylistControl::<span class="name">nextIndex</span> ( <span class="type">int</span> <i>step</i> ) const<tt> [pure virtual]</tt></h3>
<p>Returns the index of item, which were current after calling <a href="qmediaplaylistcontrol.html#next">next</a>() <i>step</i> times.</p>
<p>Returned value depends on the size of playlist, current position and playback mode.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmediaplaylist.html#playbackMode-prop">QMediaPlaylist::playbackMode</a>.</p>
<!-- @@@nextIndex -->
<!-- $$$playbackMode[overload1]$$$playbackMode -->
<h3 class="fn"><a name="playbackMode"></a><span class="type"><a href="qmediaplaylist.html#PlaybackMode-enum">QMediaPlaylist::PlaybackMode</a></span> QMediaPlaylistControl::<span class="name">playbackMode</span> () const<tt> [pure virtual]</tt></h3>
<p>Returns the playlist navigation mode.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmediaplaylistcontrol.html#setPlaybackMode">setPlaybackMode</a>() and <a href="qmediaplaylist.html#PlaybackMode-enum">QMediaPlaylist::PlaybackMode</a>.</p>
<!-- @@@playbackMode -->
<!-- $$$playbackModeChanged[overload1]$$$playbackModeChangedQMediaPlaylist::PlaybackMode -->
<h3 class="fn"><a name="playbackModeChanged"></a><span class="type">void</span> QMediaPlaylistControl::<span class="name">playbackModeChanged</span> ( <span class="type"><a href="qmediaplaylist.html#PlaybackMode-enum">QMediaPlaylist::PlaybackMode</a></span> <i>mode</i> )<tt> [signal]</tt></h3>
<p>Signal emitted when the playback <i>mode</i> is changed.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@playbackModeChanged -->
<!-- $$$playlistProvider[overload1]$$$playlistProvider -->
<h3 class="fn"><a name="playlistProvider"></a><span class="type"><a href="qmediaplaylistprovider.html">QMediaPlaylistProvider</a></span> * QMediaPlaylistControl::<span class="name">playlistProvider</span> () const<tt> [pure virtual]</tt></h3>
<p>Returns the playlist used by this media player.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmediaplaylistcontrol.html#setPlaylistProvider">setPlaylistProvider</a>().</p>
<!-- @@@playlistProvider -->
<!-- $$$playlistProviderChanged[overload1]$$$playlistProviderChanged -->
<h3 class="fn"><a name="playlistProviderChanged"></a><span class="type">void</span> QMediaPlaylistControl::<span class="name">playlistProviderChanged</span> ()<tt> [signal]</tt></h3>
<p>Signal emitted when the playlist provider has changed.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@playlistProviderChanged -->
<!-- $$$previous[overload1]$$$previous -->
<h3 class="fn"><a name="previous"></a><span class="type">void</span> QMediaPlaylistControl::<span class="name">previous</span> ()<tt> [pure virtual]</tt></h3>
<p>Returns to the previous item in playlist.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@previous -->
<!-- $$$previousIndex[overload1]$$$previousIndexint -->
<h3 class="fn"><a name="previousIndex"></a><span class="type">int</span> QMediaPlaylistControl::<span class="name">previousIndex</span> ( <span class="type">int</span> <i>step</i> ) const<tt> [pure virtual]</tt></h3>
<p>Returns the index of item, which were current after calling <a href="qmediaplaylistcontrol.html#previous">previous</a>() <i>step</i> times.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmediaplaylist.html#playbackMode-prop">QMediaPlaylist::playbackMode</a>.</p>
<!-- @@@previousIndex -->
<!-- $$$setCurrentIndex[overload1]$$$setCurrentIndexint -->
<h3 class="fn"><a name="setCurrentIndex"></a><span class="type">void</span> QMediaPlaylistControl::<span class="name">setCurrentIndex</span> ( <span class="type">int</span> <i>position</i> )<tt> [pure virtual]</tt></h3>
<p>Jump to the item at the given <i>position</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmediaplaylistcontrol.html#currentIndex">currentIndex</a>().</p>
<!-- @@@setCurrentIndex -->
<!-- $$$setPlaybackMode[overload1]$$$setPlaybackModeQMediaPlaylist::PlaybackMode -->
<h3 class="fn"><a name="setPlaybackMode"></a><span class="type">void</span> QMediaPlaylistControl::<span class="name">setPlaybackMode</span> ( <span class="type"><a href="qmediaplaylist.html#PlaybackMode-enum">QMediaPlaylist::PlaybackMode</a></span> <i>mode</i> )<tt> [pure virtual]</tt></h3>
<p>Sets the playback <i>mode</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmediaplaylistcontrol.html#playbackMode">playbackMode</a>() and <a href="qmediaplaylist.html#PlaybackMode-enum">QMediaPlaylist::PlaybackMode</a>.</p>
<!-- @@@setPlaybackMode -->
<!-- $$$setPlaylistProvider[overload1]$$$setPlaylistProviderQMediaPlaylistProvider* -->
<h3 class="fn"><a name="setPlaylistProvider"></a><span class="type">bool</span> QMediaPlaylistControl::<span class="name">setPlaylistProvider</span> ( <span class="type"><a href="qmediaplaylistprovider.html">QMediaPlaylistProvider</a></span> * <i>playlist</i> )<tt> [pure virtual]</tt></h3>
<p>Set the playlist of this media player to <i>playlist</i>.</p>
<p>In many cases it is possible just to use the playlist constructed by player, but sometimes replacing the whole playlist allows to avoid copyting of all the items bettween playlists.</p>
<p>Returns true if player can use this passed playlist; otherwise returns false.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmediaplaylistcontrol.html#playlistProvider">playlistProvider</a>().</p>
<!-- @@@setPlaylistProvider -->
</div>
<div class="macros">
<h2>Macro Documentation</h2>
<!-- $$$QMediaPlaylistControl_iid[overload1]$$$QMediaPlaylistControl_iid -->
<h3 class="fn"><a name="QMediaPlaylistControl_iid"></a><span class="name">QMediaPlaylistControl_iid</span></h3>
<p><tt>com.nokia.Qt.QMediaPlaylistControl/1.0</tt></p>
<p>Defines the interface name of the <a href="qmediaplaylistcontrol.html">QMediaPlaylistControl</a> class.</p>
<!-- @@@QMediaPlaylistControl_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>