← Back to branch summary

~ubuntu-branches/ubuntu/precise/clutter-1.0/precise

« back to all changes in this revision

Viewing changes to doc/reference/clutter/xml/clutter-media.xml

  • Committer: Bazaar Package Importer
  • Author(s): Emilio Pozuelo Monfort
  • Date: 2010-03-21 13:27:56 UTC
  • mto: (2.1.3 experimental) (1.3.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 8.
  • Revision ID: james.westby@ubuntu.com-20100321132756-nf8yd30yxo3zzwcm
Tags: upstream-1.2.2
Import upstream version 1.2.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/clutter/xml/clutter-media.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4
 
<!ENTITY version "1.0.8">
5
 
]>
6
 
 
7
 
<refentry id="ClutterMedia">
8
 
<refmeta>
9
 
<refentrytitle role="top_of_page" id="ClutterMedia.top_of_page">ClutterMedia</refentrytitle>
10
 
<manvolnum>3</manvolnum>
11
 
<refmiscinfo>CLUTTER Library</refmiscinfo>
12
 
</refmeta>
13
 
 
14
 
<refnamediv>
15
 
<refname>ClutterMedia</refname>
16
 
<refpurpose>An interface for controlling playback of media data</refpurpose>
17
 
</refnamediv>
18
 
 
19
 
<refsynopsisdiv id="ClutterMedia.synopsis" role="synopsis">
20
 
<title role="synopsis.title">Synopsis</title>
21
 
 
22
 
<synopsis>
23
 
                    <link linkend="ClutterMedia-struct">ClutterMedia</link>;
24
 
                    <link linkend="ClutterMediaIface">ClutterMediaIface</link>;
25
 
<link linkend="void">void</link>                <link linkend="clutter-media-set-uri">clutter_media_set_uri</link>               (<link linkend="ClutterMedia">ClutterMedia</link> *media,
26
 
                                                         const <link linkend="gchar">gchar</link> *uri);
27
 
<link linkend="gchar">gchar</link> *             <link linkend="clutter-media-get-uri">clutter_media_get_uri</link>               (<link linkend="ClutterMedia">ClutterMedia</link> *media);
28
 
<link linkend="void">void</link>                <link linkend="clutter-media-set-playing">clutter_media_set_playing</link>           (<link linkend="ClutterMedia">ClutterMedia</link> *media,
29
 
                                                         <link linkend="gboolean">gboolean</link> playing);
30
 
<link linkend="gboolean">gboolean</link>            <link linkend="clutter-media-get-playing">clutter_media_get_playing</link>           (<link linkend="ClutterMedia">ClutterMedia</link> *media);
31
 
<link linkend="void">void</link>                <link linkend="clutter-media-set-progress">clutter_media_set_progress</link>          (<link linkend="ClutterMedia">ClutterMedia</link> *media,
32
 
                                                         <link linkend="gdouble">gdouble</link> progress);
33
 
<link linkend="gdouble">gdouble</link>             <link linkend="clutter-media-get-progress">clutter_media_get_progress</link>          (<link linkend="ClutterMedia">ClutterMedia</link> *media);
34
 
<link linkend="void">void</link>                <link linkend="clutter-media-set-audio-volume">clutter_media_set_audio_volume</link>      (<link linkend="ClutterMedia">ClutterMedia</link> *media,
35
 
                                                         <link linkend="gdouble">gdouble</link> volume);
36
 
<link linkend="gdouble">gdouble</link>             <link linkend="clutter-media-get-audio-volume">clutter_media_get_audio_volume</link>      (<link linkend="ClutterMedia">ClutterMedia</link> *media);
37
 
<link linkend="gboolean">gboolean</link>            <link linkend="clutter-media-get-can-seek">clutter_media_get_can_seek</link>          (<link linkend="ClutterMedia">ClutterMedia</link> *media);
38
 
<link linkend="gdouble">gdouble</link>             <link linkend="clutter-media-get-buffer-fill">clutter_media_get_buffer_fill</link>       (<link linkend="ClutterMedia">ClutterMedia</link> *media);
39
 
<link linkend="gdouble">gdouble</link>             <link linkend="clutter-media-get-duration">clutter_media_get_duration</link>          (<link linkend="ClutterMedia">ClutterMedia</link> *media);
40
 
<link linkend="void">void</link>                <link linkend="clutter-media-set-filename">clutter_media_set_filename</link>          (<link linkend="ClutterMedia">ClutterMedia</link> *media,
41
 
                                                         const <link linkend="gchar">gchar</link> *filename);
42
 
</synopsis>
43
 
</refsynopsisdiv>
44
 
 
45
 
<refsect1 id="ClutterMedia.object-hierarchy" role="object_hierarchy">
46
 
<title role="object_hierarchy.title">Object Hierarchy</title>
47
 
<synopsis>
48
 
  <link linkend="GInterface">GInterface</link>
49
 
   +----ClutterMedia
50
 
</synopsis>
51
 
</refsect1>
52
 
 
53
 
 
54
 
 
55
 
 
56
 
 
57
 
<refsect1 id="ClutterMedia.properties" role="properties">
58
 
<title role="properties.title">Properties</title>
59
 
<synopsis>
60
 
  &quot;<link linkend="ClutterMedia--audio-volume">audio-volume</link>&quot;             <link linkend="gdouble">gdouble</link>               : Read / Write
61
 
  &quot;<link linkend="ClutterMedia--buffer-fill">buffer-fill</link>&quot;              <link linkend="gdouble">gdouble</link>               : Read
62
 
  &quot;<link linkend="ClutterMedia--can-seek">can-seek</link>&quot;                 <link linkend="gboolean">gboolean</link>              : Read
63
 
  &quot;<link linkend="ClutterMedia--duration">duration</link>&quot;                 <link linkend="gdouble">gdouble</link>               : Read
64
 
  &quot;<link linkend="ClutterMedia--playing">playing</link>&quot;                  <link linkend="gboolean">gboolean</link>              : Read / Write
65
 
  &quot;<link linkend="ClutterMedia--progress">progress</link>&quot;                 <link linkend="gdouble">gdouble</link>               : Read / Write
66
 
  &quot;<link linkend="ClutterMedia--uri">uri</link>&quot;                      <link linkend="gchar">gchar</link>*                : Read / Write
67
 
</synopsis>
68
 
</refsect1>
69
 
 
70
 
<refsect1 id="ClutterMedia.signals" role="signal_proto">
71
 
<title role="signal_proto.title">Signals</title>
72
 
<synopsis>
73
 
  &quot;<link linkend="ClutterMedia-eos">eos</link>&quot;                                            : Run Last
74
 
  &quot;<link linkend="ClutterMedia-error">error</link>&quot;                                          : Run Last
75
 
</synopsis>
76
 
</refsect1>
77
 
 
78
 
 
79
 
<refsect1 id="ClutterMedia.description" role="desc">
80
 
<title role="desc.title">Description</title>
81
 
<para>
82
 
<link linkend="ClutterMedia"><type>ClutterMedia</type></link> is an interface for controlling playback of media sources.
83
 
</para>
84
 
<para>
85
 
Clutter core does not provide an implementation of this interface, but
86
 
other integration libraries like Clutter-GStreamer implement it to offer
87
 
a uniform API for applications.
88
 
</para>
89
 
<para>
90
 
<link linkend="ClutterMedia"><type>ClutterMedia</type></link> is available since Clutter 0.2</para>
91
 
<para>
92
 
</para>
93
 
</refsect1>
94
 
 
95
 
<refsect1 id="ClutterMedia.details" role="details">
96
 
<title role="details.title">Details</title>
97
 
<refsect2 id="ClutterMedia-struct" role="struct">
98
 
<title>ClutterMedia</title>
99
 
<indexterm zone="ClutterMedia-struct"><primary sortas="Media">ClutterMedia</primary></indexterm><programlisting>typedef struct _ClutterMedia ClutterMedia;</programlisting>
100
 
<para>
101
 
</para></refsect2>
102
 
<refsect2 id="ClutterMediaIface" role="struct" condition="since:0.2">
103
 
<title>ClutterMediaIface</title>
104
 
<indexterm zone="ClutterMediaIface" role="0.2"><primary sortas="MediaIface">ClutterMediaIface</primary></indexterm><programlisting>typedef struct {
105
 
} ClutterMediaIface;
106
 
</programlisting>
107
 
<para>
108
 
Interface vtable for <link linkend="ClutterMedia"><type>ClutterMedia</type></link> implementations</para>
109
 
<para>
110
 
</para><variablelist role="struct">
111
 
</variablelist><para role="since">Since 0.2</para></refsect2>
112
 
<refsect2 id="clutter-media-set-uri" role="function" condition="since:0.2">
113
 
<title>clutter_media_set_uri ()</title>
114
 
<indexterm zone="clutter-media-set-uri" role="0.2"><primary sortas="media_set_uri">clutter_media_set_uri</primary></indexterm><programlisting><link linkend="void">void</link>                clutter_media_set_uri               (<link linkend="ClutterMedia">ClutterMedia</link> *media,
115
 
                                                         const <link linkend="gchar">gchar</link> *uri);</programlisting>
116
 
<para>
117
 
Sets the URI of <parameter>media</parameter> to <parameter>uri</parameter>.</para>
118
 
<para>
119
 
</para><variablelist role="params">
120
 
<varlistentry><term><parameter>media</parameter>&#160;:</term>
121
 
<listitem><simpara> a <link linkend="ClutterMedia"><type>ClutterMedia</type></link>
122
 
</simpara></listitem></varlistentry>
123
 
<varlistentry><term><parameter>uri</parameter>&#160;:</term>
124
 
<listitem><simpara> the URI of the media stream
125
 
</simpara></listitem></varlistentry>
126
 
</variablelist><para role="since">Since 0.2</para></refsect2>
127
 
<refsect2 id="clutter-media-get-uri" role="function" condition="since:0.2">
128
 
<title>clutter_media_get_uri ()</title>
129
 
<indexterm zone="clutter-media-get-uri" role="0.2"><primary sortas="media_get_uri">clutter_media_get_uri</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             clutter_media_get_uri               (<link linkend="ClutterMedia">ClutterMedia</link> *media);</programlisting>
130
 
<para>
131
 
Retrieves the URI from <parameter>media</parameter>.</para>
132
 
<para>
133
 
</para><variablelist role="params">
134
 
<varlistentry><term><parameter>media</parameter>&#160;:</term>
135
 
<listitem><simpara> a <link linkend="ClutterMedia"><type>ClutterMedia</type></link>
136
 
</simpara></listitem></varlistentry>
137
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the URI of the media stream. Use <link linkend="g-free"><function>g_free()</function></link>
138
 
  to free the returned string
139
 
 
140
 
</simpara></listitem></varlistentry>
141
 
</variablelist><para role="since">Since 0.2</para></refsect2>
142
 
<refsect2 id="clutter-media-set-playing" role="function" condition="since:0.2">
143
 
<title>clutter_media_set_playing ()</title>
144
 
<indexterm zone="clutter-media-set-playing" role="0.2"><primary sortas="media_set_playing">clutter_media_set_playing</primary></indexterm><programlisting><link linkend="void">void</link>                clutter_media_set_playing           (<link linkend="ClutterMedia">ClutterMedia</link> *media,
145
 
                                                         <link linkend="gboolean">gboolean</link> playing);</programlisting>
146
 
<para>
147
 
Starts or stops playing of <parameter>media</parameter>.</para>
148
 
<para>
149
 
</para><variablelist role="params">
150
 
<varlistentry><term><parameter>media</parameter>&#160;:</term>
151
 
<listitem><simpara> a <link linkend="ClutterMedia"><type>ClutterMedia</type></link>
152
 
</simpara></listitem></varlistentry>
153
 
<varlistentry><term><parameter>playing</parameter>&#160;:</term>
154
 
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to start playing
155
 
</simpara></listitem></varlistentry>
156
 
</variablelist><para role="since">Since 0.2</para></refsect2>
157
 
<refsect2 id="clutter-media-get-playing" role="function" condition="since:0.2">
158
 
<title>clutter_media_get_playing ()</title>
159
 
<indexterm zone="clutter-media-get-playing" role="0.2"><primary sortas="media_get_playing">clutter_media_get_playing</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            clutter_media_get_playing           (<link linkend="ClutterMedia">ClutterMedia</link> *media);</programlisting>
160
 
<para>
161
 
Retrieves the playing status of <parameter>media</parameter>.</para>
162
 
<para>
163
 
</para><variablelist role="params">
164
 
<varlistentry><term><parameter>media</parameter>&#160;:</term>
165
 
<listitem><simpara> A <link linkend="ClutterMedia"><type>ClutterMedia</type></link> object
166
 
</simpara></listitem></varlistentry>
167
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if playing, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> if stopped.
168
 
 
169
 
</simpara></listitem></varlistentry>
170
 
</variablelist><para role="since">Since 0.2</para></refsect2>
171
 
<refsect2 id="clutter-media-set-progress" role="function" condition="since:1.0">
172
 
<title>clutter_media_set_progress ()</title>
173
 
<indexterm zone="clutter-media-set-progress" role="1.0"><primary sortas="media_set_progress">clutter_media_set_progress</primary></indexterm><programlisting><link linkend="void">void</link>                clutter_media_set_progress          (<link linkend="ClutterMedia">ClutterMedia</link> *media,
174
 
                                                         <link linkend="gdouble">gdouble</link> progress);</programlisting>
175
 
<para>
176
 
Sets the playback progress of <parameter>media</parameter>. The <parameter>progress</parameter> is
177
 
a normalized value between 0.0 (begin) and 1.0 (end).</para>
178
 
<para>
179
 
</para><variablelist role="params">
180
 
<varlistentry><term><parameter>media</parameter>&#160;:</term>
181
 
<listitem><simpara> a <link linkend="ClutterMedia"><type>ClutterMedia</type></link>
182
 
</simpara></listitem></varlistentry>
183
 
<varlistentry><term><parameter>progress</parameter>&#160;:</term>
184
 
<listitem><simpara> the progress of the playback, between 0.0 and 1.0
185
 
</simpara></listitem></varlistentry>
186
 
</variablelist><para role="since">Since 1.0</para></refsect2>
187
 
<refsect2 id="clutter-media-get-progress" role="function" condition="since:1.0">
188
 
<title>clutter_media_get_progress ()</title>
189
 
<indexterm zone="clutter-media-get-progress" role="1.0"><primary sortas="media_get_progress">clutter_media_get_progress</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             clutter_media_get_progress          (<link linkend="ClutterMedia">ClutterMedia</link> *media);</programlisting>
190
 
<para>
191
 
Retrieves the playback progress of <parameter>media</parameter>.</para>
192
 
<para>
193
 
</para><variablelist role="params">
194
 
<varlistentry><term><parameter>media</parameter>&#160;:</term>
195
 
<listitem><simpara> a <link linkend="ClutterMedia"><type>ClutterMedia</type></link>
196
 
</simpara></listitem></varlistentry>
197
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the playback progress, between 0.0 and 1.0
198
 
 
199
 
</simpara></listitem></varlistentry>
200
 
</variablelist><para role="since">Since 1.0</para></refsect2>
201
 
<refsect2 id="clutter-media-set-audio-volume" role="function" condition="since:1.0">
202
 
<title>clutter_media_set_audio_volume ()</title>
203
 
<indexterm zone="clutter-media-set-audio-volume" role="1.0"><primary sortas="media_set_audio_volume">clutter_media_set_audio_volume</primary></indexterm><programlisting><link linkend="void">void</link>                clutter_media_set_audio_volume      (<link linkend="ClutterMedia">ClutterMedia</link> *media,
204
 
                                                         <link linkend="gdouble">gdouble</link> volume);</programlisting>
205
 
<para>
206
 
Sets the playback volume of <parameter>media</parameter> to <parameter>volume</parameter>.</para>
207
 
<para>
208
 
</para><variablelist role="params">
209
 
<varlistentry><term><parameter>media</parameter>&#160;:</term>
210
 
<listitem><simpara> a <link linkend="ClutterMedia"><type>ClutterMedia</type></link>
211
 
</simpara></listitem></varlistentry>
212
 
<varlistentry><term><parameter>volume</parameter>&#160;:</term>
213
 
<listitem><simpara> the volume as a double between 0.0 and 1.0
214
 
</simpara></listitem></varlistentry>
215
 
</variablelist><para role="since">Since 1.0</para></refsect2>
216
 
<refsect2 id="clutter-media-get-audio-volume" role="function" condition="since:1.0">
217
 
<title>clutter_media_get_audio_volume ()</title>
218
 
<indexterm zone="clutter-media-get-audio-volume" role="1.0"><primary sortas="media_get_audio_volume">clutter_media_get_audio_volume</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             clutter_media_get_audio_volume      (<link linkend="ClutterMedia">ClutterMedia</link> *media);</programlisting>
219
 
<para>
220
 
Retrieves the playback volume of <parameter>media</parameter>.</para>
221
 
<para>
222
 
</para><variablelist role="params">
223
 
<varlistentry><term><parameter>media</parameter>&#160;:</term>
224
 
<listitem><simpara> a <link linkend="ClutterMedia"><type>ClutterMedia</type></link>
225
 
</simpara></listitem></varlistentry>
226
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The playback volume between 0.0 and 1.0
227
 
 
228
 
</simpara></listitem></varlistentry>
229
 
</variablelist><para role="since">Since 1.0</para></refsect2>
230
 
<refsect2 id="clutter-media-get-can-seek" role="function" condition="since:0.2">
231
 
<title>clutter_media_get_can_seek ()</title>
232
 
<indexterm zone="clutter-media-get-can-seek" role="0.2"><primary sortas="media_get_can_seek">clutter_media_get_can_seek</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            clutter_media_get_can_seek          (<link linkend="ClutterMedia">ClutterMedia</link> *media);</programlisting>
233
 
<para>
234
 
Retrieves whether <parameter>media</parameter> is seekable or not.</para>
235
 
<para>
236
 
</para><variablelist role="params">
237
 
<varlistentry><term><parameter>media</parameter>&#160;:</term>
238
 
<listitem><simpara> a <link linkend="ClutterMedia"><type>ClutterMedia</type></link>
239
 
</simpara></listitem></varlistentry>
240
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>media</parameter> can seek, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
241
 
 
242
 
</simpara></listitem></varlistentry>
243
 
</variablelist><para role="since">Since 0.2</para></refsect2>
244
 
<refsect2 id="clutter-media-get-buffer-fill" role="function" condition="since:1.0">
245
 
<title>clutter_media_get_buffer_fill ()</title>
246
 
<indexterm zone="clutter-media-get-buffer-fill" role="1.0"><primary sortas="media_get_buffer_fill">clutter_media_get_buffer_fill</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             clutter_media_get_buffer_fill       (<link linkend="ClutterMedia">ClutterMedia</link> *media);</programlisting>
247
 
<para>
248
 
Retrieves the amount of the stream that is buffered.</para>
249
 
<para>
250
 
</para><variablelist role="params">
251
 
<varlistentry><term><parameter>media</parameter>&#160;:</term>
252
 
<listitem><simpara> a <link linkend="ClutterMedia"><type>ClutterMedia</type></link>
253
 
</simpara></listitem></varlistentry>
254
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the fill level, between 0.0 and 1.0
255
 
 
256
 
</simpara></listitem></varlistentry>
257
 
</variablelist><para role="since">Since 1.0</para></refsect2>
258
 
<refsect2 id="clutter-media-get-duration" role="function" condition="since:0.2">
259
 
<title>clutter_media_get_duration ()</title>
260
 
<indexterm zone="clutter-media-get-duration" role="0.2"><primary sortas="media_get_duration">clutter_media_get_duration</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             clutter_media_get_duration          (<link linkend="ClutterMedia">ClutterMedia</link> *media);</programlisting>
261
 
<para>
262
 
Retrieves the duration of the media stream that <parameter>media</parameter> represents.</para>
263
 
<para>
264
 
</para><variablelist role="params">
265
 
<varlistentry><term><parameter>media</parameter>&#160;:</term>
266
 
<listitem><simpara> a <link linkend="ClutterMedia"><type>ClutterMedia</type></link>
267
 
</simpara></listitem></varlistentry>
268
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the duration of the media stream, in seconds
269
 
 
270
 
</simpara></listitem></varlistentry>
271
 
</variablelist><para role="since">Since 0.2</para></refsect2>
272
 
<refsect2 id="clutter-media-set-filename" role="function" condition="since:0.2">
273
 
<title>clutter_media_set_filename ()</title>
274
 
<indexterm zone="clutter-media-set-filename" role="0.2"><primary sortas="media_set_filename">clutter_media_set_filename</primary></indexterm><programlisting><link linkend="void">void</link>                clutter_media_set_filename          (<link linkend="ClutterMedia">ClutterMedia</link> *media,
275
 
                                                         const <link linkend="gchar">gchar</link> *filename);</programlisting>
276
 
<para>
277
 
Sets the source of <parameter>media</parameter> using a file path.</para>
278
 
<para>
279
 
</para><variablelist role="params">
280
 
<varlistentry><term><parameter>media</parameter>&#160;:</term>
281
 
<listitem><simpara> a <link linkend="ClutterMedia"><type>ClutterMedia</type></link>
282
 
</simpara></listitem></varlistentry>
283
 
<varlistentry><term><parameter>filename</parameter>&#160;:</term>
284
 
<listitem><simpara> A filename
285
 
</simpara></listitem></varlistentry>
286
 
</variablelist><para role="since">Since 0.2</para></refsect2>
287
 
 
288
 
</refsect1>
289
 
<refsect1 id="ClutterMedia.property-details" role="property_details">
290
 
<title role="property_details.title">Property Details</title>
291
 
<refsect2 id="ClutterMedia--audio-volume" role="property"><title>The <literal>&quot;audio-volume&quot;</literal> property</title>
292
 
<indexterm zone="ClutterMedia--audio-volume" role="1.0"><primary sortas="Media:audio-volume">ClutterMedia:audio-volume</primary></indexterm><programlisting>  &quot;audio-volume&quot;             <link linkend="gdouble">gdouble</link>               : Read / Write</programlisting>
293
 
<para>
294
 
The volume of the audio, as a normalized value between
295
 
0.0 and 1.0.</para>
296
 
<para>
297
 
</para><para>Allowed values: [0,1]</para>
298
 
<para>Default value: 0.5</para>
299
 
<para>Since 1.0</para>
300
 
</refsect2>
301
 
<refsect2 id="ClutterMedia--buffer-fill" role="property"><title>The <literal>&quot;buffer-fill&quot;</literal> property</title>
302
 
<indexterm zone="ClutterMedia--buffer-fill" role="1.0"><primary sortas="Media:buffer-fill">ClutterMedia:buffer-fill</primary></indexterm><programlisting>  &quot;buffer-fill&quot;              <link linkend="gdouble">gdouble</link>               : Read</programlisting>
303
 
<para>
304
 
The fill level of the buffer for the current stream,
305
 
as a value between 0.0 and 1.0.</para>
306
 
<para>
307
 
</para><para>Allowed values: [0,1]</para>
308
 
<para>Default value: 0</para>
309
 
<para>Since 1.0</para>
310
 
</refsect2>
311
 
<refsect2 id="ClutterMedia--can-seek" role="property"><title>The <literal>&quot;can-seek&quot;</literal> property</title>
312
 
<indexterm zone="ClutterMedia--can-seek" role="0.2"><primary sortas="Media:can-seek">ClutterMedia:can-seek</primary></indexterm><programlisting>  &quot;can-seek&quot;                 <link linkend="gboolean">gboolean</link>              : Read</programlisting>
313
 
<para>
314
 
Whether the current stream is seekable.</para>
315
 
<para>
316
 
</para><para>Default value: FALSE</para>
317
 
<para>Since 0.2</para>
318
 
</refsect2>
319
 
<refsect2 id="ClutterMedia--duration" role="property"><title>The <literal>&quot;duration&quot;</literal> property</title>
320
 
<indexterm zone="ClutterMedia--duration" role="0.2"><primary sortas="Media:duration">ClutterMedia:duration</primary></indexterm><programlisting>  &quot;duration&quot;                 <link linkend="gdouble">gdouble</link>               : Read</programlisting>
321
 
<para>
322
 
The duration of the current stream, in seconds</para>
323
 
<para>
324
 
</para><para>Allowed values: &gt;= 0</para>
325
 
<para>Default value: 0</para>
326
 
<para>Since 0.2</para>
327
 
</refsect2>
328
 
<refsect2 id="ClutterMedia--playing" role="property"><title>The <literal>&quot;playing&quot;</literal> property</title>
329
 
<indexterm zone="ClutterMedia--playing" role="0.2"><primary sortas="Media:playing">ClutterMedia:playing</primary></indexterm><programlisting>  &quot;playing&quot;                  <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
330
 
<para>
331
 
Whether the <link linkend="ClutterMedia"><type>ClutterMedia</type></link> actor is playing.</para>
332
 
<para>
333
 
</para><para>Default value: FALSE</para>
334
 
<para>Since 0.2</para>
335
 
</refsect2>
336
 
<refsect2 id="ClutterMedia--progress" role="property"><title>The <literal>&quot;progress&quot;</literal> property</title>
337
 
<indexterm zone="ClutterMedia--progress" role="1.0"><primary sortas="Media:progress">ClutterMedia:progress</primary></indexterm><programlisting>  &quot;progress&quot;                 <link linkend="gdouble">gdouble</link>               : Read / Write</programlisting>
338
 
<para>
339
 
The current progress of the playback, as a normalized
340
 
value between 0.0 and 1.0.</para>
341
 
<para>
342
 
</para><para>Allowed values: [0,1]</para>
343
 
<para>Default value: 0</para>
344
 
<para>Since 1.0</para>
345
 
</refsect2>
346
 
<refsect2 id="ClutterMedia--uri" role="property"><title>The <literal>&quot;uri&quot;</literal> property</title>
347
 
<indexterm zone="ClutterMedia--uri" role="0.2"><primary sortas="Media:uri">ClutterMedia:uri</primary></indexterm><programlisting>  &quot;uri&quot;                      <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
348
 
<para>
349
 
The location of a media file, expressed as a valid URI.</para>
350
 
<para>
351
 
</para><para>Default value: NULL</para>
352
 
<para>Since 0.2</para>
353
 
</refsect2>
354
 
</refsect1>
355
 
 
356
 
<refsect1 id="ClutterMedia.signal-details" role="signals">
357
 
<title role="signals.title">Signal Details</title>
358
 
<refsect2 id="ClutterMedia-eos" role="signal"><title>The <literal>&quot;eos&quot;</literal> signal</title>
359
 
<indexterm zone="ClutterMedia-eos" role="0.2"><primary sortas="Media::eos">ClutterMedia::eos</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="ClutterMedia">ClutterMedia</link> *media,
360
 
                                                        <link linkend="gpointer">gpointer</link>      user_data)      : Run Last</programlisting>
361
 
<para>
362
 
The ::eos signal is emitted each time the media stream ends.</para>
363
 
<para>
364
 
</para><variablelist role="params">
365
 
<varlistentry><term><parameter>media</parameter>&#160;:</term>
366
 
<listitem><simpara> the <link linkend="ClutterMedia"><type>ClutterMedia</type></link> instance that received the signal
367
 
</simpara></listitem></varlistentry>
368
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
369
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
370
 
</variablelist><para>Since 0.2</para></refsect2><refsect2 id="ClutterMedia-error" role="signal"><title>The <literal>&quot;error&quot;</literal> signal</title>
371
 
<indexterm zone="ClutterMedia-error" role="0.2"><primary sortas="Media::error">ClutterMedia::error</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="ClutterMedia">ClutterMedia</link> *media,
372
 
                                                        <link linkend="gpointer">gpointer</link>      error,
373
 
                                                        <link linkend="gpointer">gpointer</link>      user_data)      : Run Last</programlisting>
374
 
<para>
375
 
The ::error signal is emitted each time an error occurred.</para>
376
 
<para>
377
 
</para><variablelist role="params">
378
 
<varlistentry><term><parameter>media</parameter>&#160;:</term>
379
 
<listitem><simpara> the <link linkend="ClutterMedia"><type>ClutterMedia</type></link> instance that received the signal
380
 
</simpara></listitem></varlistentry>
381
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
382
 
<listitem><simpara> the <link linkend="GError"><type>GError</type></link>
383
 
</simpara></listitem></varlistentry>
384
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
385
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
386
 
</variablelist><para>Since 0.2</para></refsect2>
387
 
</refsect1>
388
 
 
389
 
 
390
 
 
391
 
</refentry>