<?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_US" xml:lang="en_US">
<head>
<title>arts: KDE::PlayObject Class Reference (arts)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<div id="nav_header_title" align="left">KDE API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../..">API Reference</a>
/ <a href=".">arts</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<a name="content"></a>
<!-- Generated by Doxygen 1.7.4 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/namespaceKDE.html">KDE</a> </li>
<li class="navelem"><a class="el" href="classKDE_1_1PlayObject.html">PlayObject</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#signals">Signals</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">KDE::PlayObject Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="KDE::PlayObject" --><!-- doxytag: inherits="QObject" -->
<p>This class acts as a general interface to the <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/namespaceKDE.html">KDE</a> multimedia framework.
<a href="classKDE_1_1PlayObject.html#details">More...</a></p>
<p><code>#include <<a class="el" href="kplayobject_8h_source.html">kplayobject.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for KDE::PlayObject:</div>
<div class="dyncontent">
<div class="center">
<img src="classKDE_1_1PlayObject.png" usemap="#KDE::PlayObject_map" alt=""/>
<map id="KDE::PlayObject_map" name="KDE::PlayObject_map">
<area href="qobject.html" alt="QObject" shape="rect" coords="0,0,105,24"/>
</map>
</div></div>
<p><a href="classKDE_1_1PlayObject-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="signals"></a>
Signals</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDE_1_1PlayObject.html#a959cba86158b29b58a700f35fb0aabb2">playObjectCreated</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Arts::PlayObject </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDE_1_1PlayObject.html#a5d4359f8b70cadb5169afbcffdab682d">object</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDE_1_1PlayObject.html#a3f0c3f21e884e7526d276942c226e30c">isNull</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDE_1_1PlayObject.html#aa591df42992435c5f8a0739582bb7650">stream</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDE_1_1PlayObject.html#a75758f3435faee4b6876837e583f20b5">play</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDE_1_1PlayObject.html#aa868bc311037b0624ab52639bda5fd7a">seek</a> (Arts::poTime newTime)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDE_1_1PlayObject.html#a5736e78c75926de352969681d3d33fc2">pause</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDE_1_1PlayObject.html#a0b7291e5a7f4146a4050959613470d47">halt</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDE_1_1PlayObject.html#a5441170faadbe1c6aa74b3e84fee615d">description</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Arts::poTime </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDE_1_1PlayObject.html#ad45c539ab8011488681e09ea812c4a95">currentTime</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Arts::poTime </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDE_1_1PlayObject.html#a8d7118ecf1c13509872e2bc33fdd3ddf">overallTime</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Arts::poCapabilities </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDE_1_1PlayObject.html#aff54329e65c9c5e8a19ab6732b1867fe">capabilities</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDE_1_1PlayObject.html#a847de6d7c1b5dfccd838eaeacef5c00f">mediaName</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Arts::poState </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDE_1_1PlayObject.html#aab8c0bb73aacba1c85254754420d82b1">state</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a82e83128d627ef256e2e0ba4ad3f120b"></a><!-- doxytag: member="KDE::PlayObject::KDE::PlayObjectFactory" ref="a82e83128d627ef256e2e0ba4ad3f120b" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDE_1_1PlayObject.html#a82e83128d627ef256e2e0ba4ad3f120b">KDE::PlayObjectFactory</a></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This class acts as a general interface to the <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/namespaceKDE.html">KDE</a> multimedia framework. </p>
<p>You basically point the Playobject to an URL and say "play", and it will automatically decode and play and / or display the file or stream. For non-local media, it will make extensive use of KIOInputStream to directly play the content from the remote location without having to download it to a temporary local file first.</p>
<p>A <a class="el" href="classKDE_1_1PlayObject.html" title="This class acts as a general interface to the KDE multimedia framework.">KDE::PlayObject</a> is never created directly with new, but only through a <a class="el" href="classKDE_1_1PlayObjectFactory.html" title="This class implements a factory to create KDE::PlayObjects for a given URL and mimetype.">KDE::PlayObjectFactory</a>.</p>
<p>Basically, it is used like this: </p>
<div class="fragment"><pre class="fragment"> <a class="code" href="classKArtsDispatcher.html" title="KArtsDispatcher ensures that an instance of Arts::Dispatcher using an Arts::QIOManager exists...">KArtsDispatcher</a> dispatcher;
<a class="code" href="classKArtsServer.html" title="KArtsServer is a wrapper to conveniently get a reference to a SoundServer, and restart artsd when nec...">KArtsServer</a> server;
<a class="code" href="classKDE_1_1PlayObjectFactory.html" title="This class implements a factory to create KDE::PlayObjects for a given URL and mimetype.">KDE::PlayObjectFactory</a> factory( server.<a class="code" href="classKArtsServer.html#a63afac953e63a4b053b522c366902ec7" title="Get a verified reference to the SoundServerV2, (re)starting artsd using the kcontrol-specified settin...">server</a>() );
<a class="code" href="classKDE_1_1PlayObject.html" title="This class acts as a general interface to the KDE multimedia framework.">KDE::PlayObject</a>* playobj = factory.createPlayObject( someURL, <span class="keyword">true</span> );
playobj-><a class="code" href="classKDE_1_1PlayObject.html#a75758f3435faee4b6876837e583f20b5" title="causes the PlayObject to start the play back.">play</a>();
</pre></div><p>Internally, the <a class="el" href="classKDE_1_1PlayObject.html" title="This class acts as a general interface to the KDE multimedia framework.">KDE::PlayObject</a> acts as a wrapper for an Arts::PlayObject.</p>
<p>Special care needs to be taken for non-local media. In general, you cannot safely figure out the mimetype of the remote media content, by looking at the URL alone. You need to download some data to analyze the content. Since <a class="el" href="classKDE_1_1PlayObject.html" title="This class acts as a general interface to the KDE multimedia framework.">KDE::PlayObject</a> is only a wrapper for an Arts::PlayObject, and an Arts::PlayObject needs to know the mimetype of the data it plays in order to pick the correct decoder, one cannot directly create an Arts::PlayObject and attach it to a stream. Therefore, the following approach is used.</p>
<p>Whenever a the factory creates a <a class="el" href="classKDE_1_1PlayObject.html" title="This class acts as a general interface to the KDE multimedia framework.">KDE::PlayObject</a> for a non-local content, it first generates a so called "Proxy" Playobject. This is a <a class="el" href="classKDE_1_1PlayObject.html" title="This class acts as a general interface to the KDE multimedia framework.">KDE::PlayObject</a> that does not contain a real Arts::PlayObject yet. As soon as you invoke the <a class="el" href="classKDE_1_1PlayObject.html#a75758f3435faee4b6876837e583f20b5" title="causes the PlayObject to start the play back.">play()</a> method, a connection to the media source is made, and as soon as the mimetype is known, the appropriate Arts::PlayObject is created.</p>
<p>This has some side effects that developers need to be aware of: Until the real Arts::PlayObject got created,</p>
<ul>
<li>the <a class="el" href="classKDE_1_1PlayObject.html#aff54329e65c9c5e8a19ab6732b1867fe" title="returns the capabilities of the PlayObject.">capabilities()</a> method returns "zero" capabilities,</li>
<li><a class="el" href="classKDE_1_1PlayObject.html#a5441170faadbe1c6aa74b3e84fee615d" title="Reimplemented (Arts::PlayObject Wrapper)">description()</a> and <a class="el" href="classKDE_1_1PlayObject.html#a847de6d7c1b5dfccd838eaeacef5c00f" title="Reimplemented (Arts::PlayObject Wrapper)">mediaName()</a> will return a null <a class="elRef" href="qstring.html">QString</a>,</li>
<li><a class="el" href="classKDE_1_1PlayObject.html#ad45c539ab8011488681e09ea812c4a95" title="Reimplemented (Arts::PlayObject Wrapper)">currentTime()</a> and <a class="el" href="classKDE_1_1PlayObject.html#a8d7118ecf1c13509872e2bc33fdd3ddf" title="Reimplemented (Arts::PlayObject Wrapper)">overallTime()</a> will return "zero",</li>
<li>despite the fact that <a class="el" href="classKDE_1_1PlayObject.html#a3f0c3f21e884e7526d276942c226e30c" title="return true if this != 0.">isNull()</a> returns "false", <a class="el" href="classKDE_1_1PlayObject.html#a5d4359f8b70cadb5169afbcffdab682d" title="Returns the internal Arts::PlayObject.">object()</a>.<a class="el" href="classKDE_1_1PlayObject.html#a3f0c3f21e884e7526d276942c226e30c" title="return true if this != 0.">isNull()</a> will return "true". If you need to directly access methods of the internal Arts::PlayObject, be sure to use <a class="el" href="classKDE_1_1PlayObject.html#a5d4359f8b70cadb5169afbcffdab682d" title="Returns the internal Arts::PlayObject.">object()</a>.<a class="el" href="classKDE_1_1PlayObject.html#a3f0c3f21e884e7526d276942c226e30c" title="return true if this != 0.">isNull()</a> to guard your access.</li>
</ul>
<p>A <a class="el" href="classKDE_1_1PlayObject.html" title="This class acts as a general interface to the KDE multimedia framework.">KDE::PlayObject</a> will emit the signal <a class="el" href="classKDE_1_1PlayObject.html#a959cba86158b29b58a700f35fb0aabb2" title="this signal is emitted as soon as the internal Arts::PlayObject is created and ready to play...">playObjectCreated()</a> as soon as the real internal Arts::PlayObject got created. This is also true for local media files. So you can generally connect to this signal and act on it if your application needs to know about the real capabilities of the Arts::PlayObject.</p>
<p>However, <a class="el" href="classKDE_1_1PlayObject.html" title="This class acts as a general interface to the KDE multimedia framework.">KDE::PlayObject</a> will try to act reasonable on calls to <a class="el" href="classKDE_1_1PlayObject.html#a75758f3435faee4b6876837e583f20b5" title="causes the PlayObject to start the play back.">play()</a>, <a class="el" href="classKDE_1_1PlayObject.html#a0b7291e5a7f4146a4050959613470d47" title="immediately stops the play back and resets the media to the start of the content.">halt()</a>, <a class="el" href="classKDE_1_1PlayObject.html#a5736e78c75926de352969681d3d33fc2" title="causes the PlayObject to pause play back immediately.">pause()</a> and <a class="el" href="classKDE_1_1PlayObject.html#aab8c0bb73aacba1c85254754420d82b1" title="returns the internal state of the PlayObject.">state()</a>. If you call <a class="el" href="classKDE_1_1PlayObject.html#a75758f3435faee4b6876837e583f20b5" title="causes the PlayObject to start the play back.">play()</a> and then <a class="el" href="classKDE_1_1PlayObject.html#a5736e78c75926de352969681d3d33fc2" title="causes the PlayObject to pause play back immediately.">pause()</a> before the connection to the media source was established, it will not start playing once the connection got established. Calling <a class="el" href="classKDE_1_1PlayObject.html#a0b7291e5a7f4146a4050959613470d47" title="immediately stops the play back and resets the media to the start of the content.">halt()</a> will cancel the connection process. <a class="el" href="classKDE_1_1PlayObject.html" title="This class acts as a general interface to the KDE multimedia framework.">KDE::PlayObject</a> will maintain an internal state variable, and calling <a class="el" href="classKDE_1_1PlayObject.html#aab8c0bb73aacba1c85254754420d82b1" title="returns the internal state of the PlayObject.">state()</a> will return this internal state until the real Arts::PlayObject got created, afterwards the state of the Arts::PlayObject will be returned. </p>
<p>Definition at line <a class="el" href="kplayobject_8h_source.html#l00188">188</a> of file <a class="el" href="kplayobject_8h_source.html">kplayobject.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aff54329e65c9c5e8a19ab6732b1867fe"></a><!-- doxytag: member="KDE::PlayObject::capabilities" ref="aff54329e65c9c5e8a19ab6732b1867fe" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Arts::poCapabilities KDE::PlayObject::capabilities </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>returns the capabilities of the <a class="el" href="classKDE_1_1PlayObject.html" title="This class acts as a general interface to the KDE multimedia framework.">PlayObject</a>. </p>
<p>The return value is a binary OR of Arts::capSeek and Arts::capPause, or 0. </p>
<p>Definition at line <a class="el" href="kplayobject_8cc_source.html#l00263">263</a> of file <a class="el" href="kplayobject_8cc_source.html">kplayobject.cc</a>.</p>
</div>
</div>
<a class="anchor" id="ad45c539ab8011488681e09ea812c4a95"></a><!-- doxytag: member="KDE::PlayObject::currentTime" ref="ad45c539ab8011488681e09ea812c4a95" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Arts::poTime KDE::PlayObject::currentTime </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented (Arts::PlayObject Wrapper) </p>
<p>Definition at line <a class="el" href="kplayobject_8cc_source.html#l00249">249</a> of file <a class="el" href="kplayobject_8cc_source.html">kplayobject.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a5441170faadbe1c6aa74b3e84fee615d"></a><!-- doxytag: member="KDE::PlayObject::description" ref="a5441170faadbe1c6aa74b3e84fee615d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="qstring.html">QString</a> KDE::PlayObject::description </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented (Arts::PlayObject Wrapper) </p>
<p>Definition at line <a class="el" href="kplayobject_8cc_source.html#l00242">242</a> of file <a class="el" href="kplayobject_8cc_source.html">kplayobject.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a0b7291e5a7f4146a4050959613470d47"></a><!-- doxytag: member="KDE::PlayObject::halt" ref="a0b7291e5a7f4146a4050959613470d47" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KDE::PlayObject::halt </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>immediately stops the play back and resets the media to the start of the content. </p>
<p>If playing from a stream, <a class="el" href="classKDE_1_1PlayObject.html#a0b7291e5a7f4146a4050959613470d47" title="immediately stops the play back and resets the media to the start of the content.">halt()</a> causes the connection to be canceled. </p>
<p>Definition at line <a class="el" href="kplayobject_8cc_source.html#l00229">229</a> of file <a class="el" href="kplayobject_8cc_source.html">kplayobject.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a3f0c3f21e884e7526d276942c226e30c"></a><!-- doxytag: member="KDE::PlayObject::isNull" ref="a3f0c3f21e884e7526d276942c226e30c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KDE::PlayObject::isNull </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return true if this != 0. </p>
<p>in essence, ((<a class="el" href="classKDE_1_1PlayObject.html" title="This class acts as a general interface to the KDE multimedia framework.">KDE::PlayObject</a>*)0)-><a class="el" href="classKDE_1_1PlayObject.html#a3f0c3f21e884e7526d276942c226e30c" title="return true if this != 0.">isNull()</a> will not crash </p>
<p>Definition at line <a class="el" href="kplayobject_8cc_source.html#l00289">289</a> of file <a class="el" href="kplayobject_8cc_source.html">kplayobject.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a847de6d7c1b5dfccd838eaeacef5c00f"></a><!-- doxytag: member="KDE::PlayObject::mediaName" ref="a847de6d7c1b5dfccd838eaeacef5c00f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="qstring.html">QString</a> KDE::PlayObject::mediaName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented (Arts::PlayObject Wrapper) </p>
<p>Definition at line <a class="el" href="kplayobject_8cc_source.html#l00270">270</a> of file <a class="el" href="kplayobject_8cc_source.html">kplayobject.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a5d4359f8b70cadb5169afbcffdab682d"></a><!-- doxytag: member="KDE::PlayObject::object" ref="a5d4359f8b70cadb5169afbcffdab682d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Arts::PlayObject KDE::PlayObject::object </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the internal Arts::PlayObject. </p>
<p>Definition at line <a class="el" href="kplayobject_8cc_source.html#l00284">284</a> of file <a class="el" href="kplayobject_8cc_source.html">kplayobject.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a8d7118ecf1c13509872e2bc33fdd3ddf"></a><!-- doxytag: member="KDE::PlayObject::overallTime" ref="a8d7118ecf1c13509872e2bc33fdd3ddf" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Arts::poTime KDE::PlayObject::overallTime </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented (Arts::PlayObject Wrapper) </p>
<p>Definition at line <a class="el" href="kplayobject_8cc_source.html#l00256">256</a> of file <a class="el" href="kplayobject_8cc_source.html">kplayobject.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a5736e78c75926de352969681d3d33fc2"></a><!-- doxytag: member="KDE::PlayObject::pause" ref="a5736e78c75926de352969681d3d33fc2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KDE::PlayObject::pause </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>causes the <a class="el" href="classKDE_1_1PlayObject.html" title="This class acts as a general interface to the KDE multimedia framework.">PlayObject</a> to pause play back immediately. </p>
<p>It will not restart until you call <a class="el" href="classKDE_1_1PlayObject.html#a75758f3435faee4b6876837e583f20b5" title="causes the PlayObject to start the play back.">play()</a>. This also works on streams, the connection to the media source will be maintained while the <a class="el" href="classKDE_1_1PlayObject.html" title="This class acts as a general interface to the KDE multimedia framework.">PlayObject</a> is paused. </p>
<p>Definition at line <a class="el" href="kplayobject_8cc_source.html#l00222">222</a> of file <a class="el" href="kplayobject_8cc_source.html">kplayobject.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a75758f3435faee4b6876837e583f20b5"></a><!-- doxytag: member="KDE::PlayObject::play" ref="a75758f3435faee4b6876837e583f20b5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KDE::PlayObject::play </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>causes the <a class="el" href="classKDE_1_1PlayObject.html" title="This class acts as a general interface to the KDE multimedia framework.">PlayObject</a> to start the play back. </p>
<p>Definition at line <a class="el" href="kplayobject_8cc_source.html#l00173">173</a> of file <a class="el" href="kplayobject_8cc_source.html">kplayobject.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a959cba86158b29b58a700f35fb0aabb2"></a><!-- doxytag: member="KDE::PlayObject::playObjectCreated" ref="a959cba86158b29b58a700f35fb0aabb2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KDE::PlayObject::playObjectCreated </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>this signal is emitted as soon as the internal Arts::PlayObject is created and ready to play. </p>
<p>It is granted that the Arts::PlayObject has not started playing, but <a class="el" href="classKDE_1_1PlayObject.html" title="This class acts as a general interface to the KDE multimedia framework.">KDE::PlayObject</a> will call <a class="el" href="classKDE_1_1PlayObject.html#a5d4359f8b70cadb5169afbcffdab682d" title="Returns the internal Arts::PlayObject.">object()</a>.<a class="el" href="classKDE_1_1PlayObject.html#a75758f3435faee4b6876837e583f20b5" title="causes the PlayObject to start the play back.">play()</a> immediately after emitting this signal, so you need not do it yourself. </p>
</div>
</div>
<a class="anchor" id="aa868bc311037b0624ab52639bda5fd7a"></a><!-- doxytag: member="KDE::PlayObject::seek" ref="aa868bc311037b0624ab52639bda5fd7a" args="(Arts::poTime newTime)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KDE::PlayObject::seek </td>
<td>(</td>
<td class="paramtype">Arts::poTime </td>
<td class="paramname"><em>newTime</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>causes the <a class="el" href="classKDE_1_1PlayObject.html" title="This class acts as a general interface to the KDE multimedia framework.">PlayObject</a> to skip to the time <code>newTime</code>. </p>
<p>You don't need to stop or restart the play back after calling seek. </p>
<p>Definition at line <a class="el" href="kplayobject_8cc_source.html#l00212">212</a> of file <a class="el" href="kplayobject_8cc_source.html">kplayobject.cc</a>.</p>
</div>
</div>
<a class="anchor" id="aab8c0bb73aacba1c85254754420d82b1"></a><!-- doxytag: member="KDE::PlayObject::state" ref="aab8c0bb73aacba1c85254754420d82b1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Arts::poState KDE::PlayObject::state </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>returns the internal state of the <a class="el" href="classKDE_1_1PlayObject.html" title="This class acts as a general interface to the KDE multimedia framework.">PlayObject</a>. </p>
<p>The state can be either Arts::posIdle, Arts::posPaused or Arts::posPlaying. A <a class="el" href="classKDE_1_1PlayObject.html" title="This class acts as a general interface to the KDE multimedia framework.">PlayObject</a> in state Arts::posIdle is stopped. Once you call <a class="el" href="classKDE_1_1PlayObject.html#a75758f3435faee4b6876837e583f20b5" title="causes the PlayObject to start the play back.">play()</a>, the state changes to Arts::posPlaying. <a class="el" href="classKDE_1_1PlayObject.html#a5736e78c75926de352969681d3d33fc2" title="causes the PlayObject to pause play back immediately.">pause()</a> causes the <a class="el" href="classKDE_1_1PlayObject.html" title="This class acts as a general interface to the KDE multimedia framework.">PlayObject</a> to change to Arts::posPaused. </p>
<p>Definition at line <a class="el" href="kplayobject_8cc_source.html#l00277">277</a> of file <a class="el" href="kplayobject_8cc_source.html">kplayobject.cc</a>.</p>
</div>
</div>
<a class="anchor" id="aa591df42992435c5f8a0739582bb7650"></a><!-- doxytag: member="KDE::PlayObject::stream" ref="aa591df42992435c5f8a0739582bb7650" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KDE::PlayObject::stream </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>returns "true" if the content to play is delivered as a stream. </p>
<p>Definition at line <a class="el" href="kplayobject_8cc_source.html#l00298">298</a> of file <a class="el" href="kplayobject_8cc_source.html">kplayobject.cc</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="kplayobject_8h_source.html">kplayobject.h</a></li>
<li><a class="el" href="kplayobject_8cc_source.html">kplayobject.cc</a></li>
</ul>
</div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>arts</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="functions.html">Class Members</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classKArtsDispatcher.html">kartsdispatcher</option>, <option value="classKArtsFloatWatch.html">kartsfloatwatch</option>, <option value="classKArtsServer.html">kartsserver</option>, <option value="classKAudioManagerPlay.html">kaudiomanagerplay</option>, <option value="classKAudioPlayStream.html">kaudioplaystream</option>, <option value="classKAudioRecordStream.html">kaudiorecordstream</option>, <option value="classKDE_1_1PlayObject.html">kde::playobject</option>, <option value="classKDE_1_1PlayObjectFactory.html">kde::playobjectfactory</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../arts/html/index.html">arts</a></li><li><a href="../../dcop/html/index.html">dcop</a></li><li><a href="../../dnssd/html/index.html">dnssd</a></li><li><a href="../../interfaces/html/index.html">interfaces</a></li><li> <a href="../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li> <a href="../../interfaces/kimproxy/library/html/index.html">library</a></li><li> <a href="../../interfaces/kspeech/html/index.html">kspeech</a></li><li> <a href="../../interfaces/ktexteditor/html/index.html">ktexteditor</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kate/html/index.html">kate</a></li><li><a href="../../kcmshell/html/index.html">kcmshell</a></li><li><a href="../../kdecore/html/index.html">kdecore</a></li><li><a href="../../kded/html/index.html">kded</a></li><li><a href="../../kdefx/html/index.html">kdefx</a></li><li><a href="../../kdeprint/html/index.html">kdeprint</a></li><li><a href="../../kdesu/html/index.html">kdesu</a></li><li><a href="../../kdeui/html/index.html">kdeui</a></li><li><a href="../../kdoctools/html/index.html">kdoctools</a></li><li><a href="../../khtml/html/index.html">khtml</a></li><li><a href="../../kimgio/html/index.html">kimgio</a></li><li><a href="../../kinit/html/index.html">kinit</a></li><li><a href="../../kio/html/index.html">kio</a></li><li> <a href="../../kio/bookmarks/html/index.html">bookmarks</a></li><li> <a href="../../kio/httpfilter/html/index.html">httpfilter</a></li><li> <a href="../../kio/kfile/html/index.html">kfile</a></li><li> <a href="../../kio/kio/html/index.html">kio</a></li><li> <a href="../../kio/kioexec/html/index.html">kioexec</a></li><li> <a href="../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li> <a href="../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/http/html/index.html">http</a></li><li><a href="../../kjs/html/index.html">kjs</a></li><li><a href="../../kmdi/html/index.html">kmdi</a></li><li> <a href="../../kmdi/kmdi/html/index.html">kmdi</a></li><li><a href="../../knewstuff/html/index.html">knewstuff</a></li><li><a href="../../kparts/html/index.html">kparts</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../kspell2/html/index.html">kspell2</a></li><li><a href="../../kunittest/html/index.html">kunittest</a></li><li><a href="../../kutils/html/index.html">kutils</a></li><li><a href="../../kwallet/html/index.html">kwallet</a></li><li><a href="../../libkmid/html/index.html">libkmid</a></li><li><a href="../../libkscreensaver/html/index.html">libkscreensaver</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" 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 id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
