1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>ClutterMedia</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="Clutter Reference Manual">
8 <link rel="up" href="ch01.html" title="Abstract classes and interfaces">
9 <link rel="prev" href="ClutterChildMeta.html" title="ClutterChildMeta">
10 <link rel="next" href="ClutterLayoutManager.html" title="ClutterLayoutManager">
11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17 <td><a accesskey="p" href="ClutterChildMeta.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">Clutter Reference Manual</th>
21 <td><a accesskey="n" href="ClutterLayoutManager.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#ClutterMedia.synopsis" class="shortcut">Top</a>
26 <a href="#ClutterMedia.description" class="shortcut">Description</a>
28 <a href="#ClutterMedia.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#ClutterMedia.prerequisites" class="shortcut">Prerequisites</a>
32 <a href="#ClutterMedia.properties" class="shortcut">Properties</a>
34 <a href="#ClutterMedia.signals" class="shortcut">Signals</a>
37 <div class="refentry">
38 <a name="ClutterMedia"></a><div class="titlepage"></div>
39 <div class="refnamediv"><table width="100%"><tr>
41 <h2><span class="refentrytitle"><a name="ClutterMedia.top_of_page"></a>ClutterMedia</span></h2>
42 <p>ClutterMedia — An interface for controlling playback of media data</p>
44 <td valign="top" align="right"></td>
46 <div class="refsynopsisdiv">
47 <a name="ClutterMedia.synopsis"></a><h2>Synopsis</h2>
48 <pre class="synopsis"> <a class="link" href="ClutterMedia.html#ClutterMedia-struct" title="ClutterMedia">ClutterMedia</a>;
49 struct <a class="link" href="ClutterMedia.html#ClutterMediaIface" title="struct ClutterMediaIface">ClutterMediaIface</a>;
50 <span class="returnvalue">void</span> <a class="link" href="ClutterMedia.html#clutter-media-set-uri" title="clutter_media_set_uri ()">clutter_media_set_uri</a> (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>,
51 <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>);
52 <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="ClutterMedia.html#clutter-media-get-uri" title="clutter_media_get_uri ()">clutter_media_get_uri</a> (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>);
53 <span class="returnvalue">void</span> <a class="link" href="ClutterMedia.html#clutter-media-set-playing" title="clutter_media_set_playing ()">clutter_media_set_playing</a> (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>,
54 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> playing</code></em>);
55 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="ClutterMedia.html#clutter-media-get-playing" title="clutter_media_get_playing ()">clutter_media_get_playing</a> (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>);
56 <span class="returnvalue">void</span> <a class="link" href="ClutterMedia.html#clutter-media-set-progress" title="clutter_media_set_progress ()">clutter_media_set_progress</a> (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>,
57 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> progress</code></em>);
58 <a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> <a class="link" href="ClutterMedia.html#clutter-media-get-progress" title="clutter_media_get_progress ()">clutter_media_get_progress</a> (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>);
59 <span class="returnvalue">void</span> <a class="link" href="ClutterMedia.html#clutter-media-set-subtitle-uri" title="clutter_media_set_subtitle_uri ()">clutter_media_set_subtitle_uri</a> (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>,
60 <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>);
61 <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="ClutterMedia.html#clutter-media-get-subtitle-uri" title="clutter_media_get_subtitle_uri ()">clutter_media_get_subtitle_uri</a> (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>);
62 <span class="returnvalue">void</span> <a class="link" href="ClutterMedia.html#clutter-media-set-subtitle-font-name" title="clutter_media_set_subtitle_font_name ()">clutter_media_set_subtitle_font_name</a>
63 (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>,
64 <em class="parameter"><code>const <span class="type">char</span> *font_name</code></em>);
65 <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="ClutterMedia.html#clutter-media-get-subtitle-font-name" title="clutter_media_get_subtitle_font_name ()">clutter_media_get_subtitle_font_name</a>
66 (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>);
67 <span class="returnvalue">void</span> <a class="link" href="ClutterMedia.html#clutter-media-set-audio-volume" title="clutter_media_set_audio_volume ()">clutter_media_set_audio_volume</a> (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>,
68 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> volume</code></em>);
69 <a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> <a class="link" href="ClutterMedia.html#clutter-media-get-audio-volume" title="clutter_media_get_audio_volume ()">clutter_media_get_audio_volume</a> (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>);
70 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="ClutterMedia.html#clutter-media-get-can-seek" title="clutter_media_get_can_seek ()">clutter_media_get_can_seek</a> (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>);
71 <a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> <a class="link" href="ClutterMedia.html#clutter-media-get-buffer-fill" title="clutter_media_get_buffer_fill ()">clutter_media_get_buffer_fill</a> (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>);
72 <a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> <a class="link" href="ClutterMedia.html#clutter-media-get-duration" title="clutter_media_get_duration ()">clutter_media_get_duration</a> (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>);
73 <span class="returnvalue">void</span> <a class="link" href="ClutterMedia.html#clutter-media-set-filename" title="clutter_media_set_filename ()">clutter_media_set_filename</a> (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>,
74 <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);
77 <div class="refsect1">
78 <a name="ClutterMedia.object-hierarchy"></a><h2>Object Hierarchy</h2>
79 <pre class="synopsis">
84 <div class="refsect1">
85 <a name="ClutterMedia.prerequisites"></a><h2>Prerequisites</h2>
88 <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p>
90 <div class="refsect1">
91 <a name="ClutterMedia.properties"></a><h2>Properties</h2>
92 <pre class="synopsis">
93 "<a class="link" href="ClutterMedia.html#ClutterMedia--audio-volume" title='The "audio-volume" property'>audio-volume</a>" <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write
94 "<a class="link" href="ClutterMedia.html#ClutterMedia--buffer-fill" title='The "buffer-fill" property'>buffer-fill</a>" <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read
95 "<a class="link" href="ClutterMedia.html#ClutterMedia--can-seek" title='The "can-seek" property'>can-seek</a>" <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read
96 "<a class="link" href="ClutterMedia.html#ClutterMedia--duration" title='The "duration" property'>duration</a>" <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read
97 "<a class="link" href="ClutterMedia.html#ClutterMedia--playing" title='The "playing" property'>playing</a>" <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
98 "<a class="link" href="ClutterMedia.html#ClutterMedia--progress" title='The "progress" property'>progress</a>" <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write
99 "<a class="link" href="ClutterMedia.html#ClutterMedia--subtitle-font-name" title='The "subtitle-font-name" property'>subtitle-font-name</a>" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
100 "<a class="link" href="ClutterMedia.html#ClutterMedia--subtitle-uri" title='The "subtitle-uri" property'>subtitle-uri</a>" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
101 "<a class="link" href="ClutterMedia.html#ClutterMedia--uri" title='The "uri" property'>uri</a>" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
104 <div class="refsect1">
105 <a name="ClutterMedia.signals"></a><h2>Signals</h2>
106 <pre class="synopsis">
107 "<a class="link" href="ClutterMedia.html#ClutterMedia-eos" title='The "eos" signal'>eos</a>" : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
108 "<a class="link" href="ClutterMedia.html#ClutterMedia-error" title='The "error" signal'>error</a>" : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
111 <div class="refsect1">
112 <a name="ClutterMedia.description"></a><h2>Description</h2>
114 <a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> is an interface for controlling playback of media sources.
117 Clutter core does not provide an implementation of this interface, but
118 other integration libraries like Clutter-GStreamer implement it to offer
119 a uniform API for applications.
122 <a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> is available since Clutter 0.2
125 <div class="refsect1">
126 <a name="ClutterMedia.details"></a><h2>Details</h2>
127 <div class="refsect2">
128 <a name="ClutterMedia-struct"></a><h3>ClutterMedia</h3>
129 <pre class="programlisting">typedef struct _ClutterMedia ClutterMedia;</pre>
131 <a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> is an opaque structure whose members cannot be directly
134 <p class="since">Since 0.2</p>
137 <div class="refsect2">
138 <a name="ClutterMediaIface"></a><h3>struct ClutterMediaIface</h3>
139 <pre class="programlisting">struct ClutterMediaIface {
141 void (* eos) (ClutterMedia *media);
142 void (* error) (ClutterMedia *media,
143 const GError *error);
147 Interface vtable for <a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> implementations
149 <div class="variablelist"><table border="0">
150 <col align="left" valign="top">
153 <td><p><span class="term"><em class="structfield"><code><a name="ClutterMediaIface.eos"></a>eos</code></em> ()</span></p></td>
154 <td>handler for the <a class="link" href="ClutterMedia.html#ClutterMedia-eos" title='The "eos" signal'><span class="type">"eos"</span></a> signal</td>
157 <td><p><span class="term"><em class="structfield"><code><a name="ClutterMediaIface.error"></a>error</code></em> ()</span></p></td>
158 <td>handler for the <a class="link" href="ClutterMedia.html#ClutterMedia-error" title='The "error" signal'><span class="type">"error"</span></a> signal</td>
162 <p class="since">Since 0.2</p>
165 <div class="refsect2">
166 <a name="clutter-media-set-uri"></a><h3>clutter_media_set_uri ()</h3>
167 <pre class="programlisting"><span class="returnvalue">void</span> clutter_media_set_uri (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>,
168 <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>);</pre>
170 Sets the URI of <em class="parameter"><code>media</code></em> to <em class="parameter"><code>uri</code></em>.
172 <div class="variablelist"><table border="0">
173 <col align="left" valign="top">
176 <td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
177 <td>a <a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a>
181 <td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
182 <td>the URI of the media stream</td>
186 <p class="since">Since 0.2</p>
189 <div class="refsect2">
190 <a name="clutter-media-get-uri"></a><h3>clutter_media_get_uri ()</h3>
191 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * clutter_media_get_uri (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>);</pre>
193 Retrieves the URI from <em class="parameter"><code>media</code></em>.
195 <div class="variablelist"><table border="0">
196 <col align="left" valign="top">
199 <td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
200 <td>a <a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a>
204 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
205 <td>the URI of the media stream. Use <a href="../glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>
206 to free the returned string</td>
210 <p class="since">Since 0.2</p>
213 <div class="refsect2">
214 <a name="clutter-media-set-playing"></a><h3>clutter_media_set_playing ()</h3>
215 <pre class="programlisting"><span class="returnvalue">void</span> clutter_media_set_playing (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>,
216 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> playing</code></em>);</pre>
218 Starts or stops playing of <em class="parameter"><code>media</code></em>.
220 The implementation might be asynchronous, so the way to know whether
221 the actual playing state of the <em class="parameter"><code>media</code></em> is to use the <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-notify"><span class="type">"notify"</span></a>
222 signal on the <a class="link" href="ClutterMedia.html#ClutterMedia--playing" title='The "playing" property'><span class="type">"playing"</span></a> property and then retrieve the
223 current state with <a class="link" href="ClutterMedia.html#clutter-media-get-playing" title="clutter_media_get_playing ()"><code class="function">clutter_media_get_playing()</code></a>. ClutterGstVideoTexture
224 in clutter-gst is an example of such an asynchronous implementation.
226 <div class="variablelist"><table border="0">
227 <col align="left" valign="top">
230 <td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
231 <td>a <a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a>
235 <td><p><span class="term"><em class="parameter"><code>playing</code></em> :</span></p></td>
237 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to start playing</td>
241 <p class="since">Since 0.2</p>
244 <div class="refsect2">
245 <a name="clutter-media-get-playing"></a><h3>clutter_media_get_playing ()</h3>
246 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> clutter_media_get_playing (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>);</pre>
248 Retrieves the playing status of <em class="parameter"><code>media</code></em>.
250 <div class="variablelist"><table border="0">
251 <col align="left" valign="top">
254 <td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
255 <td>A <a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> object</td>
258 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
260 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if playing, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if stopped.</td>
264 <p class="since">Since 0.2</p>
267 <div class="refsect2">
268 <a name="clutter-media-set-progress"></a><h3>clutter_media_set_progress ()</h3>
269 <pre class="programlisting"><span class="returnvalue">void</span> clutter_media_set_progress (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>,
270 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> progress</code></em>);</pre>
272 Sets the playback progress of <em class="parameter"><code>media</code></em>. The <em class="parameter"><code>progress</code></em> is
273 a normalized value between 0.0 (begin) and 1.0 (end).
275 <div class="variablelist"><table border="0">
276 <col align="left" valign="top">
279 <td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
280 <td>a <a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a>
284 <td><p><span class="term"><em class="parameter"><code>progress</code></em> :</span></p></td>
285 <td>the progress of the playback, between 0.0 and 1.0</td>
289 <p class="since">Since 1.0</p>
292 <div class="refsect2">
293 <a name="clutter-media-get-progress"></a><h3>clutter_media_get_progress ()</h3>
294 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> clutter_media_get_progress (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>);</pre>
296 Retrieves the playback progress of <em class="parameter"><code>media</code></em>.
298 <div class="variablelist"><table border="0">
299 <col align="left" valign="top">
302 <td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
303 <td>a <a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a>
307 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
308 <td>the playback progress, between 0.0 and 1.0</td>
312 <p class="since">Since 1.0</p>
315 <div class="refsect2">
316 <a name="clutter-media-set-subtitle-uri"></a><h3>clutter_media_set_subtitle_uri ()</h3>
317 <pre class="programlisting"><span class="returnvalue">void</span> clutter_media_set_subtitle_uri (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>,
318 <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>);</pre>
320 Sets the location of a subtitle file to display while playing <em class="parameter"><code>media</code></em>.
322 <div class="variablelist"><table border="0">
323 <col align="left" valign="top">
326 <td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
327 <td>a <a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a>
331 <td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
332 <td>the URI of a subtitle file</td>
336 <p class="since">Since 1.2</p>
339 <div class="refsect2">
340 <a name="clutter-media-get-subtitle-uri"></a><h3>clutter_media_get_subtitle_uri ()</h3>
341 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * clutter_media_get_subtitle_uri (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>);</pre>
343 Retrieves the URI of the subtitle file in use.
345 <div class="variablelist"><table border="0">
346 <col align="left" valign="top">
349 <td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
350 <td>a <a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a>
354 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
355 <td>the URI of the subtitle file. Use <a href="../glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>
356 to free the returned string</td>
360 <p class="since">Since 1.2</p>
363 <div class="refsect2">
364 <a name="clutter-media-set-subtitle-font-name"></a><h3>clutter_media_set_subtitle_font_name ()</h3>
365 <pre class="programlisting"><span class="returnvalue">void</span> clutter_media_set_subtitle_font_name
366 (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>,
367 <em class="parameter"><code>const <span class="type">char</span> *font_name</code></em>);</pre>
369 Sets the font used by the subtitle renderer. The <em class="parameter"><code>font_name</code></em> string must be
370 either <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>, which means that the default font name of the underlying
371 implementation will be used; or must follow the grammar recognized by
372 <a href="../pango/pango-Fonts.html#pango-font-description-from-string"><code class="function">pango_font_description_from_string()</code></a> like:
376 <div class="informalexample">
377 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
380 <td class="listing_lines" align="right"><pre>1</pre></td>
381 <td class="listing_code"><pre class="programlisting"><span class="function"><a href="ClutterMedia.html#clutter-media-set-subtitle-font-name">clutter_media_set_subtitle_font_name</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">media</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"Sans 24pt"</span><span class="symbol">);</span></pre></td>
389 <div class="variablelist"><table border="0">
390 <col align="left" valign="top">
393 <td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
394 <td>a <a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a>
398 <td><p><span class="term"><em class="parameter"><code>font_name</code></em> :</span></p></td>
399 <td>a font name, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> to set the default font name</td>
403 <p class="since">Since 1.2</p>
406 <div class="refsect2">
407 <a name="clutter-media-get-subtitle-font-name"></a><h3>clutter_media_get_subtitle_font_name ()</h3>
408 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * clutter_media_get_subtitle_font_name
409 (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>);</pre>
411 Retrieves the font name currently used.
413 <div class="variablelist"><table border="0">
414 <col align="left" valign="top">
417 <td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
418 <td>a <a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a>
422 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
423 <td>a string containing the font name. Use <a href="../glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>
424 to free the returned string</td>
428 <p class="since">Since 1.2</p>
431 <div class="refsect2">
432 <a name="clutter-media-set-audio-volume"></a><h3>clutter_media_set_audio_volume ()</h3>
433 <pre class="programlisting"><span class="returnvalue">void</span> clutter_media_set_audio_volume (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>,
434 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> volume</code></em>);</pre>
436 Sets the playback volume of <em class="parameter"><code>media</code></em> to <em class="parameter"><code>volume</code></em>.
438 <div class="variablelist"><table border="0">
439 <col align="left" valign="top">
442 <td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
443 <td>a <a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a>
447 <td><p><span class="term"><em class="parameter"><code>volume</code></em> :</span></p></td>
448 <td>the volume as a double between 0.0 and 1.0</td>
452 <p class="since">Since 1.0</p>
455 <div class="refsect2">
456 <a name="clutter-media-get-audio-volume"></a><h3>clutter_media_get_audio_volume ()</h3>
457 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> clutter_media_get_audio_volume (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>);</pre>
459 Retrieves the playback volume of <em class="parameter"><code>media</code></em>.
461 <div class="variablelist"><table border="0">
462 <col align="left" valign="top">
465 <td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
466 <td>a <a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a>
470 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
471 <td>The playback volume between 0.0 and 1.0</td>
475 <p class="since">Since 1.0</p>
478 <div class="refsect2">
479 <a name="clutter-media-get-can-seek"></a><h3>clutter_media_get_can_seek ()</h3>
480 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> clutter_media_get_can_seek (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>);</pre>
482 Retrieves whether <em class="parameter"><code>media</code></em> is seekable or not.
484 <div class="variablelist"><table border="0">
485 <col align="left" valign="top">
488 <td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
489 <td>a <a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a>
493 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
495 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>media</code></em> can seek, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
499 <p class="since">Since 0.2</p>
502 <div class="refsect2">
503 <a name="clutter-media-get-buffer-fill"></a><h3>clutter_media_get_buffer_fill ()</h3>
504 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> clutter_media_get_buffer_fill (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>);</pre>
506 Retrieves the amount of the stream that is buffered.
508 <div class="variablelist"><table border="0">
509 <col align="left" valign="top">
512 <td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
513 <td>a <a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a>
517 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
518 <td>the fill level, between 0.0 and 1.0</td>
522 <p class="since">Since 1.0</p>
525 <div class="refsect2">
526 <a name="clutter-media-get-duration"></a><h3>clutter_media_get_duration ()</h3>
527 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> clutter_media_get_duration (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>);</pre>
529 Retrieves the duration of the media stream that <em class="parameter"><code>media</code></em> represents.
531 <div class="variablelist"><table border="0">
532 <col align="left" valign="top">
535 <td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
536 <td>a <a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a>
540 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
541 <td>the duration of the media stream, in seconds</td>
545 <p class="since">Since 0.2</p>
548 <div class="refsect2">
549 <a name="clutter-media-set-filename"></a><h3>clutter_media_set_filename ()</h3>
550 <pre class="programlisting"><span class="returnvalue">void</span> clutter_media_set_filename (<em class="parameter"><code><a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media</code></em>,
551 <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);</pre>
553 Sets the source of <em class="parameter"><code>media</code></em> using a file path.
555 <div class="variablelist"><table border="0">
556 <col align="left" valign="top">
559 <td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
560 <td>a <a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a>
564 <td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
569 <p class="since">Since 0.2</p>
572 <div class="refsect1">
573 <a name="ClutterMedia.property-details"></a><h2>Property Details</h2>
574 <div class="refsect2">
575 <a name="ClutterMedia--audio-volume"></a><h3>The <code class="literal">"audio-volume"</code> property</h3>
576 <pre class="programlisting"> "audio-volume" <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write</pre>
578 The volume of the audio, as a normalized value between
581 <p>Allowed values: [0,1]</p>
582 <p>Default value: 0.5</p>
583 <p class="since">Since 1.0</p>
586 <div class="refsect2">
587 <a name="ClutterMedia--buffer-fill"></a><h3>The <code class="literal">"buffer-fill"</code> property</h3>
588 <pre class="programlisting"> "buffer-fill" <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read</pre>
590 The fill level of the buffer for the current stream,
591 as a value between 0.0 and 1.0.
593 <p>Allowed values: [0,1]</p>
594 <p>Default value: 0</p>
595 <p class="since">Since 1.0</p>
598 <div class="refsect2">
599 <a name="ClutterMedia--can-seek"></a><h3>The <code class="literal">"can-seek"</code> property</h3>
600 <pre class="programlisting"> "can-seek" <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read</pre>
602 Whether the current stream is seekable.
604 <p>Default value: FALSE</p>
605 <p class="since">Since 0.2</p>
608 <div class="refsect2">
609 <a name="ClutterMedia--duration"></a><h3>The <code class="literal">"duration"</code> property</h3>
610 <pre class="programlisting"> "duration" <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read</pre>
612 The duration of the current stream, in seconds
614 <p>Allowed values: >= 0</p>
615 <p>Default value: 0</p>
616 <p class="since">Since 0.2</p>
619 <div class="refsect2">
620 <a name="ClutterMedia--playing"></a><h3>The <code class="literal">"playing"</code> property</h3>
621 <pre class="programlisting"> "playing" <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
623 Whether the <a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> actor is playing.
625 <p>Default value: FALSE</p>
626 <p class="since">Since 0.2</p>
629 <div class="refsect2">
630 <a name="ClutterMedia--progress"></a><h3>The <code class="literal">"progress"</code> property</h3>
631 <pre class="programlisting"> "progress" <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write</pre>
633 The current progress of the playback, as a normalized
634 value between 0.0 and 1.0.
636 <p>Allowed values: [0,1]</p>
637 <p>Default value: 0</p>
638 <p class="since">Since 1.0</p>
641 <div class="refsect2">
642 <a name="ClutterMedia--subtitle-font-name"></a><h3>The <code class="literal">"subtitle-font-name"</code> property</h3>
643 <pre class="programlisting"> "subtitle-font-name" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
645 The font used to display subtitles. The font description has to
646 follow the same grammar as the one recognized by
647 <a href="../pango/pango-Fonts.html#pango-font-description-from-string"><code class="function">pango_font_description_from_string()</code></a>.
649 <p>Default value: NULL</p>
650 <p class="since">Since 1.2</p>
653 <div class="refsect2">
654 <a name="ClutterMedia--subtitle-uri"></a><h3>The <code class="literal">"subtitle-uri"</code> property</h3>
655 <pre class="programlisting"> "subtitle-uri" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
657 The location of a subtitle file, expressed as a valid URI.
659 <p>Default value: NULL</p>
660 <p class="since">Since 1.2</p>
663 <div class="refsect2">
664 <a name="ClutterMedia--uri"></a><h3>The <code class="literal">"uri"</code> property</h3>
665 <pre class="programlisting"> "uri" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
667 The location of a media file, expressed as a valid URI.
669 <p>Default value: NULL</p>
670 <p class="since">Since 0.2</p>
673 <div class="refsect1">
674 <a name="ClutterMedia.signal-details"></a><h2>Signal Details</h2>
675 <div class="refsect2">
676 <a name="ClutterMedia-eos"></a><h3>The <code class="literal">"eos"</code> signal</h3>
677 <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media,
678 <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
680 The ::eos signal is emitted each time the media stream ends.
682 <div class="variablelist"><table border="0">
683 <col align="left" valign="top">
686 <td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
687 <td>the <a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> instance that received the signal</td>
690 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
691 <td>user data set when the signal handler was connected.</td>
695 <p class="since">Since 0.2</p>
698 <div class="refsect2">
699 <a name="ClutterMedia-error"></a><h3>The <code class="literal">"error"</code> signal</h3>
700 <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> *media,
701 <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error,
702 <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
704 The ::error signal is emitted each time an error occurred.
706 <div class="variablelist"><table border="0">
707 <col align="left" valign="top">
710 <td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
711 <td>the <a class="link" href="ClutterMedia.html" title="ClutterMedia"><span class="type">ClutterMedia</span></a> instance that received the signal</td>
714 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
715 <td>the <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
719 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
720 <td>user data set when the signal handler was connected.</td>
724 <p class="since">Since 0.2</p>
730 Generated by GTK-Doc V1.18.1</div>