← Back to branch summary

~walkerlee/totem/pre-interview

« back to all changes in this revision

Viewing changes to docs/reference/html/TotemObject.html

  • Committer: Package Import Robot
  • Author(s): Jeremy Bicha
  • Date: 2013-05-26 00:07:51 UTC
  • mfrom: (1.6.1) (24.1.4 experimental)
  • Revision ID: package-import@ubuntu.com-20130526000751-kv8ap3x1di4qq8j2
Tags: 3.8.2-0ubuntu1
https://launchpad.net/bugs/1007438
https://launchpad.net/bugs/1039604
* Sync with Debian. Remaining changes: 
* debian/control.in:
  - Drop build-depends on libepc-ui-dev and libgrilo-0.2-dev (in universe)
  - Drop libxtst-dev build-depends so that the (redundant) fake key presses
    for inhibiting the screensaver are disabled (LP: #1007438)
  - Build-depend on libzeitgeist-dev
  - Suggest rather than recommend gstreamer components in universe
  - Add totem-plugins-extra
  - Add XB-Npp-Description and XB-Npp-Filename header to the 
    totem-mozilla package to improve ubufox/ubuntu plugin db integration 
  - Refer to Firefox in totem-mozilla description instead of Iceweasel
  - Don't have totem-mozilla recommend any particular browser
  - Drop obsolete python library dependencies since iplayer is no longer
    included
* debian/totem-common.install, debian/source_totem.py:
  - Install Ubuntu apport debugging hook
* debian/totem-plugins-extra.install:
  - Universe plugins split out of totem-plugins (currently only gromit)
* debian/totem-plugins.install:    
  - Skip the plugins split to -extra and add the zeitgeist plugin
* debian/rules:
  - Build with --fail-missing, to ensure we install everything. 
    + Ignore libtotem.{,l}a since we delibrately don't install these.
  - Re-enable hardening, make sure both PIE and BINDNOW are used
    by setting hardening=+all. (LP: #1039604)
* debian/patches/91_quicklist_entries.patch:
  - Add static quicklist
* debian/patches/92_gst-plugins-good.patch:
  - Build without unnecessary gstreamer1.0-bad dependency
* debian/patches/93_grilo_optional.patch:
  - Allow building without grilo while grilo MIR is still pending
* debian/patches/correct_desktop_mimetypes.patch:
  - Don't list the mimetypes after the unity lists
* debian/patches/revert_shell_menu.patch: 
  - revert the use of a shell menu until indicator-appmenu can handle
    the mixed shell/traditional menus itself
* New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/TotemObject.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>TotemObject</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="Totem Reference Manual">
8
8
<link rel="up" href="core-api.html" title="Core API">
9
9
<link rel="prev" href="core-api.html" title="Core API">
10
10
<link rel="next" href="totem-Interface.html" title="Interface">
11
 
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
54
54
 
55
55
typedef             <a class="link" href="TotemObject.html#Totem" title="Totem">Totem</a>;
56
56
                    <a class="link" href="TotemObject.html#TotemObject-struct" title="TotemObject">TotemObject</a>;
57
 
                    <a class="link" href="TotemObject.html#TotemObjectClass" title="TotemObjectClass">TotemObjectClass</a>;
58
57
enum                <a class="link" href="TotemObject.html#TotemRemoteCommand" title="enum TotemRemoteCommand">TotemRemoteCommand</a>;
59
58
enum                <a class="link" href="TotemObject.html#TotemRemoteSetting" title="enum TotemRemoteSetting">TotemRemoteSetting</a>;
60
59
#define             <a class="link" href="TotemObject.html#TOTEM-GSETTINGS-SCHEMA:CAPS" title="TOTEM_GSETTINGS_SCHEMA">TOTEM_GSETTINGS_SCHEMA</a>
75
74
<span class="returnvalue">void</span>                <a class="link" href="TotemObject.html#totem-object-add-to-playlist-and-play" title="totem_object_add_to_playlist_and_play ()">totem_object_add_to_playlist_and_play</a>
76
75
                                                        (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>,
77
76
                                                         <em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
78
 
                                                         <em class="parameter"><code>const <span class="type">char</span> *display_name</code></em>,
79
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> add_to_recent</code></em>);
 
77
                                                         <em class="parameter"><code>const <span class="type">char</span> *display_name</code></em>);
80
78
<span class="returnvalue">void</span>                <a class="link" href="TotemObject.html#totem-object-action-play" title="totem_object_action_play ()">totem_object_action_play</a>            (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>);
81
 
<span class="returnvalue">void</span>                <a class="link" href="TotemObject.html#totem-action-play-media" title="totem_action_play_media ()">totem_action_play_media</a>             (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>,
82
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/totem-pl-parser/totem-pl-parser-TotemDisc.html#TotemDiscMediaType"><span class="type">TotemDiscMediaType</span></a> type</code></em>,
83
 
                                                         <em class="parameter"><code>const <span class="type">char</span> *device</code></em>);
84
 
<span class="returnvalue">void</span>                <a class="link" href="TotemObject.html#totem-action-play-media-device" title="totem_action_play_media_device ()">totem_action_play_media_device</a>      (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>,
85
 
                                                         <em class="parameter"><code>const <span class="type">char</span> *device</code></em>);
86
79
<span class="returnvalue">void</span>                <a class="link" href="TotemObject.html#totem-object-action-play-pause" title="totem_object_action_play_pause ()">totem_object_action_play_pause</a>      (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>);
87
80
<span class="returnvalue">void</span>                <a class="link" href="TotemObject.html#totem-action-pause" title="totem_action_pause ()">totem_action_pause</a>                  (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>);
88
81
<span class="returnvalue">void</span>                <a class="link" href="TotemObject.html#totem-object-action-stop" title="totem_object_action_stop ()">totem_object_action_stop</a>            (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>);
127
120
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="TotemObject.html#totem-object-is-playing" title="totem_object_is_playing ()">totem_object_is_playing</a>             (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>);
128
121
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="TotemObject.html#totem-object-is-paused" title="totem_object_is_paused ()">totem_object_is_paused</a>              (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>);
129
122
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="TotemObject.html#totem-object-is-seekable" title="totem_object_is_seekable ()">totem_object_is_seekable</a>            (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>);
130
 
<a href="http://developer.gnome.org/devel/gtk/GtkWindow.html"><span class="returnvalue">GtkWindow</span></a> *         <a class="link" href="TotemObject.html#totem-object-get-main-window" title="totem_object_get_main_window ()">totem_object_get_main_window</a>        (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>);
131
 
<a href="http://developer.gnome.org/devel/gtk/GtkUIManager.html"><span class="returnvalue">GtkUIManager</span></a> *      <a class="link" href="TotemObject.html#totem-object-get-ui-manager" title="totem_object_get_ui_manager ()">totem_object_get_ui_manager</a>         (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>);
132
 
<a href="http://developer.gnome.org/devel/gtk/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="TotemObject.html#totem-get-video-widget" title="totem_get_video_widget ()">totem_get_video_widget</a>              (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>);
133
 
<span class="returnvalue">char</span> *              <a class="link" href="TotemObject.html#totem-get-video-widget-backend-name" title="totem_get_video_widget_backend_name ()">totem_get_video_widget_backend_name</a> (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>);
 
123
<a href="http://developer.gnome.org/gtk2/GtkWindow.html"><span class="returnvalue">GtkWindow</span></a> *         <a class="link" href="TotemObject.html#totem-object-get-main-window" title="totem_object_get_main_window ()">totem_object_get_main_window</a>        (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>);
 
124
<a href="http://developer.gnome.org/gtk2/GtkUIManager.html"><span class="returnvalue">GtkUIManager</span></a> *      <a class="link" href="TotemObject.html#totem-object-get-ui-manager" title="totem_object_get_ui_manager ()">totem_object_get_ui_manager</a>         (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>);
134
125
<span class="returnvalue">char</span> *              <a class="link" href="TotemObject.html#totem-object-get-current-mrl" title="totem_object_get_current_mrl ()">totem_object_get_current_mrl</a>        (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>);
 
126
<a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="TotemObject.html#totem-object-get-video-widget" title="totem_object_get_video_widget ()">totem_object_get_video_widget</a>       (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>);
135
127
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a>              <a class="link" href="TotemObject.html#totem-get-current-time" title="totem_get_current_time ()">totem_get_current_time</a>              (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>);
136
128
<span class="returnvalue">void</span>                <a class="link" href="TotemObject.html#totem-object-set-current-subtitle" title="totem_object_set_current_subtitle ()">totem_object_set_current_subtitle</a>   (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>,
137
129
                                                         <em class="parameter"><code>const <span class="type">char</span> *subtitle_uri</code></em>);
146
138
<span class="returnvalue">void</span>                <a class="link" href="TotemObject.html#totem-object-add-sidebar-page" title="totem_object_add_sidebar_page ()">totem_object_add_sidebar_page</a>       (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>,
147
139
                                                         <em class="parameter"><code>const <span class="type">char</span> *page_id</code></em>,
148
140
                                                         <em class="parameter"><code>const <span class="type">char</span> *title</code></em>,
149
 
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/devel/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *main_widget</code></em>);
 
141
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="type">GtkWidget</span></a> *main_widget</code></em>);
150
142
<span class="returnvalue">void</span>                <a class="link" href="TotemObject.html#totem-object-remove-sidebar-page" title="totem_object_remove_sidebar_page ()">totem_object_remove_sidebar_page</a>    (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>,
151
143
                                                         <em class="parameter"><code>const <span class="type">char</span> *page_id</code></em>);
152
144
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * const * <a class="link" href="TotemObject.html#totem-object-get-supported-content-types" title="totem_object_get_supported_content_types ()">totem_object_get_supported_content_types</a>
160
152
<pre class="synopsis">
161
153
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
162
154
   +----<a href="http://library.gnome.org/devel/gio/unstable/GApplication.html">GApplication</a>
163
 
         +----<a href="http://developer.gnome.org/devel/gtk/GtkApplication.html">GtkApplication</a>
 
155
         +----<a href="http://developer.gnome.org/gtk2/GtkApplication.html">GtkApplication</a>
164
156
               +----TotemObject
165
157
</pre>
166
158
</div>
168
160
<a name="TotemObject.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
169
161
<p>
170
162
TotemObject implements
171
 
 <a href="http://library.gnome.org/devel/gio/unstable/GActionGroup.html">GActionGroup</a> and  <a href="http://library.gnome.org/devel/gio/unstable/GActionMap.html">GActionMap</a>.</p>
 
163
 <a href="http://library.gnome.org/devel/gio/unstable/GActionGroup.html">GActionGroup</a> and  GActionMap.</p>
172
164
</div>
173
165
<div class="refsect1">
174
166
<a name="TotemObject.properties"></a><h2>Properties</h2>
175
167
<pre class="synopsis">
 
168
  "<a class="link" href="TotemObject.html#TotemObject--current-content-type" title='The "current-content-type" property'>current-content-type</a>"     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
 
169
  "<a class="link" href="TotemObject.html#TotemObject--current-display-name" title='The "current-display-name" property'>current-display-name</a>"     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
176
170
  "<a class="link" href="TotemObject.html#TotemObject--current-mrl" title='The "current-mrl" property'>current-mrl</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
177
171
  "<a class="link" href="TotemObject.html#TotemObject--current-time" title='The "current-time" property'>current-time</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a>                : Read
178
172
  "<a class="link" href="TotemObject.html#TotemObject--fullscreen" title='The "fullscreen" property'>fullscreen</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read
186
180
<a name="TotemObject.signals"></a><h2>Signals</h2>
187
181
<pre class="synopsis">
188
182
  "<a class="link" href="TotemObject.html#TotemObject-file-closed" title='The "file-closed" signal'>file-closed</a>"                                    : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
183
  "<a class="link" href="TotemObject.html#TotemObject-file-has-played" title='The "file-has-played" signal'>file-has-played</a>"                                : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
189
184
  "<a class="link" href="TotemObject.html#TotemObject-file-opened" title='The "file-opened" signal'>file-opened</a>"                                    : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
190
185
  "<a class="link" href="TotemObject.html#TotemObject-get-text-subtitle" title='The "get-text-subtitle" signal'>get-text-subtitle</a>"                              : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
191
186
  "<a class="link" href="TotemObject.html#TotemObject-get-user-agent" title='The "get-user-agent" signal'>get-user-agent</a>"                                 : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
218
213
</div>
219
214
<hr>
220
215
<div class="refsect2">
221
 
<a name="TotemObjectClass"></a><h3>TotemObjectClass</h3>
222
 
<pre class="programlisting">typedef struct {
223
 
        GObjectClass parent_class;
224
 
 
225
 
        void (*file_opened)                     (TotemObject *totem, const char *mrl);
226
 
        void (*file_closed)                     (TotemObject *totem);
227
 
        void (*metadata_updated)                (TotemObject *totem,
228
 
                                                 const char *artist,
229
 
                                                 const char *title,
230
 
                                                 const char *album,
231
 
                                                 guint track_num);
232
 
} TotemObjectClass;
233
 
</pre>
234
 
<p>
235
 
The class structure for the <a href="http://library.gnome.org/devel/totem-pl-parser/TotemPlParser.html"><span class="type">TotemPlParser</span></a> type.
236
 
</p>
237
 
<div class="variablelist"><table border="0">
238
 
<col align="left" valign="top">
239
 
<tbody>
240
 
<tr>
241
 
<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="TotemObjectClass.parent-class"></a>parent_class</code></em>;</span></p></td>
242
 
<td>the parent class</td>
243
 
</tr>
244
 
<tr>
245
 
<td><p><span class="term"><em class="structfield"><code><a name="TotemObjectClass.file-opened"></a>file_opened</code></em> ()</span></p></td>
246
 
<td>the generic signal handler for the <a class="link" href="TotemObject.html#TotemObject-file-opened" title='The "file-opened" signal'><span class="type">"file-opened"</span></a> signal,
247
 
which can be overridden by inheriting classes</td>
248
 
</tr>
249
 
<tr>
250
 
<td><p><span class="term"><em class="structfield"><code><a name="TotemObjectClass.file-closed"></a>file_closed</code></em> ()</span></p></td>
251
 
<td>the generic signal handler for the <a class="link" href="TotemObject.html#TotemObject-file-closed" title='The "file-closed" signal'><span class="type">"file-closed"</span></a> signal,
252
 
which can be overridden by inheriting classes</td>
253
 
</tr>
254
 
<tr>
255
 
<td><p><span class="term"><em class="structfield"><code><a name="TotemObjectClass.metadata-updated"></a>metadata_updated</code></em> ()</span></p></td>
256
 
<td>the generic signal handler for the <a class="link" href="TotemObject.html#TotemObject-metadata-updated" title='The "metadata-updated" signal'><span class="type">"metadata-updated"</span></a> signal,
257
 
which can be overridden by inheriting classes</td>
258
 
</tr>
259
 
</tbody>
260
 
</table></div>
261
 
</div>
262
 
<hr>
263
 
<div class="refsect2">
264
216
<a name="TotemRemoteCommand"></a><h3>enum TotemRemoteCommand</h3>
265
217
<pre class="programlisting">typedef enum {
266
218
        TOTEM_REMOTE_COMMAND_UNKNOWN = 0,
297
249
<p>
298
250
Represents a command which can be sent to a running Totem instance remotely.
299
251
</p>
300
 
<div class="variablelist"><table border="0">
 
252
<div class="variablelist"><table border="0" class="variablelist">
 
253
<colgroup>
301
254
<col align="left" valign="top">
 
255
<col>
 
256
</colgroup>
302
257
<tbody>
303
258
<tr>
304
259
<td><p><a name="TOTEM-REMOTE-COMMAND-UNKNOWN:CAPS"></a><span class="term"><code class="literal">TOTEM_REMOTE_COMMAND_UNKNOWN</code></span></p></td>
459
414
<p>
460
415
Represents a boolean setting or preference on a remote Totem instance.
461
416
</p>
462
 
<div class="variablelist"><table border="0">
 
417
<div class="variablelist"><table border="0" class="variablelist">
 
418
<colgroup>
463
419
<col align="left" valign="top">
 
420
<col>
 
421
</colgroup>
464
422
<tbody>
465
423
<tr>
466
424
<td><p><a name="TOTEM-REMOTE-SETTING-SHUFFLE:CAPS"></a><span class="term"><code class="literal">TOTEM_REMOTE_SETTING_SHUFFLE</code></span></p></td>
492
450
Initialises the plugin engine and activates all the
493
451
enabled plugins.
494
452
</p>
495
 
<div class="variablelist"><table border="0">
 
453
<div class="variablelist"><table border="0" class="variablelist">
 
454
<colgroup>
496
455
<col align="left" valign="top">
 
456
<col>
 
457
</colgroup>
497
458
<tbody><tr>
498
459
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
499
460
<td>a <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a>
509
470
Shuts down the plugin engine and deactivates all the
510
471
plugins.
511
472
</p>
512
 
<div class="variablelist"><table border="0">
 
473
<div class="variablelist"><table border="0" class="variablelist">
 
474
<colgroup>
513
475
<col align="left" valign="top">
 
476
<col>
 
477
</colgroup>
514
478
<tbody><tr>
515
479
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
516
480
<td>a <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a>
527
491
Emits the <a class="link" href="TotemObject.html#TotemObject-file-opened" title='The "file-opened" signal'><span class="type">"file-opened"</span></a> signal on <em class="parameter"><code>totem</code></em>, with the
528
492
specified <em class="parameter"><code>mrl</code></em>.
529
493
</p>
530
 
<div class="variablelist"><table border="0">
 
494
<div class="variablelist"><table border="0" class="variablelist">
 
495
<colgroup>
531
496
<col align="left" valign="top">
 
497
<col>
 
498
</colgroup>
532
499
<tbody>
533
500
<tr>
534
501
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
549
516
<p>
550
517
Emits the <a class="link" href="TotemObject.html#TotemObject-file-closed" title='The "file-closed" signal'><span class="type">"file-closed"</span></a> signal on <em class="parameter"><code>totem</code></em>.
551
518
</p>
552
 
<div class="variablelist"><table border="0">
 
519
<div class="variablelist"><table border="0" class="variablelist">
 
520
<colgroup>
553
521
<col align="left" valign="top">
 
522
<col>
 
523
</colgroup>
554
524
<tbody><tr>
555
525
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
556
526
<td>a <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a>
570
540
Emits the <a class="link" href="TotemObject.html#TotemObject-metadata-updated" title='The "metadata-updated" signal'><span class="type">"metadata-updated"</span></a> signal on <em class="parameter"><code>totem</code></em>,
571
541
with the specified stream data.
572
542
</p>
573
 
<div class="variablelist"><table border="0">
 
543
<div class="variablelist"><table border="0" class="variablelist">
 
544
<colgroup>
574
545
<col align="left" valign="top">
 
546
<col>
 
547
</colgroup>
575
548
<tbody>
576
549
<tr>
577
550
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
610
583
Displays a non-blocking error dialog with the
611
584
given <em class="parameter"><code>title</code></em> and <em class="parameter"><code>reason</code></em>.
612
585
</p>
613
 
<div class="variablelist"><table border="0">
 
586
<div class="variablelist"><table border="0" class="variablelist">
 
587
<colgroup>
614
588
<col align="left" valign="top">
 
589
<col>
 
590
</colgroup>
615
591
<tbody>
616
592
<tr>
617
593
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
636
612
<p>
637
613
Closes Totem.
638
614
</p>
639
 
<div class="variablelist"><table border="0">
 
615
<div class="variablelist"><table border="0" class="variablelist">
 
616
<colgroup>
640
617
<col align="left" valign="top">
 
618
<col>
 
619
</colgroup>
641
620
<tbody><tr>
642
621
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
643
622
<td>a <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a>
651
630
<pre class="programlisting"><span class="returnvalue">void</span>                totem_object_add_to_playlist_and_play
652
631
                                                        (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>,
653
632
                                                         <em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
654
 
                                                         <em class="parameter"><code>const <span class="type">char</span> *display_name</code></em>,
655
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> add_to_recent</code></em>);</pre>
 
633
                                                         <em class="parameter"><code>const <span class="type">char</span> *display_name</code></em>);</pre>
656
634
<p>
657
635
Add <em class="parameter"><code>uri</code></em> to the playlist and play it immediately.
658
636
</p>
659
 
<div class="variablelist"><table border="0">
 
637
<div class="variablelist"><table border="0" class="variablelist">
 
638
<colgroup>
660
639
<col align="left" valign="top">
 
640
<col>
 
641
</colgroup>
661
642
<tbody>
662
643
<tr>
663
644
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
672
653
<td><p><span class="term"><em class="parameter"><code>display_name</code></em> :</span></p></td>
673
654
<td>the display name of the URI</td>
674
655
</tr>
675
 
<tr>
676
 
<td><p><span class="term"><em class="parameter"><code>add_to_recent</code></em> :</span></p></td>
677
 
<td>if <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, add the URI to the recent items list</td>
678
 
</tr>
679
656
</tbody>
680
657
</table></div>
681
658
</div>
687
664
Plays the current stream. If Totem is already playing, it continues
688
665
to play. If the stream cannot be played, and error dialog is displayed.
689
666
</p>
690
 
<div class="variablelist"><table border="0">
 
667
<div class="variablelist"><table border="0" class="variablelist">
 
668
<colgroup>
691
669
<col align="left" valign="top">
 
670
<col>
 
671
</colgroup>
692
672
<tbody><tr>
693
673
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
694
674
<td>a <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a>
698
678
</div>
699
679
<hr>
700
680
<div class="refsect2">
701
 
<a name="totem-action-play-media"></a><h3>totem_action_play_media ()</h3>
702
 
<pre class="programlisting"><span class="returnvalue">void</span>                totem_action_play_media             (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>,
703
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/totem-pl-parser/totem-pl-parser-TotemDisc.html#TotemDiscMediaType"><span class="type">TotemDiscMediaType</span></a> type</code></em>,
704
 
                                                         <em class="parameter"><code>const <span class="type">char</span> *device</code></em>);</pre>
705
 
<p>
706
 
Attempts to play the media found on <em class="parameter"><code>device</code></em> (for example, a DVD in a drive or a DVB
707
 
tuner) by first adding it to the playlist, then playing it.
708
 
</p>
709
 
<p>
710
 
An error dialog will be displayed if Totem cannot support media of <em class="parameter"><code>type</code></em>.
711
 
</p>
712
 
<div class="variablelist"><table border="0">
713
 
<col align="left" valign="top">
714
 
<tbody>
715
 
<tr>
716
 
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
717
 
<td>a <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a>
718
 
</td>
719
 
</tr>
720
 
<tr>
721
 
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
722
 
<td>the type of disc media</td>
723
 
</tr>
724
 
<tr>
725
 
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
726
 
<td>the media's device path</td>
727
 
</tr>
728
 
</tbody>
729
 
</table></div>
730
 
</div>
731
 
<hr>
732
 
<div class="refsect2">
733
 
<a name="totem-action-play-media-device"></a><h3>totem_action_play_media_device ()</h3>
734
 
<pre class="programlisting"><span class="returnvalue">void</span>                totem_action_play_media_device      (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>,
735
 
                                                         <em class="parameter"><code>const <span class="type">char</span> *device</code></em>);</pre>
736
 
<p>
737
 
Attempts to play the media device (for example, a DVD drive or CD drive)
738
 
with the given <em class="parameter"><code>device</code></em> path by first adding it to the playlist, then
739
 
playing it.
740
 
</p>
741
 
<p>
742
 
An error dialog will be displayed if Totem cannot read or play what's on
743
 
the media device.
744
 
</p>
745
 
<div class="variablelist"><table border="0">
746
 
<col align="left" valign="top">
747
 
<tbody>
748
 
<tr>
749
 
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
750
 
<td>a <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a>
751
 
</td>
752
 
</tr>
753
 
<tr>
754
 
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
755
 
<td>the media device's path</td>
756
 
</tr>
757
 
</tbody>
758
 
</table></div>
759
 
</div>
760
 
<hr>
761
 
<div class="refsect2">
762
681
<a name="totem-object-action-play-pause"></a><h3>totem_object_action_play_pause ()</h3>
763
682
<pre class="programlisting"><span class="returnvalue">void</span>                totem_object_action_play_pause      (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>);</pre>
764
683
<p>
765
684
Gets the current MRL from the playlist and attempts to play it.
766
685
If the stream is already playing, playback is paused.
767
686
</p>
768
 
<div class="variablelist"><table border="0">
 
687
<div class="variablelist"><table border="0" class="variablelist">
 
688
<colgroup>
769
689
<col align="left" valign="top">
 
690
<col>
 
691
</colgroup>
770
692
<tbody><tr>
771
693
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
772
694
<td>a <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a>
782
704
Pauses the current stream. If Totem is already paused, it continues
783
705
to be paused.
784
706
</p>
785
 
<div class="variablelist"><table border="0">
 
707
<div class="variablelist"><table border="0" class="variablelist">
 
708
<colgroup>
786
709
<col align="left" valign="top">
 
710
<col>
 
711
</colgroup>
787
712
<tbody><tr>
788
713
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
789
714
<td>a <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a>
798
723
<p>
799
724
Stops the current stream.
800
725
</p>
801
 
<div class="variablelist"><table border="0">
 
726
<div class="variablelist"><table border="0" class="variablelist">
 
727
<colgroup>
802
728
<col align="left" valign="top">
 
729
<col>
 
730
</colgroup>
803
731
<tbody><tr>
804
732
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
805
733
<td>a <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a>
815
743
<p>
816
744
Sets Totem's fullscreen state according to <em class="parameter"><code>state</code></em>.
817
745
</p>
818
 
<div class="variablelist"><table border="0">
 
746
<div class="variablelist"><table border="0" class="variablelist">
 
747
<colgroup>
819
748
<col align="left" valign="top">
 
749
<col>
 
750
</colgroup>
820
751
<tbody>
821
752
<tr>
822
753
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
840
771
Toggles Totem's fullscreen state; if Totem is fullscreened, calling
841
772
this makes it unfullscreened and vice-versa.
842
773
</p>
843
 
<div class="variablelist"><table border="0">
 
774
<div class="variablelist"><table border="0" class="variablelist">
 
775
<colgroup>
844
776
<col align="left" valign="top">
 
777
<col>
 
778
</colgroup>
845
779
<tbody><tr>
846
780
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
847
781
<td>a <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a>
857
791
If a DVD is being played, goes to the next chapter. If a normal stream
858
792
is being played, plays the next entry in the playlist.
859
793
</p>
860
 
<div class="variablelist"><table border="0">
 
794
<div class="variablelist"><table border="0" class="variablelist">
 
795
<colgroup>
861
796
<col align="left" valign="top">
 
797
<col>
 
798
</colgroup>
862
799
<tbody><tr>
863
800
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
864
801
<td>a <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a>
875
812
is being played, goes to the start of the stream if possible. If seeking is
876
813
not possible, plays the previous entry in the playlist.
877
814
</p>
878
 
<div class="variablelist"><table border="0">
 
815
<div class="variablelist"><table border="0" class="variablelist">
 
816
<colgroup>
879
817
<col align="left" valign="top">
 
818
<col>
 
819
</colgroup>
880
820
<tbody><tr>
881
821
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
882
822
<td>a <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a>
892
832
Switches to the next angle, if watching a DVD. If not watching a DVD, this is a
893
833
no-op.
894
834
</p>
895
 
<div class="variablelist"><table border="0">
 
835
<div class="variablelist"><table border="0" class="variablelist">
 
836
<colgroup>
896
837
<col align="left" valign="top">
 
838
<col>
 
839
</colgroup>
897
840
<tbody><tr>
898
841
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
899
842
<td>a <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a>
910
853
<p>
911
854
Returns the value of <em class="parameter"><code>setting</code></em> for this instance of Totem.
912
855
</p>
913
 
<div class="variablelist"><table border="0">
 
856
<div class="variablelist"><table border="0" class="variablelist">
 
857
<colgroup>
914
858
<col align="left" valign="top">
 
859
<col>
 
860
</colgroup>
915
861
<tbody>
916
862
<tr>
917
863
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
941
887
<p>
942
888
Sets <em class="parameter"><code>setting</code></em> to <em class="parameter"><code>value</code></em> on this instance of Totem.
943
889
</p>
944
 
<div class="variablelist"><table border="0">
 
890
<div class="variablelist"><table border="0" class="variablelist">
 
891
<colgroup>
945
892
<col align="left" valign="top">
 
893
<col>
 
894
</colgroup>
946
895
<tbody>
947
896
<tr>
948
897
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
971
920
Seeks to an absolute time in the stream, or displays an
972
921
error dialog if that's not possible.
973
922
</p>
974
 
<div class="variablelist"><table border="0">
 
923
<div class="variablelist"><table border="0" class="variablelist">
 
924
<colgroup>
975
925
<col align="left" valign="top">
 
926
<col>
 
927
</colgroup>
976
928
<tbody>
977
929
<tr>
978
930
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1000
952
Seeks to an <em class="parameter"><code>offset</code></em> from the current position in the stream,
1001
953
or displays an error dialog if that's not possible.
1002
954
</p>
1003
 
<div class="variablelist"><table border="0">
 
955
<div class="variablelist"><table border="0" class="variablelist">
 
956
<colgroup>
1004
957
<col align="left" valign="top">
 
958
<col>
 
959
</colgroup>
1005
960
<tbody>
1006
961
<tr>
1007
962
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1027
982
<p>
1028
983
Sets the volume, with <code class="code">1.0</code> being the maximum, and <code class="code">0.0</code> being the minimum level.
1029
984
</p>
1030
 
<div class="variablelist"><table border="0">
 
985
<div class="variablelist"><table border="0" class="variablelist">
 
986
<colgroup>
1031
987
<col align="left" valign="top">
 
988
<col>
 
989
</colgroup>
1032
990
<tbody>
1033
991
<tr>
1034
992
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1051
1009
Sets the volume relative to its current level, with <code class="code">1.0</code> being the
1052
1010
maximum, and <code class="code">0.0</code> being the minimum level.
1053
1011
</p>
1054
 
<div class="variablelist"><table border="0">
 
1012
<div class="variablelist"><table border="0" class="variablelist">
 
1013
<colgroup>
1055
1014
<col align="left" valign="top">
 
1015
<col>
 
1016
</colgroup>
1056
1017
<tbody>
1057
1018
<tr>
1058
1019
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1073
1034
<p>
1074
1035
Toggles the mute status.
1075
1036
</p>
1076
 
<div class="variablelist"><table border="0">
 
1037
<div class="variablelist"><table border="0" class="variablelist">
 
1038
<colgroup>
1077
1039
<col align="left" valign="top">
 
1040
<col>
 
1041
</colgroup>
1078
1042
<tbody><tr>
1079
1043
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1080
1044
<td>a <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a>
1090
1054
Toggles the aspect ratio selected in the menu to the
1091
1055
next one in the list.
1092
1056
</p>
1093
 
<div class="variablelist"><table border="0">
 
1057
<div class="variablelist"><table border="0" class="variablelist">
 
1058
<colgroup>
1094
1059
<col align="left" valign="top">
 
1060
<col>
 
1061
</colgroup>
1095
1062
<tbody><tr>
1096
1063
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1097
1064
<td>a <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a>
1106
1073
<p>
1107
1074
Gets the current aspect ratio as defined in <a class="link" href="BaconVideoWidget.html#BvwAspectRatio" title="enum BvwAspectRatio"><span class="type">BvwAspectRatio</span></a>.
1108
1075
</p>
1109
 
<div class="variablelist"><table border="0">
 
1076
<div class="variablelist"><table border="0" class="variablelist">
 
1077
<colgroup>
1110
1078
<col align="left" valign="top">
 
1079
<col>
 
1080
</colgroup>
1111
1081
<tbody>
1112
1082
<tr>
1113
1083
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1130
1100
Sets the aspect ratio selected in the menu to <em class="parameter"><code>ratio</code></em>,
1131
1101
as defined in <a class="link" href="BaconVideoWidget.html#BvwAspectRatio" title="enum BvwAspectRatio"><span class="type">BvwAspectRatio</span></a>.
1132
1102
</p>
1133
 
<div class="variablelist"><table border="0">
 
1103
<div class="variablelist"><table border="0" class="variablelist">
 
1104
<colgroup>
1134
1105
<col align="left" valign="top">
 
1106
<col>
 
1107
</colgroup>
1135
1108
<tbody>
1136
1109
<tr>
1137
1110
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1153
1126
If Totem's not fullscreened, this toggles the state of the "Show Controls"
1154
1127
menu entry, and consequently shows or hides the controls in the UI.
1155
1128
</p>
1156
 
<div class="variablelist"><table border="0">
 
1129
<div class="variablelist"><table border="0" class="variablelist">
 
1130
<colgroup>
1157
1131
<col align="left" valign="top">
 
1132
<col>
 
1133
</colgroup>
1158
1134
<tbody><tr>
1159
1135
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1160
1136
<td>a <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a>
1171
1147
Sets the video scale ratio, as a float where, for example,
1172
1148
1.0 is 1:1 and 2.0 is 2:1.
1173
1149
</p>
1174
 
<div class="variablelist"><table border="0">
 
1150
<div class="variablelist"><table border="0" class="variablelist">
 
1151
<colgroup>
1175
1152
<col align="left" valign="top">
 
1153
<col>
 
1154
</colgroup>
1176
1155
<tbody>
1177
1156
<tr>
1178
1157
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1199
1178
If <em class="parameter"><code>index</code></em> is higher than the current length of the playlist, this
1200
1179
has the effect of restarting the current playlist entry.
1201
1180
</p>
1202
 
<div class="variablelist"><table border="0">
 
1181
<div class="variablelist"><table border="0" class="variablelist">
 
1182
<colgroup>
1203
1183
<col align="left" valign="top">
 
1184
<col>
 
1185
</colgroup>
1204
1186
<tbody>
1205
1187
<tr>
1206
1188
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1229
1211
If Totem's fullscreened and the operation is executed correctly,
1230
1212
the controls will appear as if the user had moved the mouse.
1231
1213
</p>
1232
 
<div class="variablelist"><table border="0">
 
1214
<div class="variablelist"><table border="0" class="variablelist">
 
1215
<colgroup>
1233
1216
<col align="left" valign="top">
 
1217
<col>
 
1218
</colgroup>
1234
1219
<tbody>
1235
1220
<tr>
1236
1221
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1257
1242
<p>
1258
1243
Returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if Totem is fullscreened.
1259
1244
</p>
1260
 
<div class="variablelist"><table border="0">
 
1245
<div class="variablelist"><table border="0" class="variablelist">
 
1246
<colgroup>
1261
1247
<col align="left" valign="top">
 
1248
<col>
 
1249
</colgroup>
1262
1250
<tbody>
1263
1251
<tr>
1264
1252
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1280
1268
<p>
1281
1269
Returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if Totem is playing a stream.
1282
1270
</p>
1283
 
<div class="variablelist"><table border="0">
 
1271
<div class="variablelist"><table border="0" class="variablelist">
 
1272
<colgroup>
1284
1273
<col align="left" valign="top">
 
1274
<col>
 
1275
</colgroup>
1285
1276
<tbody>
1286
1277
<tr>
1287
1278
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1303
1294
<p>
1304
1295
Returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if playback is paused.
1305
1296
</p>
1306
 
<div class="variablelist"><table border="0">
 
1297
<div class="variablelist"><table border="0" class="variablelist">
 
1298
<colgroup>
1307
1299
<col align="left" valign="top">
 
1300
<col>
 
1301
</colgroup>
1308
1302
<tbody>
1309
1303
<tr>
1310
1304
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1326
1320
<p>
1327
1321
Returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the current stream is seekable.
1328
1322
</p>
1329
 
<div class="variablelist"><table border="0">
 
1323
<div class="variablelist"><table border="0" class="variablelist">
 
1324
<colgroup>
1330
1325
<col align="left" valign="top">
 
1326
<col>
 
1327
</colgroup>
1331
1328
<tbody>
1332
1329
<tr>
1333
1330
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1345
1342
<hr>
1346
1343
<div class="refsect2">
1347
1344
<a name="totem-object-get-main-window"></a><h3>totem_object_get_main_window ()</h3>
1348
 
<pre class="programlisting"><a href="http://developer.gnome.org/devel/gtk/GtkWindow.html"><span class="returnvalue">GtkWindow</span></a> *         totem_object_get_main_window        (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>);</pre>
 
1345
<pre class="programlisting"><a href="http://developer.gnome.org/gtk2/GtkWindow.html"><span class="returnvalue">GtkWindow</span></a> *         totem_object_get_main_window        (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>);</pre>
1349
1346
<p>
1350
1347
Gets Totem's main window and increments its reference count.
1351
1348
</p>
1352
 
<div class="variablelist"><table border="0">
 
1349
<div class="variablelist"><table border="0" class="variablelist">
 
1350
<colgroup>
1353
1351
<col align="left" valign="top">
 
1352
<col>
 
1353
</colgroup>
1354
1354
<tbody>
1355
1355
<tr>
1356
1356
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1368
1368
<hr>
1369
1369
<div class="refsect2">
1370
1370
<a name="totem-object-get-ui-manager"></a><h3>totem_object_get_ui_manager ()</h3>
1371
 
<pre class="programlisting"><a href="http://developer.gnome.org/devel/gtk/GtkUIManager.html"><span class="returnvalue">GtkUIManager</span></a> *      totem_object_get_ui_manager         (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>);</pre>
 
1371
<pre class="programlisting"><a href="http://developer.gnome.org/gtk2/GtkUIManager.html"><span class="returnvalue">GtkUIManager</span></a> *      totem_object_get_ui_manager         (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>);</pre>
1372
1372
<p>
1373
1373
Gets Totem's UI manager, but does not change its reference count.
1374
1374
</p>
1375
 
<div class="variablelist"><table border="0">
 
1375
<div class="variablelist"><table border="0" class="variablelist">
 
1376
<colgroup>
1376
1377
<col align="left" valign="top">
 
1378
<col>
 
1379
</colgroup>
1377
1380
<tbody>
1378
1381
<tr>
1379
1382
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1390
1393
</div>
1391
1394
<hr>
1392
1395
<div class="refsect2">
1393
 
<a name="totem-get-video-widget"></a><h3>totem_get_video_widget ()</h3>
1394
 
<pre class="programlisting"><a href="http://developer.gnome.org/devel/gtk/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         totem_get_video_widget              (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>);</pre>
1395
 
<p>
1396
 
Gets Totem's video widget and increments its reference count.
1397
 
</p>
1398
 
<div class="variablelist"><table border="0">
1399
 
<col align="left" valign="top">
1400
 
<tbody>
1401
 
<tr>
1402
 
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1403
 
<td>a <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a>
1404
 
</td>
1405
 
</tr>
1406
 
<tr>
1407
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1408
 
<td>Totem's video widget. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
1409
 
</td>
1410
 
</tr>
1411
 
</tbody>
1412
 
</table></div>
1413
 
</div>
1414
 
<hr>
1415
 
<div class="refsect2">
1416
 
<a name="totem-get-video-widget-backend-name"></a><h3>totem_get_video_widget_backend_name ()</h3>
1417
 
<pre class="programlisting"><span class="returnvalue">char</span> *              totem_get_video_widget_backend_name (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>);</pre>
1418
 
<p>
1419
 
Gets the name string of the backend video widget, typically the video library's
1420
 
version string (e.g. what's returned by <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-Gst.html#gst-version-string"><code class="function">gst_version_string()</code></a>). Free with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>.
1421
 
</p>
1422
 
<div class="variablelist"><table border="0">
1423
 
<col align="left" valign="top">
1424
 
<tbody>
1425
 
<tr>
1426
 
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1427
 
<td>a <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a>
1428
 
</td>
1429
 
</tr>
1430
 
<tr>
1431
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1432
 
<td>a newly-allocated string of the name of the backend video widget</td>
1433
 
</tr>
1434
 
</tbody>
1435
 
</table></div>
1436
 
</div>
1437
 
<hr>
1438
 
<div class="refsect2">
1439
1396
<a name="totem-object-get-current-mrl"></a><h3>totem_object_get_current_mrl ()</h3>
1440
1397
<pre class="programlisting"><span class="returnvalue">char</span> *              totem_object_get_current_mrl        (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>);</pre>
1441
1398
<p>
1442
1399
Get the MRL of the current stream, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if nothing's playing.
1443
1400
Free with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>.
1444
1401
</p>
1445
 
<div class="variablelist"><table border="0">
 
1402
<div class="variablelist"><table border="0" class="variablelist">
 
1403
<colgroup>
1446
1404
<col align="left" valign="top">
 
1405
<col>
 
1406
</colgroup>
1447
1407
<tbody>
1448
1408
<tr>
1449
1409
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1459
1419
</div>
1460
1420
<hr>
1461
1421
<div class="refsect2">
 
1422
<a name="totem-object-get-video-widget"></a><h3>totem_object_get_video_widget ()</h3>
 
1423
<pre class="programlisting"><a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         totem_object_get_video_widget       (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>);</pre>
 
1424
<p>
 
1425
Gets Totem's video widget and increments its reference count.
 
1426
</p>
 
1427
<div class="variablelist"><table border="0" class="variablelist">
 
1428
<colgroup>
 
1429
<col align="left" valign="top">
 
1430
<col>
 
1431
</colgroup>
 
1432
<tbody>
 
1433
<tr>
 
1434
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
 
1435
<td>a <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a>
 
1436
</td>
 
1437
</tr>
 
1438
<tr>
 
1439
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1440
<td>Totem's video widget. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
1441
</td>
 
1442
</tr>
 
1443
</tbody>
 
1444
</table></div>
 
1445
</div>
 
1446
<hr>
 
1447
<div class="refsect2">
1462
1448
<a name="totem-get-current-time"></a><h3>totem_get_current_time ()</h3>
1463
1449
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a>              totem_get_current_time              (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>);</pre>
1464
1450
<p>
1465
1451
Gets the current position's time in the stream as a gint64.
1466
1452
</p>
1467
 
<div class="variablelist"><table border="0">
 
1453
<div class="variablelist"><table border="0" class="variablelist">
 
1454
<colgroup>
1468
1455
<col align="left" valign="top">
 
1456
<col>
 
1457
</colgroup>
1469
1458
<tbody>
1470
1459
<tr>
1471
1460
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1488
1477
Add the <em class="parameter"><code>subtitle_uri</code></em> subtitle file to the playlist, setting it as the subtitle for the current
1489
1478
playlist entry.
1490
1479
</p>
1491
 
<div class="variablelist"><table border="0">
 
1480
<div class="variablelist"><table border="0" class="variablelist">
 
1481
<colgroup>
1492
1482
<col align="left" valign="top">
 
1483
<col>
 
1484
</colgroup>
1493
1485
<tbody>
1494
1486
<tr>
1495
1487
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1510
1502
<p>
1511
1503
Returns the length of the current playlist.
1512
1504
</p>
1513
 
<div class="variablelist"><table border="0">
 
1505
<div class="variablelist"><table border="0" class="variablelist">
 
1506
<colgroup>
1514
1507
<col align="left" valign="top">
 
1508
<col>
 
1509
</colgroup>
1515
1510
<tbody>
1516
1511
<tr>
1517
1512
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1533
1528
Returns the <code class="code">0</code>-based index of the current entry in the playlist. If
1534
1529
there is no current entry in the playlist, <code class="code">-1</code> is returned.
1535
1530
</p>
1536
 
<div class="variablelist"><table border="0">
 
1531
<div class="variablelist"><table border="0" class="variablelist">
 
1532
<colgroup>
1537
1533
<col align="left" valign="top">
 
1534
<col>
 
1535
</colgroup>
1538
1536
<tbody>
1539
1537
<tr>
1540
1538
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1558
1556
<p>
1559
1557
Gets the title of the playlist entry at <em class="parameter"><code>index</code></em>.
1560
1558
</p>
1561
 
<div class="variablelist"><table border="0">
 
1559
<div class="variablelist"><table border="0" class="variablelist">
 
1560
<colgroup>
1562
1561
<col align="left" valign="top">
 
1562
<col>
 
1563
</colgroup>
1563
1564
<tbody>
1564
1565
<tr>
1565
1566
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1585
1586
<p>
1586
1587
Gets the title of the current entry in the playlist.
1587
1588
</p>
1588
 
<div class="variablelist"><table border="0">
 
1589
<div class="variablelist"><table border="0" class="variablelist">
 
1590
<colgroup>
1589
1591
<col align="left" valign="top">
 
1592
<col>
 
1593
</colgroup>
1590
1594
<tbody>
1591
1595
<tr>
1592
1596
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1608
1612
<p>
1609
1613
Gets the current volume level, as a value between <code class="code">0.0</code> and <code class="code">1.0</code>.
1610
1614
</p>
1611
 
<div class="variablelist"><table border="0">
 
1615
<div class="variablelist"><table border="0" class="variablelist">
 
1616
<colgroup>
1612
1617
<col align="left" valign="top">
 
1618
<col>
 
1619
</colgroup>
1613
1620
<tbody>
1614
1621
<tr>
1615
1622
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1630
1637
<p>
1631
1638
Gets the application name and version (e.g. "Totem 2.28.0").
1632
1639
</p>
1633
 
<div class="variablelist"><table border="0">
 
1640
<div class="variablelist"><table border="0" class="variablelist">
 
1641
<colgroup>
1634
1642
<col align="left" valign="top">
 
1643
<col>
 
1644
</colgroup>
1635
1645
<tbody><tr>
1636
1646
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1637
1647
<td>a newly-allocated string of the name and version of the application</td>
1644
1654
<pre class="programlisting"><span class="returnvalue">void</span>                totem_object_add_sidebar_page       (<em class="parameter"><code><a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem</code></em>,
1645
1655
                                                         <em class="parameter"><code>const <span class="type">char</span> *page_id</code></em>,
1646
1656
                                                         <em class="parameter"><code>const <span class="type">char</span> *title</code></em>,
1647
 
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/devel/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *main_widget</code></em>);</pre>
 
1657
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="type">GtkWidget</span></a> *main_widget</code></em>);</pre>
1648
1658
<p>
1649
1659
Adds a sidebar page to Totem's sidebar with the given <em class="parameter"><code>page_id</code></em>.
1650
1660
<em class="parameter"><code>main_widget</code></em> is added into the page and shown automatically, while
1651
1661
<em class="parameter"><code>title</code></em> is displayed as the page's title in the tab bar.
1652
1662
</p>
1653
 
<div class="variablelist"><table border="0">
 
1663
<div class="variablelist"><table border="0" class="variablelist">
 
1664
<colgroup>
1654
1665
<col align="left" valign="top">
 
1666
<col>
 
1667
</colgroup>
1655
1668
<tbody>
1656
1669
<tr>
1657
1670
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1683
1696
If <em class="parameter"><code>page_id</code></em> doesn't exist in the sidebar, this function does
1684
1697
nothing.
1685
1698
</p>
1686
 
<div class="variablelist"><table border="0">
 
1699
<div class="variablelist"><table border="0" class="variablelist">
 
1700
<colgroup>
1687
1701
<col align="left" valign="top">
 
1702
<col>
 
1703
</colgroup>
1688
1704
<tbody>
1689
1705
<tr>
1690
1706
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1706
1722
<p>
1707
1723
Get the full list of file content types which Totem supports playing.
1708
1724
</p>
1709
 
<div class="variablelist"><table border="0">
 
1725
<div class="variablelist"><table border="0" class="variablelist">
 
1726
<colgroup>
1710
1727
<col align="left" valign="top">
 
1728
<col>
 
1729
</colgroup>
1711
1730
<tbody><tr>
1712
1731
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1713
1732
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated array of the content types Totem supports. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
1724
1743
<p>
1725
1744
Get the full list of URI schemes which Totem supports accessing.
1726
1745
</p>
1727
 
<div class="variablelist"><table border="0">
 
1746
<div class="variablelist"><table border="0" class="variablelist">
 
1747
<colgroup>
1728
1748
<col align="left" valign="top">
 
1749
<col>
 
1750
</colgroup>
1729
1751
<tbody><tr>
1730
1752
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1731
1753
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated array of the URI schemes Totem supports. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
1738
1760
<div class="refsect1">
1739
1761
<a name="TotemObject.property-details"></a><h2>Property Details</h2>
1740
1762
<div class="refsect2">
 
1763
<a name="TotemObject--current-content-type"></a><h3>The <code class="literal">"current-content-type"</code> property</h3>
 
1764
<pre class="programlisting">  "current-content-type"     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
 
1765
<p>
 
1766
The content-type of the current stream.
 
1767
</p>
 
1768
<p>Default value: NULL</p>
 
1769
</div>
 
1770
<hr>
 
1771
<div class="refsect2">
 
1772
<a name="TotemObject--current-display-name"></a><h3>The <code class="literal">"current-display-name"</code> property</h3>
 
1773
<pre class="programlisting">  "current-display-name"     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
 
1774
<p>
 
1775
The display name of the current stream.
 
1776
</p>
 
1777
<p>Default value: NULL</p>
 
1778
</div>
 
1779
<hr>
 
1780
<div class="refsect2">
1741
1781
<a name="TotemObject--current-mrl"></a><h3>The <code class="literal">"current-mrl"</code> property</h3>
1742
1782
<pre class="programlisting">  "current-mrl"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
1743
1783
<p>
1809
1849
<p>
1810
1850
The <a class="link" href="TotemObject.html#TotemObject-file-closed" title='The "file-closed" signal'><span class="type">"file-closed"</span></a> signal is emitted when Totem closes a stream.
1811
1851
</p>
1812
 
<div class="variablelist"><table border="0">
1813
 
<col align="left" valign="top">
1814
 
<tbody>
1815
 
<tr>
1816
 
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1817
 
<td>the <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> which received the signal</td>
 
1852
<div class="variablelist"><table border="0" class="variablelist">
 
1853
<colgroup>
 
1854
<col align="left" valign="top">
 
1855
<col>
 
1856
</colgroup>
 
1857
<tbody>
 
1858
<tr>
 
1859
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
 
1860
<td>the <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> which received the signal</td>
 
1861
</tr>
 
1862
<tr>
 
1863
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
1864
<td>user data set when the signal handler was connected.</td>
 
1865
</tr>
 
1866
</tbody>
 
1867
</table></div>
 
1868
</div>
 
1869
<hr>
 
1870
<div class="refsect2">
 
1871
<a name="TotemObject-file-has-played"></a><h3>The <code class="literal">"file-has-played"</code> signal</h3>
 
1872
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem,
 
1873
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>       *mrl,
 
1874
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>     user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
1875
<p>
 
1876
The <a class="link" href="TotemObject.html#TotemObject-file-has-played" title='The "file-has-played" signal'><span class="type">"file-has-played"</span></a> signal is emitted when a new stream has started playing in Totem.
 
1877
</p>
 
1878
<div class="variablelist"><table border="0" class="variablelist">
 
1879
<colgroup>
 
1880
<col align="left" valign="top">
 
1881
<col>
 
1882
</colgroup>
 
1883
<tbody>
 
1884
<tr>
 
1885
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
 
1886
<td>the <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> which received the signal</td>
 
1887
</tr>
 
1888
<tr>
 
1889
<td><p><span class="term"><em class="parameter"><code>mrl</code></em> :</span></p></td>
 
1890
<td>the MRL of the opened stream</td>
1818
1891
</tr>
1819
1892
<tr>
1820
1893
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1832
1905
<p>
1833
1906
The <a class="link" href="TotemObject.html#TotemObject-file-opened" title='The "file-opened" signal'><span class="type">"file-opened"</span></a> signal is emitted when a new stream is opened by Totem.
1834
1907
</p>
1835
 
<div class="variablelist"><table border="0">
 
1908
<div class="variablelist"><table border="0" class="variablelist">
 
1909
<colgroup>
1836
1910
<col align="left" valign="top">
 
1911
<col>
 
1912
</colgroup>
1837
1913
<tbody>
1838
1914
<tr>
1839
1915
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1853
1929
<hr>
1854
1930
<div class="refsect2">
1855
1931
<a name="TotemObject-get-text-subtitle"></a><h3>The <code class="literal">"get-text-subtitle"</code> signal</h3>
1856
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>*              user_function                      (<a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totemobject,
1857
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>       *arg1,
1858
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>     user_data)        : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
1932
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>*              user_function                      (<a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem,
 
1933
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>       *mrl,
 
1934
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>     user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
1935
<p>
 
1936
The <a class="link" href="TotemObject.html#TotemObject-get-text-subtitle" title='The "get-text-subtitle" signal'><span class="type">"get-text-subtitle"</span></a> signal is emitted before opening a stream, so that plugins
 
1937
have the opportunity to detect or download text subtitles for the stream if necessary.
 
1938
</p>
 
1939
<div class="variablelist"><table border="0" class="variablelist">
 
1940
<colgroup>
 
1941
<col align="left" valign="top">
 
1942
<col>
 
1943
</colgroup>
 
1944
<tbody>
 
1945
<tr>
 
1946
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
 
1947
<td>the <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> which received the signal</td>
 
1948
</tr>
 
1949
<tr>
 
1950
<td><p><span class="term"><em class="parameter"><code>mrl</code></em> :</span></p></td>
 
1951
<td>the MRL of the opened stream</td>
 
1952
</tr>
 
1953
<tr>
 
1954
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
1955
<td>user data set when the signal handler was connected.</td>
 
1956
</tr>
 
1957
<tr>
 
1958
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1959
<td>allocated string representing the URI of the subtitle to use for <em class="parameter"><code>mrl</code></em>
 
1960
</td>
 
1961
</tr>
 
1962
</tbody>
 
1963
</table></div>
1859
1964
</div>
1860
1965
<hr>
1861
1966
<div class="refsect2">
1862
1967
<a name="TotemObject-get-user-agent"></a><h3>The <code class="literal">"get-user-agent"</code> signal</h3>
1863
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>*              user_function                      (<a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totemobject,
1864
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>       *arg1,
1865
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>     user_data)        : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
1968
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>*              user_function                      (<a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> *totem,
 
1969
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>       *mrl,
 
1970
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>     user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
1971
<p>
 
1972
The <a class="link" href="TotemObject.html#TotemObject-get-user-agent" title='The "get-user-agent" signal'><span class="type">"get-user-agent"</span></a> signal is emitted before opening a stream, so that plugins
 
1973
have the opportunity to return the user-agent to be set.
 
1974
</p>
 
1975
<div class="variablelist"><table border="0" class="variablelist">
 
1976
<colgroup>
 
1977
<col align="left" valign="top">
 
1978
<col>
 
1979
</colgroup>
 
1980
<tbody>
 
1981
<tr>
 
1982
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
 
1983
<td>the <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> which received the signal</td>
 
1984
</tr>
 
1985
<tr>
 
1986
<td><p><span class="term"><em class="parameter"><code>mrl</code></em> :</span></p></td>
 
1987
<td>the MRL of the opened stream</td>
 
1988
</tr>
 
1989
<tr>
 
1990
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
1991
<td>user data set when the signal handler was connected.</td>
 
1992
</tr>
 
1993
<tr>
 
1994
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1995
<td>allocated string representing the user-agent to use for <em class="parameter"><code>mrl</code></em>
 
1996
</td>
 
1997
</tr>
 
1998
</tbody>
 
1999
</table></div>
1866
2000
</div>
1867
2001
<hr>
1868
2002
<div class="refsect2">
1877
2011
The <a class="link" href="TotemObject.html#TotemObject-metadata-updated" title='The "metadata-updated" signal'><span class="type">"metadata-updated"</span></a> signal is emitted when the metadata of a stream is updated, typically
1878
2012
when it's being loaded.
1879
2013
</p>
1880
 
<div class="variablelist"><table border="0">
 
2014
<div class="variablelist"><table border="0" class="variablelist">
 
2015
<colgroup>
1881
2016
<col align="left" valign="top">
 
2017
<col>
 
2018
</colgroup>
1882
2019
<tbody>
1883
2020
<tr>
1884
2021
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
1914
2051
</div>
1915
2052
<div class="footer">
1916
2053
<hr>
1917
 
          Generated by GTK-Doc V1.18</div>
 
2054
          Generated by GTK-Doc V1.18.1</div>
1918
2055
</body>
1919
2056
</html>
 
 
b'\\ No newline at end of file'