<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qmediaplaylist.cpp -->
<title>QMediaPlaylist Class | Qt Multimedia 5.9</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.9</td><td ><a href="qtmultimedia-index.html">Qt Multimedia</a></td><td ><a href="qtmultimedia-modules.html">C++ Classes</a></td><td >QMediaPlaylist</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#reimplemented-public-functions">Reimplemented 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="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QMediaPlaylist Class</h1>
<!-- $$$QMediaPlaylist-brief -->
<p>The <a href="qmediaplaylist.html">QMediaPlaylist</a> class provides a list of media content to play. <a href="#details">More...</a></p>
<!-- @@@QMediaPlaylist -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QMediaPlaylist></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += multimedia</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qmediabindableinterface.html">QMediaBindableInterface</a> and </td></tr></table></div><ul>
<li><a href="qmediaplaylist-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2 id="public-types">Public Types</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#Error-enum">Error</a></b> { NoError, FormatError, FormatNotSupportedError, NetworkError, AccessDeniedError }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#PlaybackMode-enum">PlaybackMode</a></b> { CurrentItemOnce, CurrentItemInLoop, Sequential, Loop, Random }</td></tr>
</table></div>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><a href="qmediaplaylist.html#currentIndex-prop">currentIndex</a></b> : int</li>
<li class="fn"><b><a href="qmediaplaylist.html#currentMedia-prop">currentMedia</a></b> : const QMediaContent</li>
<li class="fn"><b><a href="qmediaplaylist.html#playbackMode-prop">playbackMode</a></b> : QMediaPlaylist::PlaybackMode</li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#QMediaPlaylist">QMediaPlaylist</a></b>(QObject *<i>parent</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#dtor.QMediaPlaylist">~QMediaPlaylist</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#addMedia">addMedia</a></b>(const QMediaContent &<i>content</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#addMedia-1">addMedia</a></b>(const QList<QMediaContent> &<i>items</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#clear">clear</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#currentIndex">currentIndex</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMediaContent </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#currentMedia">currentMedia</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Error </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#error">error</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#errorString">errorString</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#insertMedia">insertMedia</a></b>(int <i>pos</i>, const QMediaContent &<i>content</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#insertMedia-1">insertMedia</a></b>(int <i>pos</i>, const QList<QMediaContent> &<i>items</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#isEmpty">isEmpty</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#isReadOnly">isReadOnly</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#load">load</a></b>(const QNetworkRequest &<i>request</i>, const char *<i>format</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#load-1">load</a></b>(const QUrl &<i>location</i>, const char *<i>format</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#load-2">load</a></b>(QIODevice *<i>device</i>, const char *<i>format</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMediaContent </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#media">media</a></b>(int <i>index</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#mediaCount">mediaCount</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#moveMedia">moveMedia</a></b>(int <i>from</i>, int <i>to</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#nextIndex">nextIndex</a></b>(int <i>steps</i> = 1) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> PlaybackMode </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#playbackMode-prop">playbackMode</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#previousIndex">previousIndex</a></b>(int <i>steps</i> = 1) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#removeMedia">removeMedia</a></b>(int <i>pos</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#removeMedia-1">removeMedia</a></b>(int <i>start</i>, int <i>end</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#save">save</a></b>(const QUrl &<i>location</i>, const char *<i>format</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#save-1">save</a></b>(QIODevice *<i>device</i>, const char *<i>format</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#playbackMode-prop">setPlaybackMode</a></b>(PlaybackMode <i>mode</i>)</td></tr>
</table></div>
<a name="reimplemented-public-functions"></a>
<h2 id="reimplemented-public-functions">Reimplemented Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual QMediaObject *</td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#mediaObject">mediaObject</a></b>() const override</td></tr>
</table></div>
<ul>
<li class="fn">1 public function inherited from <a href="qmediabindableinterface.html#public-functions">QMediaBindableInterface</a></li>
</ul>
<a name="public-slots"></a>
<h2 id="public-slots">Public Slots</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#next">next</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#previous">previous</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#setCurrentIndex">setCurrentIndex</a></b>(int <i>playlistPosition</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#shuffle">shuffle</a></b>()</td></tr>
</table></div>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.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="qmediaplaylist.html#currentMediaChanged">currentMediaChanged</a></b>(const QMediaContent &<i>content</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#loadFailed">loadFailed</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#loaded">loaded</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#mediaAboutToBeInserted">mediaAboutToBeInserted</a></b>(int <i>start</i>, int <i>end</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#mediaAboutToBeRemoved">mediaAboutToBeRemoved</a></b>(int <i>start</i>, int <i>end</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#mediaChanged">mediaChanged</a></b>(int <i>start</i>, int <i>end</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#mediaInserted">mediaInserted</a></b>(int <i>start</i>, int <i>end</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#mediaRemoved">mediaRemoved</a></b>(int <i>start</i>, int <i>end</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaplaylist.html#playbackModeChanged">playbackModeChanged</a></b>(QMediaPlaylist::PlaybackMode <i>mode</i>)</td></tr>
</table></div>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 protected function inherited from <a href="qmediabindableinterface.html#protected-functions">QMediaBindableInterface</a></li>
</ul>
<a name="details"></a>
<!-- $$$QMediaPlaylist-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qmediaplaylist.html">QMediaPlaylist</a> class provides a list of media content to play.</p>
<p><a href="qmediaplaylist.html">QMediaPlaylist</a> is intended to be used with other media objects, like <a href="qmediaplayer.html">QMediaPlayer</a>.</p>
<p><a href="qmediaplaylist.html">QMediaPlaylist</a> allows to access the service intrinsic playlist functionality if available, otherwise it provides the local memory playlist implementation.</p>
<pre class="cpp">
playlist <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qmediaplaylist.html#QMediaPlaylist">QMediaPlaylist</a></span>;
playlist<span class="operator">-</span><span class="operator">></span>addMedia(<span class="type">QUrl</span>(<span class="string">"http://example.com/movie1.mp4"</span>));
playlist<span class="operator">-</span><span class="operator">></span>addMedia(<span class="type">QUrl</span>(<span class="string">"http://example.com/movie2.mp4"</span>));
playlist<span class="operator">-</span><span class="operator">></span>addMedia(<span class="type">QUrl</span>(<span class="string">"http://example.com/movie3.mp4"</span>));
playlist<span class="operator">-</span><span class="operator">></span>setCurrentIndex(<span class="number">1</span>);
player <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qmediaplayer.html">QMediaPlayer</a></span>;
player<span class="operator">-</span><span class="operator">></span>setPlaylist(playlist);
videoWidget <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qvideowidget.html">QVideoWidget</a></span>;
player<span class="operator">-</span><span class="operator">></span>setVideoOutput(videoWidget);
videoWidget<span class="operator">-</span><span class="operator">></span>show();
player<span class="operator">-</span><span class="operator">></span>play();
</pre>
<p>Depending on playlist source implementation, most of the playlist mutating operations can be asynchronous.</p>
</div>
<p><b>See also </b><a href="qmediacontent.html">QMediaContent</a>.</p>
<!-- @@@QMediaPlaylist -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$Error$$$NoError$$$FormatError$$$FormatNotSupportedError$$$NetworkError$$$AccessDeniedError -->
<h3 class="fn" id="Error-enum"><a name="Error-enum"></a>enum QMediaPlaylist::<span class="name">Error</span></h3>
<p>This enum describes the <a href="qmediaplaylist.html">QMediaPlaylist</a> error codes.</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QMediaPlaylist::NoError</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">No errors.</td></tr>
<tr><td class="topAlign"><code>QMediaPlaylist::FormatError</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">Format error.</td></tr>
<tr><td class="topAlign"><code>QMediaPlaylist::FormatNotSupportedError</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">Format not supported.</td></tr>
<tr><td class="topAlign"><code>QMediaPlaylist::NetworkError</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">Network error.</td></tr>
<tr><td class="topAlign"><code>QMediaPlaylist::AccessDeniedError</code></td><td class="topAlign tblval"><code>4</code></td><td class="topAlign">Access denied error.</td></tr>
</table></div>
<!-- @@@Error -->
<!-- $$$PlaybackMode$$$CurrentItemOnce$$$CurrentItemInLoop$$$Sequential$$$Loop$$$Random -->
<h3 class="fn" id="PlaybackMode-enum"><a name="PlaybackMode-enum"></a>enum QMediaPlaylist::<span class="name">PlaybackMode</span></h3>
<p>The QMediaPlaylist::PlaybackMode describes the order items in playlist are played.</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QMediaPlaylist::CurrentItemOnce</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">The current item is played only once.</td></tr>
<tr><td class="topAlign"><code>QMediaPlaylist::CurrentItemInLoop</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">The current item is played repeatedly in a loop.</td></tr>
<tr><td class="topAlign"><code>QMediaPlaylist::Sequential</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">Playback starts from the current and moves through each successive item until the last is reached and then stops. The next item is a null item when the last one is currently playing.</td></tr>
<tr><td class="topAlign"><code>QMediaPlaylist::Loop</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">Playback restarts at the first item after the last has finished playing.</td></tr>
<tr><td class="topAlign"><code>QMediaPlaylist::Random</code></td><td class="topAlign tblval"><code>4</code></td><td class="topAlign">Play items in random order.</td></tr>
</table></div>
<!-- @@@PlaybackMode -->
</div>
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$currentIndex-prop$$$currentIndex$$$setCurrentIndexint$$$currentIndexChangedint -->
<h3 class="fn" id="currentIndex-prop"><a name="currentIndex-prop"></a><span class="name">currentIndex</span> : <span class="type">int</span></h3>
<p>Current position.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qmediaplaylist.html#currentIndex">currentIndex</a></b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qmediaplaylist.html#setCurrentIndex">setCurrentIndex</a></b></span>(int <i>playlistPosition</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qmediaplaylist.html#currentIndexChanged">currentIndexChanged</a></b></span>(int <i>position</i>)</td></tr>
</table></div>
<!-- @@@currentIndex -->
<!-- $$$currentMedia-prop$$$currentMedia$$$currentMediaChangedconstQMediaContent& -->
<h3 class="fn" id="currentMedia-prop"><a name="currentMedia-prop"></a><span class="name">currentMedia</span> : const <span class="type"><a href="qmediacontent.html">QMediaContent</a></span></h3>
<p>Current media content.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QMediaContent </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qmediaplaylist.html#currentMedia">currentMedia</a></b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qmediaplaylist.html#currentMediaChanged">currentMediaChanged</a></b></span>(const QMediaContent &<i>content</i>)</td></tr>
</table></div>
<!-- @@@currentMedia -->
<!-- $$$playbackMode-prop$$$playbackMode$$$setPlaybackModePlaybackMode$$$playbackModeChangedQMediaPlaylist::PlaybackMode -->
<h3 class="fn" id="playbackMode-prop"><a name="playbackMode-prop"></a><span class="name">playbackMode</span> : <span class="type"><a href="qmediaplaylist.html#PlaybackMode-enum">QMediaPlaylist::PlaybackMode</a></span></h3>
<p>This property defines the order that items in the playlist are played.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> PlaybackMode </td><td class="memItemRight bottomAlign"><span class="name"><b>playbackMode</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setPlaybackMode</b></span>(PlaybackMode <i>mode</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qmediaplaylist.html#playbackModeChanged">playbackModeChanged</a></b></span>(QMediaPlaylist::PlaybackMode <i>mode</i>)</td></tr>
</table></div>
<p><b>See also </b><a href="qmediaplaylist.html#PlaybackMode-enum">QMediaPlaylist::PlaybackMode</a>.</p>
<!-- @@@playbackMode -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QMediaPlaylist[overload1]$$$QMediaPlaylistQObject* -->
<h3 class="fn" id="QMediaPlaylist"><a name="QMediaPlaylist"></a>QMediaPlaylist::<span class="name">QMediaPlaylist</span>(<span class="type">QObject</span> *<i>parent</i> = Q_NULLPTR)</h3>
<p>Create a new playlist object with the given <i>parent</i>.</p>
<!-- @@@QMediaPlaylist -->
<!-- $$$~QMediaPlaylist[overload1]$$$~QMediaPlaylist -->
<h3 class="fn" id="dtor.QMediaPlaylist"><a name="dtor.QMediaPlaylist"></a><code>[virtual] </code>QMediaPlaylist::<span class="name">~QMediaPlaylist</span>()</h3>
<p>Destroys the playlist.</p>
<!-- @@@~QMediaPlaylist -->
<!-- $$$addMedia[overload1]$$$addMediaconstQMediaContent& -->
<h3 class="fn" id="addMedia"><a name="addMedia"></a><span class="type">bool</span> QMediaPlaylist::<span class="name">addMedia</span>(const <span class="type"><a href="qmediacontent.html">QMediaContent</a></span> &<i>content</i>)</h3>
<p>Append the media <i>content</i> to the playlist.</p>
<p>Returns true if the operation is successful, otherwise returns false.</p>
<!-- @@@addMedia -->
<!-- $$$addMedia$$$addMediaconstQList<QMediaContent>& -->
<h3 class="fn" id="addMedia-1"><a name="addMedia-1"></a><span class="type">bool</span> QMediaPlaylist::<span class="name">addMedia</span>(const <span class="type">QList</span><<span class="type"><a href="qmediacontent.html">QMediaContent</a></span>> &<i>items</i>)</h3>
<p>Append multiple media content <i>items</i> to the playlist.</p>
<p>Returns true if the operation is successful, otherwise returns false.</p>
<!-- @@@addMedia -->
<!-- $$$clear[overload1]$$$clear -->
<h3 class="fn" id="clear"><a name="clear"></a><span class="type">bool</span> QMediaPlaylist::<span class="name">clear</span>()</h3>
<p>Remove all the items from the playlist.</p>
<p>Returns true if the operation is successful, otherwise return false.</p>
<!-- @@@clear -->
<!-- $$$currentIndex -->
<h3 class="fn" id="currentIndex"><a name="currentIndex"></a><span class="type">int</span> QMediaPlaylist::<span class="name">currentIndex</span>() const</h3>
<p>Returns position of the current media content in the playlist.</p>
<p><b>Note:</b> Getter function for property <a href="qmediaplaylist.html#currentIndex-prop">currentIndex</a>. </p><p><b>See also </b><a href="qmediaplaylist.html#setCurrentIndex">setCurrentIndex</a>().</p>
<!-- @@@currentIndex -->
<!-- $$$currentIndexChanged -->
<h3 class="fn" id="currentIndexChanged"><a name="currentIndexChanged"></a><code>[signal] </code><span class="type">void</span> QMediaPlaylist::<span class="name">currentIndexChanged</span>(<span class="type">int</span> <i>position</i>)</h3>
<p>Signal emitted when playlist position changed to <i>position</i>.</p>
<p><b>Note:</b> Notifier signal for property <a href="qmediaplaylist.html#currentIndex-prop">currentIndex</a>. </p><!-- @@@currentIndexChanged -->
<!-- $$$currentMedia -->
<h3 class="fn" id="currentMedia"><a name="currentMedia"></a><span class="type"><a href="qmediacontent.html">QMediaContent</a></span> QMediaPlaylist::<span class="name">currentMedia</span>() const</h3>
<p>Returns the current media content.</p>
<p><b>Note:</b> Getter function for property <a href="qmediaplaylist.html#currentMedia-prop">currentMedia</a>. </p><!-- @@@currentMedia -->
<!-- $$$currentMediaChanged -->
<h3 class="fn" id="currentMediaChanged"><a name="currentMediaChanged"></a><code>[signal] </code><span class="type">void</span> QMediaPlaylist::<span class="name">currentMediaChanged</span>(const <span class="type"><a href="qmediacontent.html">QMediaContent</a></span> &<i>content</i>)</h3>
<p>Signal emitted when current media changes to <i>content</i>.</p>
<p><b>Note:</b> Notifier signal for property <a href="qmediaplaylist.html#currentMedia-prop">currentMedia</a>. </p><!-- @@@currentMediaChanged -->
<!-- $$$error[overload1]$$$error -->
<h3 class="fn" id="error"><a name="error"></a><span class="type"><a href="qmediaplaylist.html#Error-enum">Error</a></span> QMediaPlaylist::<span class="name">error</span>() const</h3>
<p>Returns the last error condition.</p>
<!-- @@@error -->
<!-- $$$errorString[overload1]$$$errorString -->
<h3 class="fn" id="errorString"><a name="errorString"></a><span class="type">QString</span> QMediaPlaylist::<span class="name">errorString</span>() const</h3>
<p>Returns the string describing the last error condition.</p>
<!-- @@@errorString -->
<!-- $$$insertMedia[overload1]$$$insertMediaintconstQMediaContent& -->
<h3 class="fn" id="insertMedia"><a name="insertMedia"></a><span class="type">bool</span> QMediaPlaylist::<span class="name">insertMedia</span>(<span class="type">int</span> <i>pos</i>, const <span class="type"><a href="qmediacontent.html">QMediaContent</a></span> &<i>content</i>)</h3>
<p>Insert the media <i>content</i> to the playlist at position <i>pos</i>.</p>
<p>Returns true if the operation is successful, otherwise returns false.</p>
<!-- @@@insertMedia -->
<!-- $$$insertMedia$$$insertMediaintconstQList<QMediaContent>& -->
<h3 class="fn" id="insertMedia-1"><a name="insertMedia-1"></a><span class="type">bool</span> QMediaPlaylist::<span class="name">insertMedia</span>(<span class="type">int</span> <i>pos</i>, const <span class="type">QList</span><<span class="type"><a href="qmediacontent.html">QMediaContent</a></span>> &<i>items</i>)</h3>
<p>Insert multiple media content <i>items</i> to the playlist at position <i>pos</i>.</p>
<p>Returns true if the operation is successful, otherwise returns false.</p>
<!-- @@@insertMedia -->
<!-- $$$isEmpty[overload1]$$$isEmpty -->
<h3 class="fn" id="isEmpty"><a name="isEmpty"></a><span class="type">bool</span> QMediaPlaylist::<span class="name">isEmpty</span>() const</h3>
<p>Returns true if the playlist contains no items, otherwise returns false.</p>
<p><b>See also </b><a href="qmediaplaylist.html#mediaCount">mediaCount</a>().</p>
<!-- @@@isEmpty -->
<!-- $$$isReadOnly[overload1]$$$isReadOnly -->
<h3 class="fn" id="isReadOnly"><a name="isReadOnly"></a><span class="type">bool</span> QMediaPlaylist::<span class="name">isReadOnly</span>() const</h3>
<p>Returns true if the playlist can be modified, otherwise returns false.</p>
<p><b>See also </b><a href="qmediaplaylist.html#mediaCount">mediaCount</a>().</p>
<!-- @@@isReadOnly -->
<!-- $$$load[overload1]$$$loadconstQNetworkRequest&constchar* -->
<h3 class="fn" id="load"><a name="load"></a><span class="type">void</span> QMediaPlaylist::<span class="name">load</span>(const <span class="type">QNetworkRequest</span> &<i>request</i>, const <span class="type">char</span> *<i>format</i> = Q_NULLPTR)</h3>
<p>Load playlist using network <i>request</i>. If <i>format</i> is specified, it is used, otherwise format is guessed from playlist name and data.</p>
<p>New items are appended to playlist.</p>
<p><a href="qmediaplaylist.html#loaded">QMediaPlaylist::loaded</a>() signal is emitted if playlist was loaded successfully, otherwise the playlist emits <a href="qmediaplaylist.html#loadFailed">loadFailed</a>().</p>
<!-- @@@load -->
<!-- $$$load$$$loadconstQUrl&constchar* -->
<h3 class="fn" id="load-1"><a name="load-1"></a><span class="type">void</span> QMediaPlaylist::<span class="name">load</span>(const <span class="type">QUrl</span> &<i>location</i>, const <span class="type">char</span> *<i>format</i> = Q_NULLPTR)</h3>
<p>Load playlist from <i>location</i>. If <i>format</i> is specified, it is used, otherwise format is guessed from location name and data.</p>
<p>New items are appended to playlist.</p>
<p><a href="qmediaplaylist.html#loaded">QMediaPlaylist::loaded</a>() signal is emitted if playlist was loaded successfully, otherwise the playlist emits <a href="qmediaplaylist.html#loadFailed">loadFailed</a>().</p>
<!-- @@@load -->
<!-- $$$load$$$loadQIODevice*constchar* -->
<h3 class="fn" id="load-2"><a name="load-2"></a><span class="type">void</span> QMediaPlaylist::<span class="name">load</span>(<span class="type">QIODevice</span> *<i>device</i>, const <span class="type">char</span> *<i>format</i> = Q_NULLPTR)</h3>
<p>Load playlist from QIODevice <i>device</i>. If <i>format</i> is specified, it is used, otherwise format is guessed from device data.</p>
<p>New items are appended to playlist.</p>
<p><a href="qmediaplaylist.html#loaded">QMediaPlaylist::loaded</a>() signal is emitted if playlist was loaded successfully, otherwise the playlist emits <a href="qmediaplaylist.html#loadFailed">loadFailed</a>().</p>
<!-- @@@load -->
<!-- $$$loadFailed[overload1]$$$loadFailed -->
<h3 class="fn" id="loadFailed"><a name="loadFailed"></a><code>[signal] </code><span class="type">void</span> QMediaPlaylist::<span class="name">loadFailed</span>()</h3>
<p>Signal emitted if failed to load playlist.</p>
<!-- @@@loadFailed -->
<!-- $$$loaded[overload1]$$$loaded -->
<h3 class="fn" id="loaded"><a name="loaded"></a><code>[signal] </code><span class="type">void</span> QMediaPlaylist::<span class="name">loaded</span>()</h3>
<p>Signal emitted when playlist finished loading.</p>
<!-- @@@loaded -->
<!-- $$$media[overload1]$$$mediaint -->
<h3 class="fn" id="media"><a name="media"></a><span class="type"><a href="qmediacontent.html">QMediaContent</a></span> QMediaPlaylist::<span class="name">media</span>(<span class="type">int</span> <i>index</i>) const</h3>
<p>Returns the media content at <i>index</i> in the playlist.</p>
<!-- @@@media -->
<!-- $$$mediaAboutToBeInserted[overload1]$$$mediaAboutToBeInsertedintint -->
<h3 class="fn" id="mediaAboutToBeInserted"><a name="mediaAboutToBeInserted"></a><code>[signal] </code><span class="type">void</span> QMediaPlaylist::<span class="name">mediaAboutToBeInserted</span>(<span class="type">int</span> <i>start</i>, <span class="type">int</span> <i>end</i>)</h3>
<p>Signal emitted when items are to be inserted at <i>start</i> and ending at <i>end</i>.</p>
<!-- @@@mediaAboutToBeInserted -->
<!-- $$$mediaAboutToBeRemoved[overload1]$$$mediaAboutToBeRemovedintint -->
<h3 class="fn" id="mediaAboutToBeRemoved"><a name="mediaAboutToBeRemoved"></a><code>[signal] </code><span class="type">void</span> QMediaPlaylist::<span class="name">mediaAboutToBeRemoved</span>(<span class="type">int</span> <i>start</i>, <span class="type">int</span> <i>end</i>)</h3>
<p>Signal emitted when item are to be deleted at <i>start</i> and ending at <i>end</i>.</p>
<!-- @@@mediaAboutToBeRemoved -->
<!-- $$$mediaChanged[overload1]$$$mediaChangedintint -->
<h3 class="fn" id="mediaChanged"><a name="mediaChanged"></a><code>[signal] </code><span class="type">void</span> QMediaPlaylist::<span class="name">mediaChanged</span>(<span class="type">int</span> <i>start</i>, <span class="type">int</span> <i>end</i>)</h3>
<p>This signal is emitted after media has been changed in the playlist between <i>start</i> and <i>end</i> positions inclusive.</p>
<!-- @@@mediaChanged -->
<!-- $$$mediaCount[overload1]$$$mediaCount -->
<h3 class="fn" id="mediaCount"><a name="mediaCount"></a><span class="type">int</span> QMediaPlaylist::<span class="name">mediaCount</span>() const</h3>
<p>Returns the number of items in the playlist.</p>
<p><b>See also </b><a href="qmediaplaylist.html#isEmpty">isEmpty</a>().</p>
<!-- @@@mediaCount -->
<!-- $$$mediaInserted[overload1]$$$mediaInsertedintint -->
<h3 class="fn" id="mediaInserted"><a name="mediaInserted"></a><code>[signal] </code><span class="type">void</span> QMediaPlaylist::<span class="name">mediaInserted</span>(<span class="type">int</span> <i>start</i>, <span class="type">int</span> <i>end</i>)</h3>
<p>This signal is emitted after media has been inserted into the playlist. The new items are those between <i>start</i> and <i>end</i> inclusive.</p>
<!-- @@@mediaInserted -->
<!-- $$$mediaObject[overload1]$$$mediaObject -->
<h3 class="fn" id="mediaObject"><a name="mediaObject"></a><code>[override virtual] </code><span class="type"><a href="qmediaobject.html">QMediaObject</a></span> *QMediaPlaylist::<span class="name">mediaObject</span>() const</h3>
<p>Reimplemented from <a href="qmediabindableinterface.html#mediaObject">QMediaBindableInterface::mediaObject</a>().</p>
<p>Returns the <a href="qmediaobject.html">QMediaObject</a> instance that this <a href="qmediaplaylist.html">QMediaPlaylist</a> is bound too, or 0 otherwise.</p>
<!-- @@@mediaObject -->
<!-- $$$mediaRemoved[overload1]$$$mediaRemovedintint -->
<h3 class="fn" id="mediaRemoved"><a name="mediaRemoved"></a><code>[signal] </code><span class="type">void</span> QMediaPlaylist::<span class="name">mediaRemoved</span>(<span class="type">int</span> <i>start</i>, <span class="type">int</span> <i>end</i>)</h3>
<p>This signal is emitted after media has been removed from the playlist. The removed items are those between <i>start</i> and <i>end</i> inclusive.</p>
<!-- @@@mediaRemoved -->
<!-- $$$moveMedia[overload1]$$$moveMediaintint -->
<h3 class="fn" id="moveMedia"><a name="moveMedia"></a><span class="type">bool</span> QMediaPlaylist::<span class="name">moveMedia</span>(<span class="type">int</span> <i>from</i>, <span class="type">int</span> <i>to</i>)</h3>
<p>Move the item from position <i>from</i> to position <i>to</i>.</p>
<p>Returns true if the operation is successful, otherwise false.</p>
<p>This function was introduced in Qt 5.7.</p>
<!-- @@@moveMedia -->
<!-- $$$next[overload1]$$$next -->
<h3 class="fn" id="next"><a name="next"></a><code>[slot] </code><span class="type">void</span> QMediaPlaylist::<span class="name">next</span>()</h3>
<p>Advance to the next media content in playlist.</p>
<!-- @@@next -->
<!-- $$$nextIndex[overload1]$$$nextIndexint -->
<h3 class="fn" id="nextIndex"><a name="nextIndex"></a><span class="type">int</span> QMediaPlaylist::<span class="name">nextIndex</span>(<span class="type">int</span> <i>steps</i> = 1) const</h3>
<p>Returns the index of the item, which would be current after calling <a href="qmediaplaylist.html#next">next</a>() <i>steps</i> times.</p>
<p>Returned value depends on the size of playlist, current position and playback mode.</p>
<p><b>See also </b><a href="qmediaplaylist.html#playbackMode-prop">QMediaPlaylist::playbackMode</a>() and <a href="qmediaplaylist.html#previousIndex">previousIndex</a>().</p>
<!-- @@@nextIndex -->
<!-- $$$playbackModeChanged -->
<h3 class="fn" id="playbackModeChanged"><a name="playbackModeChanged"></a><code>[signal] </code><span class="type">void</span> QMediaPlaylist::<span class="name">playbackModeChanged</span>(<span class="type"><a href="qmediaplaylist.html#PlaybackMode-enum">QMediaPlaylist::PlaybackMode</a></span> <i>mode</i>)</h3>
<p>Signal emitted when playback mode changed to <i>mode</i>.</p>
<p><b>Note:</b> Notifier signal for property <a href="qmediaplaylist.html#playbackMode-prop">playbackMode</a>. </p><!-- @@@playbackModeChanged -->
<!-- $$$previous[overload1]$$$previous -->
<h3 class="fn" id="previous"><a name="previous"></a><code>[slot] </code><span class="type">void</span> QMediaPlaylist::<span class="name">previous</span>()</h3>
<p>Return to the previous media content in playlist.</p>
<!-- @@@previous -->
<!-- $$$previousIndex[overload1]$$$previousIndexint -->
<h3 class="fn" id="previousIndex"><a name="previousIndex"></a><span class="type">int</span> QMediaPlaylist::<span class="name">previousIndex</span>(<span class="type">int</span> <i>steps</i> = 1) const</h3>
<p>Returns the index of the item, which would be current after calling <a href="qmediaplaylist.html#previous">previous</a>() <i>steps</i> times.</p>
<p><b>See also </b><a href="qmediaplaylist.html#playbackMode-prop">QMediaPlaylist::playbackMode</a>() and <a href="qmediaplaylist.html#nextIndex">nextIndex</a>().</p>
<!-- @@@previousIndex -->
<!-- $$$removeMedia[overload1]$$$removeMediaint -->
<h3 class="fn" id="removeMedia"><a name="removeMedia"></a><span class="type">bool</span> QMediaPlaylist::<span class="name">removeMedia</span>(<span class="type">int</span> <i>pos</i>)</h3>
<p>Remove the item from the playlist at position <i>pos</i>.</p>
<p>Returns true if the operation is successful, otherwise return false.</p>
<!-- @@@removeMedia -->
<!-- $$$removeMedia$$$removeMediaintint -->
<h3 class="fn" id="removeMedia-1"><a name="removeMedia-1"></a><span class="type">bool</span> QMediaPlaylist::<span class="name">removeMedia</span>(<span class="type">int</span> <i>start</i>, <span class="type">int</span> <i>end</i>)</h3>
<p>Remove items in the playlist from <i>start</i> to <i>end</i> inclusive.</p>
<p>Returns true if the operation is successful, otherwise return false.</p>
<!-- @@@removeMedia -->
<!-- $$$save[overload1]$$$saveconstQUrl&constchar* -->
<h3 class="fn" id="save"><a name="save"></a><span class="type">bool</span> QMediaPlaylist::<span class="name">save</span>(const <span class="type">QUrl</span> &<i>location</i>, const <span class="type">char</span> *<i>format</i> = Q_NULLPTR)</h3>
<p>Save playlist to <i>location</i>. If <i>format</i> is specified, it is used, otherwise format is guessed from location name.</p>
<p>Returns true if playlist was saved successfully, otherwise returns false.</p>
<!-- @@@save -->
<!-- $$$save$$$saveQIODevice*constchar* -->
<h3 class="fn" id="save-1"><a name="save-1"></a><span class="type">bool</span> QMediaPlaylist::<span class="name">save</span>(<span class="type">QIODevice</span> *<i>device</i>, const <span class="type">char</span> *<i>format</i>)</h3>
<p>Save playlist to QIODevice <i>device</i> using format <i>format</i>.</p>
<p>Returns true if playlist was saved successfully, otherwise returns false.</p>
<!-- @@@save -->
<!-- $$$setCurrentIndex -->
<h3 class="fn" id="setCurrentIndex"><a name="setCurrentIndex"></a><code>[slot] </code><span class="type">void</span> QMediaPlaylist::<span class="name">setCurrentIndex</span>(<span class="type">int</span> <i>playlistPosition</i>)</h3>
<p>Activate media content from playlist at position <i>playlistPosition</i>.</p>
<p><b>Note:</b> Setter function for property <a href="qmediaplaylist.html#currentIndex-prop">currentIndex</a>. </p><p><b>See also </b><a href="qmediaplaylist.html#currentIndex">currentIndex</a>().</p>
<!-- @@@setCurrentIndex -->
<!-- $$$shuffle[overload1]$$$shuffle -->
<h3 class="fn" id="shuffle"><a name="shuffle"></a><code>[slot] </code><span class="type">void</span> QMediaPlaylist::<span class="name">shuffle</span>()</h3>
<p>Shuffle items in the playlist.</p>
<!-- @@@shuffle -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed 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.<br> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
