mirror of
https://bitbucket.org/smil3y/kde-playground.git
synced 2025-02-24 02:42:51 +00:00
1251 lines
44 KiB
HTML
1251 lines
44 KiB
HTML
<?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.MediaObject</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>MediaObject Class Reference</h1>
|
|
<code>from PyKDE4.phonon import *</code>
|
|
<p>
|
|
Inherits: QObject,<a href="../phonon/Phonon.MediaNode.html">Phonon.MediaNode</a><br />
|
|
|
|
Namespace: <a href="../phonon/Phonon.html">Phonon</a><br />
|
|
<h2>Detailed Description</h2>
|
|
|
|
<p>\class MediaObject mediaobject.h phonon/MediaObject
|
|
Interface for media playback of a given URL.
|
|
</p>
|
|
<p>
|
|
This class is the most important class in %Phonon. Use it to open a media
|
|
file at an arbitrary location, a CD or DVD or to stream media data from
|
|
the application to the backend.
|
|
</p>
|
|
<p>
|
|
This class controls the state (play, pause, stop, seek)
|
|
and you can use it to get a lot of information about the media data.
|
|
</p>
|
|
<p>
|
|
Notice that most functions of this class are asynchronous.
|
|
That means if you call play() the object only starts playing when the
|
|
stateChanged() signal tells you that the object changed into PlayingState.
|
|
The states you can expect are documented for those methods.
|
|
</p>
|
|
<p>
|
|
A common usage example is the following:
|
|
<pre class="fragment">
|
|
media = new MediaObject(this);
|
|
connect(media, SIGNAL(finished()), SLOT(slotFinished());
|
|
media->setCurrentSource("/home/username/music/filename.ogg");
|
|
media->play();
|
|
</pre>
|
|
</p>
|
|
<p>
|
|
If you want to play more than one media file (one after another) you can
|
|
either tell MediaObject about all those files
|
|
<pre class="fragment">
|
|
media->setCurrentSource(":/sounds/startsound.ogg");
|
|
media->enqueue("/home/username/music/song.mp3");
|
|
media->enqueue(":/sounds/endsound.ogg");
|
|
</pre>
|
|
or provide the next file just in time:
|
|
<pre class="fragment">
|
|
media->setCurrentSource(":/sounds/startsound.ogg");
|
|
connect(media, SIGNAL(aboutToFinish()), SLOT(enqueueNextSource()));
|
|
}
|
|
|
|
void enqueueNextSource()
|
|
{
|
|
media->enqueue("/home/username/music/song.mp3");
|
|
}
|
|
</pre>
|
|
</p>
|
|
<p>
|
|
Some platforms support system-wide tracking of a user's activities. For
|
|
instance, the zeitgeist project (http://zeitgeist-project.com) on Linux.
|
|
</p>
|
|
<p>
|
|
This integration is opt-in only and can be enabled by setting the
|
|
PlaybackTracking property to true:
|
|
<pre class="fragment">
|
|
media->setProperty("PlaybackTracking", true);
|
|
</pre>
|
|
</p>
|
|
<p>
|
|
This kind of information is normally used to provide a universal history
|
|
view to the user, such as what songs were played when, regardless of the
|
|
media player. This is in addition to any emails read, IM conversations,
|
|
websites viewed, etc.
|
|
</p>
|
|
<p>
|
|
|
|
<dl class="author" compact><dt><b>Author:</b></dt><dd> Matthias Kretz <kretz@kde.org> </dd></dl>
|
|
</p>
|
|
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Signals</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aboutToFinish">aboutToFinish</a> ()</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#bufferStatus">bufferStatus</a> (int percentFilled)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#currentSourceChanged">currentSourceChanged</a> (<a href="../phonon/Phonon.MediaSource.html">Phonon.MediaSource</a> newSource)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#finished">finished</a> ()</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#hasVideoChanged">hasVideoChanged</a> (bool hasVideo)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#metaDataChanged">metaDataChanged</a> ()</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#prefinishMarkReached">prefinishMarkReached</a> (int msecToEnd)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#seekableChanged">seekableChanged</a> (bool isSeekable)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#stateChanged">stateChanged</a> (Phonon::State newstate, Phonon::State oldstate)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#tick">tick</a> (long time)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#totalTimeChanged">totalTimeChanged</a> (long newTotalTime)</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="#clear">clear</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#clearQueue">clearQueue</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../phonon/Phonon.MediaSource.html">Phonon.MediaSource</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#currentSource">currentSource</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#currentTime">currentTime</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#enqueue">enqueue</a> (self, <a href="../phonon/Phonon.MediaSource.html">Phonon.MediaSource</a> source)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#enqueue">enqueue</a> (self, [<a href="../phonon/Phonon.MediaSource.html">Phonon.MediaSource</a>] sources)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#enqueue">enqueue</a> (self, [QUrl] urls)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#errorString">errorString</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">Phonon::ErrorType </td><td class="memItemRight" valign="bottom"><a class="el" href="#errorType">errorType</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#hasVideo">hasVideo</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isSeekable">isSeekable</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#metaData">metaData</a> (self, QString key)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#metaData">metaData</a> (self, Phonon::MetaData key)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QMultiMap<QString,QString> </td><td class="memItemRight" valign="bottom"><a class="el" href="#metaData">metaData</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#pause">pause</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#play">play</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#prefinishMark">prefinishMark</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../phonon/Phonon.MediaSource.html">Phonon.MediaSource</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#queue">queue</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#remainingTime">remainingTime</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#seek">seek</a> (self, long time)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setCurrentSource">setCurrentSource</a> (self, <a href="../phonon/Phonon.MediaSource.html">Phonon.MediaSource</a> source)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setPrefinishMark">setPrefinishMark</a> (self, int msecToEnd)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setQueue">setQueue</a> (self, [<a href="../phonon/Phonon.MediaSource.html">Phonon.MediaSource</a>] sources)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setQueue">setQueue</a> (self, [QUrl] urls)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setTickInterval">setTickInterval</a> (self, int newTickInterval)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setTransitionTime">setTransitionTime</a> (self, int msec)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">Phonon::State </td><td class="memItemRight" valign="bottom"><a class="el" href="#state">state</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#stop">stop</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#tickInterval">tickInterval</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#totalTime">totalTime</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#transitionTime">transitionTime</a> (self)</td></tr>
|
|
</table>
|
|
<hr><h2>Signal Documentation</h2><a class="anchor" name="aboutToFinish"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> aboutToFinish</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">)</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>Emitted before the playback of the whole queue stops. When this
|
|
signal is emitted you still have time to provide the next
|
|
MediaSource (using enqueue()) so that playback continues.
|
|
</p>
|
|
<p>
|
|
This signal can be used to provide the next MediaSource just in
|
|
time for the transition still to work.
|
|
</p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> enqueue
|
|
</dd></dl>
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("aboutToFinish()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="bufferStatus"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> bufferStatus</td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>percentFilled</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Tells about the status of the buffer.
|
|
</p>
|
|
<p>
|
|
You can use this signal to show a progress bar to the user when
|
|
in BufferingState:
|
|
</p>
|
|
<p>
|
|
<pre class="fragment">
|
|
progressBar->setRange(0, 100); // this is the default
|
|
connect(media, SIGNAL(bufferStatus(int)), progressBar, SLOT(setValue(int)));
|
|
</pre>
|
|
</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>percentFilled</em> </td><td> A number between 0 and 100 telling you how
|
|
much the buffer is filled.
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("bufferStatus(int)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="currentSourceChanged"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> currentSourceChanged</td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a href="../phonon/Phonon.MediaSource.html">Phonon.MediaSource</a> </td>
|
|
<td class="paramname"><em>newSource</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Emitted when the MediaObject makes a transition to the next
|
|
MediaSource in the queue().
|
|
</p>
|
|
<p>
|
|
In other words, it is emitted when an individual MediaSource is
|
|
finished.
|
|
</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>newSource</em> </td><td> The source that starts to play at the time the
|
|
signal is emitted.
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("currentSourceChanged(const Phonon::MediaSource&)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="finished"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> finished</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">)</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>Emitted when the object has finished playback.
|
|
It is not emitted if you call stop(), pause() or
|
|
load(), but only on end-of-queue or a critical error.
|
|
</p>
|
|
<p>
|
|
<dl class="warning" compact><dt><b>Warning:</b></dt><dd> This signal is not emitted when the current source has
|
|
finished and there's another source in the queue. It is only
|
|
emitted when the queue is empty.
|
|
</dd></dl> </p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> currentSourceChanged
|
|
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> aboutToFinish
|
|
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> prefinishMarkReached
|
|
</dd></dl>
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("finished()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="hasVideoChanged"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> hasVideoChanged</td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>hasVideo</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Emitted whenever the return value of hasVideo() changes.
|
|
</p>
|
|
<p>
|
|
Normally you'll check hasVideo() first and then let this signal
|
|
tell you whether video is available now or not. That way you
|
|
don't have to poll hasVideo().
|
|
</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>hasVideo</em> </td><td> <b>true</b> The stream contains video and adding a
|
|
VideoWidget will show a video.
|
|
<b>false</b> There is no video data in the stream and
|
|
adding a VideoWidget will show an empty (black)
|
|
VideoWidget.
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("hasVideoChanged(bool)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="metaDataChanged"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> metaDataChanged</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">)</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>This signal is emitted whenever the audio/video data that is
|
|
being played is associated with new meta data. E.g. for radio
|
|
streams this happens when the next song is played.
|
|
</p>
|
|
<p>
|
|
You can get the new meta data with the metaData methods.
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("metaDataChanged()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="prefinishMarkReached"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> prefinishMarkReached</td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>msecToEnd</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Emitted when there are only <b>msecToEnd</b> milliseconds left
|
|
for playback.
|
|
</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>msecToEnd</em> </td><td> The remaining time until the playback queue finishes.
|
|
</td></tr>
|
|
</table></dl>
|
|
<p> <dl class="warning" compact><dt><b>Warning:</b></dt><dd> This signal is not emitted when there is another source in the queue.
|
|
It is only emitted when the queue is empty.
|
|
</dd></dl> </p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> setPrefinishMark
|
|
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> prefinishMark
|
|
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> aboutToFinish
|
|
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> finished
|
|
</dd></dl>
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("prefinishMarkReached(qint32)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="seekableChanged"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> seekableChanged</td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>isSeekable</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Emitted whenever the return value of isSeekable() changes.
|
|
</p>
|
|
<p>
|
|
Normally you'll check isSeekable() first and then let this signal
|
|
tell you whether seeking is possible now or not. That way you
|
|
don't have to poll isSeekable().
|
|
</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>isSeekable</em> </td><td> <b>true</b> if the stream is seekable (i.e. calling
|
|
seek() works)
|
|
<b>false</b> if the stream is not seekable (i.e.
|
|
all calls to seek() will be ignored)
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("seekableChanged(bool)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="stateChanged"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> stateChanged</td>
|
|
<td>(</td>
|
|
<td class="paramtype">Phonon::State </td>
|
|
<td class="paramname"><em>newstate</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">Phonon::State </td>
|
|
<td class="paramname"><em>oldstate</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Emitted when the state of the MediaObject has changed.
|
|
</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>newstate</em> </td><td> The state the Player is in now.
|
|
|
|
<tr><td></td><td valign="top"><em>oldstate</em> </td><td> The state the Player was in before.
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("stateChanged(Phonon::State, Phonon::State)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="tick"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> tick</td>
|
|
<td>(</td>
|
|
<td class="paramtype">long </td>
|
|
<td class="paramname"><em>time</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>This signal gets emitted every tickInterval milliseconds.
|
|
</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>time</em> </td><td> The position of the media file in milliseconds.
|
|
</td></tr>
|
|
</table></dl>
|
|
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> setTickInterval, tickInterval
|
|
</dd></dl>
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("tick(qint64)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="totalTimeChanged"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> totalTimeChanged</td>
|
|
<td>(</td>
|
|
<td class="paramtype">long </td>
|
|
<td class="paramname"><em>newTotalTime</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>This signal is emitted as soon as the total time of the media file is
|
|
known or has changed. For most non-local media data the total
|
|
time of the media can only be known after some time. Initially the
|
|
totalTime function can not return useful information. You have
|
|
to wait for this signal to know the real total time.
|
|
</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>newTotalTime</em> </td><td> The length of the media file in milliseconds.
|
|
</td></tr>
|
|
</table></dl>
|
|
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> totalTime
|
|
</dd></dl>
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("totalTimeChanged(qint64)"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="clear"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> clear</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>Stops and removes all playing and enqueued media sources.
|
|
</p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> setCurrentSource
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="clearQueue"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> clearQueue</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>Clears the queue of sources.
|
|
</p></div></div><a class="anchor" name="currentSource"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"><a href="../phonon/Phonon.MediaSource.html">Phonon.MediaSource</a> currentSource</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 current media source.
|
|
</p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> setCurrentSource
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="currentTime"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">long currentTime</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 current time (in milliseconds) of the file currently being played.
|
|
</p>
|
|
<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd> The current time in milliseconds.
|
|
</dd></dl> </p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> tick
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="enqueue"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> enqueue</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.MediaSource.html">Phonon.MediaSource</a> </td>
|
|
<td class="paramname"><em>source</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Appends multiple sources to the queue.
|
|
</p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> setQueue
|
|
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> clearQueue
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="enqueue"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> enqueue</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.MediaSource.html">Phonon.MediaSource</a>] </td>
|
|
<td class="paramname"><em>sources</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Appends multiple sources to the queue.
|
|
</p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> setQueue
|
|
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> clearQueue
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="enqueue"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> enqueue</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">[QUrl] </td>
|
|
<td class="paramname"><em>urls</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Appends multiple sources to the queue.
|
|
</p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> setQueue
|
|
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> clearQueue
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="errorString"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">QString errorString</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 human-readable description of the last error that occurred.
|
|
</p></div></div><a class="anchor" name="errorType"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">Phonon::ErrorType errorType</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>Tells your program what to do about the error.
|
|
</p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> Phonon.ErrorType
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="hasVideo"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">bool hasVideo</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>Check whether the media data includes a video stream.
|
|
</p>
|
|
<p>
|
|
<dl class="warning" compact><dt><b>Warning:</b></dt><dd> This information cannot be known immediately. It is best
|
|
to also listen to the hasVideoChanged signal.
|
|
</dd></dl> </p>
|
|
<p>
|
|
<pre class="fragment">
|
|
connect(media, SIGNAL(hasVideoChanged(bool)), hasVideoChanged(bool));
|
|
media->setCurrentSource("somevideo.avi");
|
|
media->hasVideo(); // returns false;
|
|
}
|
|
|
|
void hasVideoChanged(bool b)
|
|
{
|
|
// b == true
|
|
media->hasVideo(); // returns true;
|
|
}
|
|
</pre>
|
|
</p>
|
|
<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the media contains video data. false
|
|
otherwise.
|
|
</dd></dl> </p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> hasVideoChanged
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="isSeekable"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">bool isSeekable</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>Check whether the current media may be seeked.
|
|
</p>
|
|
<p>
|
|
<dl class="warning" compact><dt><b>Warning:</b></dt><dd> This information cannot be known immediately. It is best
|
|
to also listen to the seekableChanged signal.
|
|
</dd></dl> </p>
|
|
<p>
|
|
<pre class="fragment">
|
|
connect(media, SIGNAL(seekableChanged(bool)), seekableChanged(bool));
|
|
media->setCurrentSource("somevideo.avi");
|
|
media->isSeekable(); // returns false;
|
|
}
|
|
|
|
void seekableChanged(bool b)
|
|
{
|
|
// b == true
|
|
media->isSeekable(); // returns true;
|
|
}
|
|
</pre>
|
|
</p>
|
|
<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true when the current media may be seeked. false
|
|
otherwise.
|
|
</dd></dl> </p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> seekableChanged()
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="metaData"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">QStringList metaData</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>key</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Returns all meta data.
|
|
</p></div></div><a class="anchor" name="metaData"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">QStringList metaData</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">Phonon::MetaData </td>
|
|
<td class="paramname"><em>key</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Returns all meta data.
|
|
</p></div></div><a class="anchor" name="metaData"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">QMultiMap<QString,QString> metaData</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 meta data.
|
|
</p></div></div><a class="anchor" name="pause"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> pause</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>Requests playback to pause. If it was paused before nothing changes.
|
|
</p>
|
|
<p>
|
|
Possible states right after this call:
|
|
<li> PlayingState </li>
|
|
<li> PausedState </li>
|
|
<li> ErrorState </li>
|
|
</p></div></div><a class="anchor" name="play"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> play</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>Requests playback of the media data to start. Playback only
|
|
starts when stateChanged() signals that it goes into PlayingState,
|
|
though.
|
|
</p>
|
|
<p>
|
|
Possible states right after this call:
|
|
<li> BufferingState </li>
|
|
<li> PlayingState </li>
|
|
<li> ErrorState </li>
|
|
</p></div></div><a class="anchor" name="prefinishMark"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">int prefinishMark</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"></div></div><a class="anchor" name="queue"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">[<a href="../phonon/Phonon.MediaSource.html">Phonon.MediaSource</a>] queue</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 queued media sources. This list does not include
|
|
the current source (returned by currentSource).
|
|
</p></div></div><a class="anchor" name="remainingTime"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">long remainingTime</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 remaining time (in milliseconds) of the file currently being played.
|
|
</p>
|
|
<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd> The remaining time in milliseconds.
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="seek"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> seek</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">long </td>
|
|
<td class="paramname"><em>time</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Requests a seek to the time indicated.
|
|
</p>
|
|
<p>
|
|
You can only seek if state() == PlayingState, BufferingState or PausedState.
|
|
</p>
|
|
<p>
|
|
The call is asynchronous, so currentTime can still be the old
|
|
value right after this method was called. If all you need is a
|
|
slider that shows the current position and allows the user to
|
|
seek use the class SeekSlider.
|
|
</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>time</em> </td><td> The time in milliseconds where to continue playing.
|
|
</td></tr>
|
|
</table></dl>
|
|
<p> Possible states right after this call:
|
|
<li> BufferingState </li>
|
|
<li> PlayingState </li>
|
|
<li> ErrorState </li>
|
|
</p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> SeekSlider
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="setCurrentSource"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setCurrentSource</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.MediaSource.html">Phonon.MediaSource</a> </td>
|
|
<td class="paramname"><em>source</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Set the media source the MediaObject should use.
|
|
</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>source</em> </td><td> The MediaSource object to the media data. You can
|
|
just as well use a QUrl or QString (for a local file) here.
|
|
Setting an empty (invalid) source, will stop and remove the
|
|
current source.
|
|
</td></tr>
|
|
</table></dl>
|
|
<p> <pre class="fragment">
|
|
QUrl url("http://www.example.com/music.ogg");
|
|
media->setCurrentSource(url);
|
|
</pre>
|
|
</p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> currentSource
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="setPrefinishMark"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setPrefinishMark</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>msecToEnd</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="setQueue"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setQueue</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.MediaSource.html">Phonon.MediaSource</a>] </td>
|
|
<td class="paramname"><em>sources</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Set the MediaSources to play when the current media has finished.
|
|
</p>
|
|
<p>
|
|
This function overwrites the current queue.
|
|
</p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> clearQueue
|
|
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> enqueue
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="setQueue"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setQueue</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">[QUrl] </td>
|
|
<td class="paramname"><em>urls</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Set the MediaSources to play when the current media has finished.
|
|
</p>
|
|
<p>
|
|
This function overwrites the current queue.
|
|
</p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> clearQueue
|
|
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> enqueue
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="setTickInterval"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setTickInterval</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>newTickInterval</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="setTransitionTime"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setTransitionTime</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>msec</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="state"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">Phonon::State state</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 current state.
|
|
</p>
|
|
<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd> The state of the object.
|
|
</dd></dl> </p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> State
|
|
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> stateChanged
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="stop"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> stop</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>Requests playback to stop. If it was stopped before nothing changes.
|
|
</p>
|
|
<p>
|
|
Possible states right after this call:
|
|
<li> the state it was in before (e.g. PlayingState) </li>
|
|
<li> StoppedState </li>
|
|
<li> ErrorState </li>
|
|
</p></div></div><a class="anchor" name="tickInterval"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">int tickInterval</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"></div></div><a class="anchor" name="totalTime"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">long totalTime</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 total time (in milliseconds) of the file currently being played.
|
|
</p>
|
|
<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd> The total time in milliseconds.
|
|
</dd></dl> </p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> totalTimeChanged
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="transitionTime"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">int transitionTime</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</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>
|