<?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::PlayObjectFactory 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.5.5 --> <div class="navpath"><a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/namespaceKDE.html">KDE</a>::<a class="el" href="classKDE_1_1PlayObjectFactory.html">PlayObjectFactory</a> </div> <div class="contents"> <h1>KDE::PlayObjectFactory Class Reference</h1><!-- doxytag: class="KDE::PlayObjectFactory" --><code>#include <<a class="el" href="kplayobjectfactory_8h-source.html">kplayobjectfactory.h</a>></code> <p> <p> <a href="classKDE_1_1PlayObjectFactory-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> This class implements a factory to create KDE::PlayObjects for a given URL and mimetype. <p> A detailed description about how to use the <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/namespaceKDE.html">KDE</a> multimedia framework can be found in the documentation for <a class="el" href="classKDE_1_1PlayObject.html" title="This class acts as a general interface to the KDE multimedia framework.">KDE::PlayObject</a>. <p>Definition at line <a class="el" href="kplayobjectfactory_8h-source.html#l00079">79</a> of file <a class="el" href="kplayobjectfactory_8h-source.html">kplayobjectfactory.h</a>.</p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDE_1_1PlayObjectFactory.html#8f65571be89b959229a3da0481d07848">PlayObjectFactory</a> (Arts::SoundServerV2 server)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDE_1_1PlayObjectFactory.html#4eb006e7d687fda3221f4adead394240">PlayObjectFactory</a> (<a class="el" href="classKArtsServer.html">KArtsServer</a> *server)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDE_1_1PlayObjectFactory.html#2f67af3945176f2f79f5064fc69093dd">setAudioManagerPlay</a> (<a class="el" href="classKAudioManagerPlay.html">KAudioManagerPlay</a> *amanplay)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classKDE_1_1PlayObject.html">KDE::PlayObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDE_1_1PlayObjectFactory.html#0f6a19e68b13b1fabbbf7158dad750e3">createPlayObject</a> (const <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKURL.html">KURL</a> &url, bool createBUS)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classKDE_1_1PlayObject.html">KDE::PlayObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDE_1_1PlayObjectFactory.html#9e7b9cd49970b30ebc1e706ff35f189d">createPlayObject</a> (const <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKURL.html">KURL</a> &url, const <a class="elRef" doxygen="qt.tag:/usr/lib/qt3/doc/html/" href="/usr/lib/qt3/doc/html/qstring.html">QString</a> &mimetype, bool createBUS)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDE_1_1PlayObjectFactory.html#b89339ab6aea0dcb110b8ffa8cea4dcb">setAllowStreaming</a> (bool s)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDE_1_1PlayObjectFactory.html#ac5ec706107557cbbf010e735a3904c6">allowStreaming</a> ()</td></tr> <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="elRef" doxygen="qt.tag:/usr/lib/qt3/doc/html/" href="/usr/lib/qt3/doc/html/qstringlist.html">QStringList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDE_1_1PlayObjectFactory.html#0db43a9da0261b4ae11422aa31633528">mimeTypes</a> (void)</td></tr> </table> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="8f65571be89b959229a3da0481d07848"></a><!-- doxytag: member="KDE::PlayObjectFactory::PlayObjectFactory" ref="8f65571be89b959229a3da0481d07848" args="(Arts::SoundServerV2 server)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">KDE::PlayObjectFactory::PlayObjectFactory </td> <td>(</td> <td class="paramtype">Arts::SoundServerV2 </td> <td class="paramname"> <em>server</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Creates 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> <code>server</code> is an Arts::SoundServerV2 <p>Definition at line <a class="el" href="kplayobjectfactory_8cc-source.html#l00097">97</a> of file <a class="el" href="kplayobjectfactory_8cc-source.html">kplayobjectfactory.cc</a>.</p> </div> </div><p> <a class="anchor" name="4eb006e7d687fda3221f4adead394240"></a><!-- doxytag: member="KDE::PlayObjectFactory::PlayObjectFactory" ref="4eb006e7d687fda3221f4adead394240" args="(KArtsServer *server)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">KDE::PlayObjectFactory::PlayObjectFactory </td> <td>(</td> <td class="paramtype"><a class="el" href="classKArtsServer.html">KArtsServer</a> * </td> <td class="paramname"> <em>server</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Convenience constructor to pass a <a class="el" href="classKArtsServer.html" title="KArtsServer is a wrapper to conveniently get a reference to a SoundServer, and restart...">KArtsServer</a> instead of an Arts::SoundServerV2. <p> This equivalent to calling <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>( server.server() ).<p> <dl class="since" compact><dt><b>Since:</b></dt><dd>3.2 </dd></dl> <p>Definition at line <a class="el" href="kplayobjectfactory_8cc-source.html#l00107">107</a> of file <a class="el" href="kplayobjectfactory_8cc-source.html">kplayobjectfactory.cc</a>.</p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="2f67af3945176f2f79f5064fc69093dd"></a><!-- doxytag: member="KDE::PlayObjectFactory::setAudioManagerPlay" ref="2f67af3945176f2f79f5064fc69093dd" args="(KAudioManagerPlay *amanplay)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void KDE::PlayObjectFactory::setAudioManagerPlay </td> <td>(</td> <td class="paramtype"><a class="el" href="classKAudioManagerPlay.html">KAudioManagerPlay</a> * </td> <td class="paramname"> <em>amanplay</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> If this is set the <a class="el" href="classKDE_1_1PlayObject.html" title="This class acts as a general interface to the KDE multimedia framework.">PlayObject</a> doesn't create a Synth_BUS_UPLINK at all but always uses the Synth_AMAN_PLAY that you passed. <p> <p>Definition at line <a class="el" href="kplayobjectfactory_8cc-source.html#l00123">123</a> of file <a class="el" href="kplayobjectfactory_8cc-source.html">kplayobjectfactory.cc</a>.</p> </div> </div><p> <a class="anchor" name="0f6a19e68b13b1fabbbf7158dad750e3"></a><!-- doxytag: member="KDE::PlayObjectFactory::createPlayObject" ref="0f6a19e68b13b1fabbbf7158dad750e3" args="(const KURL &url, bool createBUS)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classKDE_1_1PlayObject.html">KDE::PlayObject</a> * KDE::PlayObjectFactory::createPlayObject </td> <td>(</td> <td class="paramtype">const <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKURL.html">KURL</a> & </td> <td class="paramname"> <em>url</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>createBUS</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> 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> to play back the file or stream <code>url</code> points to. <p> Set <code>createBUS</code> to "true", if you want 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 be connected to a SYNTH_BUS_UPLINK on creation. This is usually the case. You only need to set this to "false" if you want to attach your own sound effects to 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> You don't need to know the mimetype of the file or stream, it will be detected automatically. <p>Definition at line <a class="el" href="kplayobjectfactory_8cc-source.html#l00130">130</a> of file <a class="el" href="kplayobjectfactory_8cc-source.html">kplayobjectfactory.cc</a>.</p> </div> </div><p> <a class="anchor" name="9e7b9cd49970b30ebc1e706ff35f189d"></a><!-- doxytag: member="KDE::PlayObjectFactory::createPlayObject" ref="9e7b9cd49970b30ebc1e706ff35f189d" args="(const KURL &url, const QString &mimetype, bool createBUS)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classKDE_1_1PlayObject.html">KDE::PlayObject</a> * KDE::PlayObjectFactory::createPlayObject </td> <td>(</td> <td class="paramtype">const <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKURL.html">KURL</a> & </td> <td class="paramname"> <em>url</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="elRef" doxygen="qt.tag:/usr/lib/qt3/doc/html/" href="/usr/lib/qt3/doc/html/qstring.html">QString</a> & </td> <td class="paramname"> <em>mimetype</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>createBUS</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> This method also 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>, but does no automatic mimetype detection. <p> Use this method with care. <p>Definition at line <a class="el" href="kplayobjectfactory_8cc-source.html#l00136">136</a> of file <a class="el" href="kplayobjectfactory_8cc-source.html">kplayobjectfactory.cc</a>.</p> </div> </div><p> <a class="anchor" name="b89339ab6aea0dcb110b8ffa8cea4dcb"></a><!-- doxytag: member="KDE::PlayObjectFactory::setAllowStreaming" ref="b89339ab6aea0dcb110b8ffa8cea4dcb" args="(bool s)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void KDE::PlayObjectFactory::setAllowStreaming </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"> <em>s</em> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> setAllowStreaming( true ) allows the factory to create a streaming <a class="el" href="classKDE_1_1PlayObject.html" title="This class acts as a general interface to the KDE multimedia framework.">PlayObject</a> for a non-local URL. <p> This is also the default. Usually, you should not need to set this to false. <p>Definition at line <a class="el" href="kplayobjectfactory_8h-source.html#l00126">126</a> of file <a class="el" href="kplayobjectfactory_8h-source.html">kplayobjectfactory.h</a>.</p> </div> </div><p> <a class="anchor" name="ac5ec706107557cbbf010e735a3904c6"></a><!-- doxytag: member="KDE::PlayObjectFactory::allowStreaming" ref="ac5ec706107557cbbf010e735a3904c6" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool KDE::PlayObjectFactory::allowStreaming </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> returns "true" if the factory is allowed to create streaming PlayObjects. <p> <p>Definition at line <a class="el" href="kplayobjectfactory_8h-source.html#l00132">132</a> of file <a class="el" href="kplayobjectfactory_8h-source.html">kplayobjectfactory.h</a>.</p> </div> </div><p> <a class="anchor" name="0db43a9da0261b4ae11422aa31633528"></a><!-- doxytag: member="KDE::PlayObjectFactory::mimeTypes" ref="0db43a9da0261b4ae11422aa31633528" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" doxygen="qt.tag:/usr/lib/qt3/doc/html/" href="/usr/lib/qt3/doc/html/qstringlist.html">QStringList</a> KDE::PlayObjectFactory::mimeTypes </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Return the mimetypes that are playable. <p> <p>Definition at line <a class="el" href="kplayobjectfactory_8cc-source.html#l00190">190</a> of file <a class="el" href="kplayobjectfactory_8cc-source.html">kplayobjectfactory.cc</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="kplayobjectfactory_8h-source.html">kplayobjectfactory.h</a><li><a class="el" href="kplayobjectfactory_8cc-source.html">kplayobjectfactory.cc</a></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>