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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ParoleStream</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="home" href="index.html" title="Parole Plugins Reference Manual">
<link rel="up" href="API.html" title="Part IV. Parole Plugin Reference">
<link rel="prev" href="Parole-Plugins-parole-provider-player.html" title="ParoleProviderPlayer">
<link rel="next" href="Utils.html" title="Part V. Parole Utilities">
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="Intro.html" title="Part I. Introduction">
<link rel="part" href="parole-plugins-tut.html" title="Part II. Parole Plugin Tutorial">
<link rel="part" href="fundamentals.html" title="Part III. Fundamentals">
<link rel="part" href="API.html" title="Part IV. Parole Plugin Reference">
<link rel="part" href="Utils.html" title="Part V. Parole Utilities">
<link rel="index" href="api-index-full.html" title="API Index">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="Parole-Plugins-parole-provider-player.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="API.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Parole Plugins Reference Manual</th>
<td><a accesskey="n" href="Utils.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#ParoleStream.synopsis" class="shortcut">Top</a>
|
<a href="#ParoleStream.description" class="shortcut">Description</a>
|
<a href="#ParoleStream.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#ParoleStream.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" lang="en">
<a name="ParoleStream"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ParoleStream.top_of_page"></a>ParoleStream</span></h2>
<p>ParoleStream — Currently playing stream.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="ParoleStream.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">enum <a href="ParoleStream.html#ParoleMediaType">ParoleMediaType</a>;
<a href="ParoleStream.html#ParoleStream-struct">ParoleStream</a>;
</pre>
</div>
<div class="refsect1" lang="en">
<a name="ParoleStream.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----ParoleStream
</pre>
</div>
<div class="refsect1" lang="en">
<a name="ParoleStream.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="ParoleStream.html#ParoleStream--absolute-duration">absolute-duration</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> : Read / Write
"<a href="ParoleStream.html#ParoleStream--album">album</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
"<a href="ParoleStream.html#ParoleStream--artist">artist</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
"<a href="ParoleStream.html#ParoleStream--comment">comment</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
"<a href="ParoleStream.html#ParoleStream--disp-par-d">disp-par-d</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write
"<a href="ParoleStream.html#ParoleStream--disp-par-n">disp-par-n</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write
"<a href="ParoleStream.html#ParoleStream--duration">duration</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> : Read / Write
"<a href="ParoleStream.html#ParoleStream--has-audio">has-audio</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
"<a href="ParoleStream.html#ParoleStream--has-video">has-video</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
"<a href="ParoleStream.html#ParoleStream--live">live</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
"<a href="ParoleStream.html#ParoleStream--media-type">media-type</a>" <a href="ParoleStream.html#ParoleMediaType"><span class="type">ParoleMediaType</span></a> : Read / Write
"<a href="ParoleStream.html#ParoleStream--num-tracks">num-tracks</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write
"<a href="ParoleStream.html#ParoleStream--seekable">seekable</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
"<a href="ParoleStream.html#ParoleStream--subtitles">subtitles</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
"<a href="ParoleStream.html#ParoleStream--tag-available">tag-available</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
"<a href="ParoleStream.html#ParoleStream--title">title</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
"<a href="ParoleStream.html#ParoleStream--track">track</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write
"<a href="ParoleStream.html#ParoleStream--uri">uri</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
"<a href="ParoleStream.html#ParoleStream--video-height">video-height</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
"<a href="ParoleStream.html#ParoleStream--video-width">video-width</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
"<a href="ParoleStream.html#ParoleStream--year">year</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="ParoleStream.description"></a><h2>Description</h2>
<p>
This object contains all the information describing the current processed stream
by Parole, this object is used with the callback function the <a href="Parole-Plugins-parole-provider-player.html#ParoleProviderPlayerIface-state-changed"><span class="type">"state-changed"</span></a>
signal of the player, the plugin shouldn't take reference and all the properties are read-only for the plugins.s
</p>
</div>
<div class="refsect1" lang="en">
<a name="ParoleStream.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="ParoleMediaType"></a><h3>enum ParoleMediaType</h3>
<pre class="programlisting">typedef enum
{
PAROLE_MEDIA_TYPE_UNKNOWN,
PAROLE_MEDIA_TYPE_LOCAL_FILE,
PAROLE_MEDIA_TYPE_CDDA,
PAROLE_MEDIA_TYPE_VCD,
PAROLE_MEDIA_TYPE_SVCD,
PAROLE_MEDIA_TYPE_DVD,
PAROLE_MEDIA_TYPE_DVB,
PAROLE_MEDIA_TYPE_REMOTE
} ParoleMediaType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="ParoleStream-struct"></a><h3>ParoleStream</h3>
<pre class="programlisting">typedef struct _ParoleStream ParoleStream;</pre>
<p>
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="ParoleStream.property-details"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="ParoleStream--absolute-duration"></a><h3>The <code class="literal">"absolute-duration"</code> property</h3>
<pre class="programlisting"> "absolute-duration" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> : Read / Write</pre>
<p>Absolution duration.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="ParoleStream--album"></a><h3>The <code class="literal">"album"</code> property</h3>
<pre class="programlisting"> "album" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
<p>Album.</p>
<p>Default value: NULL</p>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="ParoleStream--artist"></a><h3>The <code class="literal">"artist"</code> property</h3>
<pre class="programlisting"> "artist" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
<p>Artist.</p>
<p>Default value: NULL</p>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="ParoleStream--comment"></a><h3>The <code class="literal">"comment"</code> property</h3>
<pre class="programlisting"> "comment" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
<p>
Extra comment block.</p>
<p>Default value: NULL</p>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="ParoleStream--disp-par-d"></a><h3>The <code class="literal">"disp-par-d"</code> property</h3>
<pre class="programlisting"> "disp-par-d" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write</pre>
<p>Disp par d.</p>
<p>Allowed values: >= 1</p>
<p>Default value: 1</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="ParoleStream--disp-par-n"></a><h3>The <code class="literal">"disp-par-n"</code> property</h3>
<pre class="programlisting"> "disp-par-n" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write</pre>
<p>Disp par n.</p>
<p>Allowed values: >= 1</p>
<p>Default value: 1</p>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="ParoleStream--duration"></a><h3>The <code class="literal">"duration"</code> property</h3>
<pre class="programlisting"> "duration" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> : Read / Write</pre>
<p>Duration.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="ParoleStream--has-audio"></a><h3>The <code class="literal">"has-audio"</code> property</h3>
<pre class="programlisting"> "has-audio" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
<p>
Whether the stream has audio.</p>
<p>Default value: FALSE</p>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="ParoleStream--has-video"></a><h3>The <code class="literal">"has-video"</code> property</h3>
<pre class="programlisting"> "has-video" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
<p>
Whether the stream has video.</p>
<p>Default value: FALSE</p>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="ParoleStream--live"></a><h3>The <code class="literal">"live"</code> property</h3>
<pre class="programlisting"> "live" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
<p>
Whether the stream is a live stream.</p>
<p>Default value: FALSE</p>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="ParoleStream--media-type"></a><h3>The <code class="literal">"media-type"</code> property</h3>
<pre class="programlisting"> "media-type" <a href="ParoleStream.html#ParoleMediaType"><span class="type">ParoleMediaType</span></a> : Read / Write</pre>
<p>
The media type.</p>
<p>Default value: PAROLE_MEDIA_TYPE_UNKNOWN</p>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="ParoleStream--num-tracks"></a><h3>The <code class="literal">"num-tracks"</code> property</h3>
<pre class="programlisting"> "num-tracks" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write</pre>
<p>
Number of tracks in the cdda source, only valid if
ParoleStream:media-type: is PAROLE_MEDIA_TYPE_CDDA.</p>
<p>Allowed values: [1,99]</p>
<p>Default value: 1</p>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="ParoleStream--seekable"></a><h3>The <code class="literal">"seekable"</code> property</h3>
<pre class="programlisting"> "seekable" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
<p>
Whether the stream is seekable, for example live
streams are not seekable.</p>
<p>Default value: FALSE</p>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="ParoleStream--subtitles"></a><h3>The <code class="literal">"subtitles"</code> property</h3>
<pre class="programlisting"> "subtitles" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
<p>
Subtitles path, this is only valid if the property
"media-type" has the value PAROLE_MEDIA_TYPE_LOCAL_FILE.</p>
<p>Default value: NULL</p>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="ParoleStream--tag-available"></a><h3>The <code class="literal">"tag-available"</code> property</h3>
<pre class="programlisting"> "tag-available" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
<p>
Whether tags information are available on the current stream.</p>
<p>Default value: FALSE</p>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="ParoleStream--title"></a><h3>The <code class="literal">"title"</code> property</h3>
<pre class="programlisting"> "title" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
<p>Title.</p>
<p>Default value: NULL</p>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="ParoleStream--track"></a><h3>The <code class="literal">"track"</code> property</h3>
<pre class="programlisting"> "track" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write</pre>
<p>
Currently playing track, this is only valid if
<a href="ParoleStream.html#ParoleStream--media-type"><span class="type">"media-type"</span></a>: is PAROLE_MEDIA_TYPE_CDDA.</p>
<p>Allowed values: [1,99]</p>
<p>Default value: 1</p>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="ParoleStream--uri"></a><h3>The <code class="literal">"uri"</code> property</h3>
<pre class="programlisting"> "uri" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
<p>
Currently loaded uri.</p>
<p>Default value: NULL</p>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="ParoleStream--video-height"></a><h3>The <code class="literal">"video-height"</code> property</h3>
<pre class="programlisting"> "video-height" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write</pre>
<p>Video height.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="ParoleStream--video-width"></a><h3>The <code class="literal">"video-width"</code> property</h3>
<pre class="programlisting"> "video-width" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write</pre>
<p>Video width.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="ParoleStream--year"></a><h3>The <code class="literal">"year"</code> property</h3>
<pre class="programlisting"> "year" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
<p>Year.</p>
<p>Default value: NULL</p>
<p class="since">Since 0.2</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="ParoleStream.see-also"></a><h2>See Also</h2>
<p>
<a href="Parole-Plugins-parole-provider-player.html#ParoleProviderPlayer"><span class="type">ParoleProviderPlayer</span></a>
</p>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.13</div>
</body>
</html>
|
