<?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.VideoPlayer</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>VideoPlayer Class Reference</h1> <code>from PyKDE4.phonon import *</code> <p> Inherits: QWidget → QObject<br /> Namespace: <a href="../phonon/Phonon.html">Phonon</a><br /> <h2>Detailed Description</h2> <p>\class VideoPlayer videoplayer.h phonon/VideoPlayer Playback class for simple tasks. </p> <p> With %VideoPlayer you can get results quickly and easily. You can do the standard playback tasks like play, pause and stop, but also set a playback volume and seek (there's no guarantee that the seek will work, though). </p> <p> Keep in mind that when the %VideoPlayer instance is deleted the playback will stop. </p> <p> A play and forget code example: <pre class="fragment"> VideoPlayer *player = new VideoPlayer(parentWidget); connect(player, SIGNAL(finished()), player, SLOT(deleteLater())); player->play(url); </pre> </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="#finished">finished</a> ()</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="#VideoPlayer">__init__</a> (self, Phonon::Category category, QWidget parent=0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#VideoPlayer">__init__</a> (self, QWidget parent=0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../phonon/Phonon.AudioOutput.html">Phonon.AudioOutput</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#audioOutput">audioOutput</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">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#event">event</a> (self, QEvent a0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isPaused">isPaused</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isPlaying">isPlaying</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#load">load</a> (self, <a href="../phonon/Phonon.MediaSource.html">Phonon.MediaSource</a> source)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../phonon/Phonon.MediaObject.html">Phonon.MediaObject</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#mediaObject">mediaObject</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, <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="#play">play</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 ms)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setVolume">setVolume</a> (self, float volume)</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">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"><a href="../phonon/Phonon.VideoWidget.html">Phonon.VideoWidget</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#videoWidget">videoWidget</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="#volume">volume</a> (self)</td></tr> </table> <hr><h2>Signal Documentation</h2><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>This signal is emitted when the playback finished. </p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("finished()"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="VideoPlayer"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">__init__</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype">Phonon::Category </td> <td class="paramname"><em>category</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">QWidget </td> <td class="paramname"><em>parent=0</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Constructs a new %VideoPlayer instance. </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>category</em> </td><td> The category used for the audio output device. </td></tr> </table></dl> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>parent</em> </td><td> The QObject parent. </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="VideoPlayer"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">__init__</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype">QWidget </td> <td class="paramname"><em>parent=0</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Constructs a new video widget with a <b>parent</b> using Phonon.VideoCategory as its category. </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>parent</em> </td><td> The QObject parent. </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="audioOutput"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../phonon/Phonon.AudioOutput.html">Phonon.AudioOutput</a> audioOutput</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>getter for the AudioOutput. </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></div></div><a class="anchor" name="event"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool event</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">QEvent </td> <td class="paramname"><em>a0</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="isPaused"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isPaused</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> true if it is currently paused </dd></dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd> false if it is currently playing or stopped </dd></dl> </p></div></div><a class="anchor" name="isPlaying"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isPlaying</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> true if it is currently playing </dd></dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd> false if it is currently stopped or paused </dd></dl> </p></div></div><a class="anchor" name="load"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> load</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>Starts preloading the media data and fill audiobuffers in the backend. </p> <p> When there's already a media playing (or paused) it will be stopped (the finished signal will not be emitted). </p></div></div><a class="anchor" name="mediaObject"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../phonon/Phonon.MediaObject.html">Phonon.MediaObject</a> mediaObject</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>getter for the MediaObject. </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>Pauses the playback. </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"> <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>Continues playback of a paused media. Restarts playback of a stopped media. </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>Continues playback of a paused media. Restarts playback of a stopped media. </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>ms</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Seeks to the requested time. Note that the backend is free to ignore the seek request if the media source isn't seekable. </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>ms</em> </td><td> Time in milliseconds from the start of the media. </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="setVolume"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setVolume</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">float </td> <td class="paramname"><em>volume</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Sets the volume of the output as voltage factor. </p> <p> 1.0 means 100%, 0.5 means 50% voltage/25% power, 0.0 means 0% </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>Stops the playback. </p></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></div></div><a class="anchor" name="videoWidget"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../phonon/Phonon.VideoWidget.html">Phonon.VideoWidget</a> videoWidget</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>getter for the VideoWidget. </p></div></div><a class="anchor" name="volume"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">float volume</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>This is the current volume of the output as voltage factor. </p> <p> 1.0 means 100%, 0.5 means 50% voltage/25% power, 0.0 means 0% </p></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>