File: Phonon.html

package info (click to toggle)
pykde4 4%3A4.14.0-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 30,864 kB
  • ctags: 18,431
  • sloc: python: 2,063; cpp: 327; makefile: 52; sh: 5
file content (258 lines) | stat: -rw-r--r-- 14,098 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
<?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</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">&nbsp;</div>

<h1>Phonon Namespace Reference</h1>
<code>from PyKDE4.phonon.Phonon import *</code>
<p>
<h2>Detailed Description</h2>

<h2>Class Index</h2>
<table width="95%" align="center" border="0" cellpadding="0" cellspacing="0">
<tbody><tr><td><a name="letter_A">&nbsp;&nbsp;A&nbsp;&nbsp;</a></td><td><a name="letter_M">&nbsp;&nbsp;M&nbsp;&nbsp;</a></td><td><a class="el" href="Phonon.Path.html">Path</a>&nbsp;(<a class="el" href="Phonon.html">Phonon</a>)&nbsp;&nbsp;&nbsp;</td></tr>
<tr><td><a class="el" href="Phonon.AbstractAudioOutput.html">AbstractAudioOutput</a>&nbsp;(<a class="el" href="Phonon.html">Phonon</a>)&nbsp;&nbsp;&nbsp;</td><td><a class="el" href="Phonon.MediaController.html">MediaController</a>&nbsp;(<a class="el" href="Phonon.html">Phonon</a>)&nbsp;&nbsp;&nbsp;</td><td><a class="el" href="Phonon.PulseSupport.html">PulseSupport</a>&nbsp;(<a class="el" href="Phonon.html">Phonon</a>)&nbsp;&nbsp;&nbsp;</td></tr>
<tr><td><a class="el" href="Phonon.AbstractMediaStream.html">AbstractMediaStream</a>&nbsp;(<a class="el" href="Phonon.html">Phonon</a>)&nbsp;&nbsp;&nbsp;</td><td><a class="el" href="Phonon.MediaNode.html">MediaNode</a>&nbsp;(<a class="el" href="Phonon.html">Phonon</a>)&nbsp;&nbsp;&nbsp;</td><td><a name="letter_S">&nbsp;&nbsp;S&nbsp;&nbsp;</a></td></tr>
<tr><td><a class="el" href="Phonon.AbstractVideoOutput.html">AbstractVideoOutput</a>&nbsp;(<a class="el" href="Phonon.html">Phonon</a>)&nbsp;&nbsp;&nbsp;</td><td><a class="el" href="Phonon.MediaObject.html">MediaObject</a>&nbsp;(<a class="el" href="Phonon.html">Phonon</a>)&nbsp;&nbsp;&nbsp;</td><td><a class="el" href="Phonon.SeekSlider.html">SeekSlider</a>&nbsp;(<a class="el" href="Phonon.html">Phonon</a>)&nbsp;&nbsp;&nbsp;</td></tr>
<tr><td><a class="el" href="Phonon.AudioDataOutput.html">AudioDataOutput</a>&nbsp;(<a class="el" href="Phonon.html">Phonon</a>)&nbsp;&nbsp;&nbsp;</td><td><a class="el" href="Phonon.MediaSource.html">MediaSource</a>&nbsp;(<a class="el" href="Phonon.html">Phonon</a>)&nbsp;&nbsp;&nbsp;</td><td><a class="el" href="Phonon.StreamInterface.html">StreamInterface</a>&nbsp;(<a class="el" href="Phonon.html">Phonon</a>)&nbsp;&nbsp;&nbsp;</td></tr>
<tr><td><a class="el" href="Phonon.AudioOutput.html">AudioOutput</a>&nbsp;(<a class="el" href="Phonon.html">Phonon</a>)&nbsp;&nbsp;&nbsp;</td><td><a class="el" href="Phonon.Mrl.html">Mrl</a>&nbsp;(<a class="el" href="Phonon.html">Phonon</a>)&nbsp;&nbsp;&nbsp;</td><td><a name="letter_V">&nbsp;&nbsp;V&nbsp;&nbsp;</a></td></tr>
<tr><td><a name="letter_E">&nbsp;&nbsp;E&nbsp;&nbsp;</a></td><td><a name="letter_N">&nbsp;&nbsp;N&nbsp;&nbsp;</a></td><td><a class="el" href="Phonon.VideoPlayer.html">VideoPlayer</a>&nbsp;(<a class="el" href="Phonon.html">Phonon</a>)&nbsp;&nbsp;&nbsp;</td></tr>
<tr><td><a class="el" href="Phonon.Effect.html">Effect</a>&nbsp;(<a class="el" href="Phonon.html">Phonon</a>)&nbsp;&nbsp;&nbsp;</td><td><a class="el" href="Phonon.BackendCapabilities.Notifier.html">Notifier</a>&nbsp;(<a class="el" href="Phonon.BackendCapabilities.html">Phonon.BackendCapabilities</a>)&nbsp;&nbsp;&nbsp;</td><td><a class="el" href="Phonon.VideoWidget.html">VideoWidget</a>&nbsp;(<a class="el" href="Phonon.html">Phonon</a>)&nbsp;&nbsp;&nbsp;</td></tr>
<tr><td><a class="el" href="Phonon.EffectParameter.html">EffectParameter</a>&nbsp;(<a class="el" href="Phonon.html">Phonon</a>)&nbsp;&nbsp;&nbsp;</td><td><a name="letter_O">&nbsp;&nbsp;O&nbsp;&nbsp;</a></td><td><a class="el" href="Phonon.VideoWidgetInterface.html">VideoWidgetInterface</a>&nbsp;(<a class="el" href="Phonon.html">Phonon</a>)&nbsp;&nbsp;&nbsp;</td></tr>
<tr><td><a class="el" href="Phonon.EffectWidget.html">EffectWidget</a>&nbsp;(<a class="el" href="Phonon.html">Phonon</a>)&nbsp;&nbsp;&nbsp;</td><td><a class="el" href="Phonon.ObjectDescriptionData.html">ObjectDescriptionData</a>&nbsp;(<a class="el" href="Phonon.html">Phonon</a>)&nbsp;&nbsp;&nbsp;</td><td><a class="el" href="Phonon.VolumeFaderEffect.html">VolumeFaderEffect</a>&nbsp;(<a class="el" href="Phonon.html">Phonon</a>)&nbsp;&nbsp;&nbsp;</td></tr>
<tr><td><a name="letter_G">&nbsp;&nbsp;G&nbsp;&nbsp;</a></td><td><a class="el" href="Phonon.ObjectDescriptionModelData.html">ObjectDescriptionModelData</a>&nbsp;(<a class="el" href="Phonon.html">Phonon</a>)&nbsp;&nbsp;&nbsp;</td><td><a class="el" href="Phonon.VolumeSlider.html">VolumeSlider</a>&nbsp;(<a class="el" href="Phonon.html">Phonon</a>)&nbsp;&nbsp;&nbsp;</td></tr>
<tr><td><a class="el" href="Phonon.GlobalConfig.html">GlobalConfig</a>&nbsp;(<a class="el" href="Phonon.html">Phonon</a>)&nbsp;&nbsp;&nbsp;</td><td><a name="letter_P">&nbsp;&nbsp;P&nbsp;&nbsp;</a></td><td></td></tr>
</table>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#ObjectDescriptionType">ObjectDescriptionType</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;AudioOutputDeviceType, EffectType, AudioChannelType, SubtitleType, AudioCaptureDeviceType, VideoCaptureDeviceType&nbsp;}</td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../phonon/Phonon.Path.html">Phonon.Path</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#createPath">createPath</a> (<a href="../phonon/Phonon.MediaNode.html">Phonon.MediaNode</a> source, <a href="../phonon/Phonon.MediaNode.html">Phonon.MediaNode</a> sink)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../phonon/Phonon.MediaObject.html">Phonon.MediaObject</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#createPlayer">createPlayer</a> (Phonon::Category category, <a href="../phonon/Phonon.MediaSource.html">Phonon.MediaSource</a> source=Phonon.MediaSource())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#qHash">qHash</a> (<a href="../phonon/Phonon.EffectParameter.html">Phonon.EffectParameter</a> param)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#registerMetaTypes">registerMetaTypes</a> ()</td></tr>
</table>
<hr><h2>Enumeration Documentation</h2><a class="anchor" name="ObjectDescriptionType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">ObjectDescriptionType</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Defines the type of information that is contained in a ObjectDescription
object.
</p>
<p>
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>AudioOutputDeviceType</em>&nbsp;</td><td><tr><td valign="top"><em>EffectType</em>&nbsp;</td><td><tr><td valign="top"><em>AudioChannelType</em>&nbsp;</td><td><tr><td valign="top"><em>SubtitleType</em>&nbsp;</td><td><tr><td valign="top"><em>AudioCaptureDeviceType</em>&nbsp;</td><td><tr><td valign="top"><em>VideoCaptureDeviceType</em>&nbsp;</td><td></table>
</dl>
</div></div><p><hr><h2>Function Documentation</h2><a class="anchor" name="createPath"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../phonon/Phonon.Path.html">Phonon.Path</a> createPath</td>
<td>(</td>
<td class="paramtype"><a href="../phonon/Phonon.MediaNode.html">Phonon.MediaNode</a>&nbsp;</td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../phonon/Phonon.MediaNode.html">Phonon.MediaNode</a>&nbsp;</td>
<td class="paramname"><em>sink</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Creates a new Path connecting two MediaNodes.
</p>
<p>
The implementation will automatically select the right format and media type. E.g. connecting a
MediaObject and AudioOutput will create a Path object connecting the audio. This might be
represented as PCM or perhaps even AC3 depending on the AudioOutput object.
</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>&nbsp;</td><td> The MediaNode to connect an output from
</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>sink</em>&nbsp;</td><td> The MediaNode to connect to.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="createPlayer"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../phonon/Phonon.MediaObject.html">Phonon.MediaObject</a> createPlayer</td>
<td>(</td>
<td class="paramtype">Phonon::Category&nbsp;</td>
<td class="paramname"><em>category</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../phonon/Phonon.MediaSource.html">Phonon.MediaSource</a>&nbsp;</td>
<td class="paramname"><em>source=Phonon.MediaSource()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Convenience function to create a MediaObject and AudioOutput connected by
a path.
</p></div></div><a class="anchor" name="qHash"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">long qHash</td>
<td>(</td>
<td class="paramtype"><a href="../phonon/Phonon.EffectParameter.html">Phonon.EffectParameter</a>&nbsp;</td>
<td class="paramname"><em>param</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>\class EffectParameter effectparameter.h phonon/EffectParameter
This class describes one parameter of an effect.
</p>
<p>

<dl class="author" compact><dt><b>Author:</b></dt><dd> Matthias Kretz &lt;kretz@kde.org&gt; </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd> Effect
</dd></dl>
</p></div></div><a class="anchor" name="registerMetaTypes"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> registerMetaTypes</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Information about methods for accessing a device
</p>
<p>
It is used by the platform plugin or the backend to provide information about how
to access a certain device. To access a device, one needs the driver name (alsa, oss,
pulse for example), and the device name (dependent on the driver name). This type
is essentialy a list of pairs of driver and device names.
</p>
<p>
It can be put in an ObjectDescriptionData property list.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> DeviceAccess
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> AudioCaptureDevice
</dd></dl>
</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="&#109;&#97;&#105;&#108;&#116;&#111;&#58;simon&#64;simonzone&#46;com">Simon Edwards</a>.<br />
        KDE<sup>&#174;</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>&#174;</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>