~ubuntu-branches/ubuntu/lucid/totem/lucid-updates

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-05-18 11:26:39 UTC
  • mfrom: (1.11.9 upstream)
  • Revision ID: james.westby@ubuntu.com-20100518112639-ropmafpm9nxy25cl
Tags: 2.30.2-0ubuntu1
* New upstream version:
  - Fix volume being at zero when starting playback (lp: #514658)

Show diffs side-by-side

added added

removed removed

Lines of Context:
69
69
enum                <a class="link" href="BaconVideoWidget.html#BvwError" title="enum BvwError">BvwError</a>;
70
70
enum                <a class="link" href="BaconVideoWidget.html#BvwUseType" title="enum BvwUseType">BvwUseType</a>;
71
71
<a
72
 
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
 
72
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
73
73
>GtkWidget</a> *         <a class="link" href="BaconVideoWidget.html#bacon-video-widget-new" title="bacon_video_widget_new ()">bacon_video_widget_new</a>              (int width,
74
74
                                                         int height,
75
75
                                                         <a class="link" href="BaconVideoWidget.html#BvwUseType" title="enum BvwUseType">BvwUseType</a> type,
105
105
>gboolean</a>            <a class="link" href="BaconVideoWidget.html#bacon-video-widget-seek-time" title="bacon_video_widget_seek_time ()">bacon_video_widget_seek_time</a>        (<a class="link" href="BaconVideoWidget.html" title="BaconVideoWidget">BaconVideoWidget</a> *bvw,
106
106
                                                         <a
107
107
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"
108
 
>gint64</a> _time,
 
108
>gint64</a> time,
109
109
                                                         <a
110
110
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
111
111
>GError</a> **error);
155
155
                                                        (<a class="link" href="BaconVideoWidget.html" title="BaconVideoWidget">BaconVideoWidget</a> *bvw,
156
156
                                                         int speed);
157
157
<a
158
 
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
158
href="/usr/share/gtk-doc/html/gdk-pixbuf3/gdk-pixbuf3-gdk-pixbuf.html#GdkPixbuf"
159
159
>GdkPixbuf</a> *         <a class="link" href="BaconVideoWidget.html#bacon-video-widget-get-current-frame" title="bacon_video_widget_get_current_frame ()">bacon_video_widget_get_current_frame</a>
160
160
                                                        (<a class="link" href="BaconVideoWidget.html" title="BaconVideoWidget">BaconVideoWidget</a> *bvw);
161
161
<a
281
281
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
282
282
>gboolean</a>            <a class="link" href="BaconVideoWidget.html#bacon-video-widget-step" title="bacon_video_widget_step ()">bacon_video_widget_step</a>             (<a class="link" href="BaconVideoWidget.html" title="BaconVideoWidget">BaconVideoWidget</a> *bvw,
283
283
                                                         <a
284
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
285
 
>gboolean</a> forward,
286
 
                                                         <a
287
284
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
288
285
>GError</a> **error);
289
286
</pre>
298
295
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
299
296
>GInitiallyUnowned</a>
300
297
         +----<a
301
 
href="http://library.gnome.org/devel/gtk/unstable/GtkObject.html"
 
298
href="/usr/share/gtk-doc/html/gtk/GtkObject.html"
302
299
>GtkObject</a>
303
300
               +----<a
304
 
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
 
301
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
305
302
>GtkWidget</a>
306
303
                     +----<a
307
 
href="http://library.gnome.org/devel/gtk/unstable/GtkContainer.html"
 
304
href="/usr/share/gtk-doc/html/gtk/GtkContainer.html"
308
305
>GtkContainer</a>
309
306
                           +----<a
310
 
href="http://library.gnome.org/devel/gtk/unstable/GtkBin.html"
 
307
href="/usr/share/gtk-doc/html/gtk/GtkBin.html"
311
308
>GtkBin</a>
312
309
                                 +----<a
313
 
href="http://library.gnome.org/devel/gtk/unstable/GtkEventBox.html"
 
310
href="/usr/share/gtk-doc/html/gtk/GtkEventBox.html"
314
311
>GtkEventBox</a>
315
312
                                       +----BaconVideoWidget
316
313
</pre>
320
317
<p>
321
318
BaconVideoWidget implements
322
319
 AtkImplementorIface and  <a
323
 
href="http://library.gnome.org/devel/gtk/unstable/gtk-gtkbuildable.html#GtkBuildable"
 
320
href="/usr/share/gtk-doc/html/gtk/gtk-gtkbuildable.html#GtkBuildable"
324
321
>GtkBuildable</a>.</p>
325
322
</div>
326
323
<div class="refsect1" title="Properties">
327
324
<a name="BaconVideoWidget.properties"></a><h2>Properties</h2>
328
325
<pre class="synopsis">
329
 
  "<a class="link" href="BaconVideoWidget.html#BaconVideoWidget--download-filename" title='The "download-filename" property'>download-filename</a>"        <a
330
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
331
 
>gchar</a>*                : Read / Write
332
326
  "<a class="link" href="BaconVideoWidget.html#BaconVideoWidget--logo-mode" title='The "logo-mode" property'>logo-mode</a>"                <a
333
327
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
334
328
>gboolean</a>              : Read / Write
366
360
<pre class="synopsis">
367
361
  "<a class="link" href="BaconVideoWidget.html#BaconVideoWidget-buffering" title='The "buffering" signal'>buffering</a>"                                      : Run Last
368
362
  "<a class="link" href="BaconVideoWidget.html#BaconVideoWidget-channels-change" title='The "channels-change" signal'>channels-change</a>"                                : Run Last
369
 
  "<a class="link" href="BaconVideoWidget.html#BaconVideoWidget-download-buffering" title='The "download-buffering" signal'>download-buffering</a>"                             : Run Last
370
363
  "<a class="link" href="BaconVideoWidget.html#BaconVideoWidget-eos" title='The "eos" signal'>eos</a>"                                            : Run Last
371
364
  "<a class="link" href="BaconVideoWidget.html#BaconVideoWidget-error" title='The "error" signal'>error</a>"                                          : Run Last
372
365
  "<a class="link" href="BaconVideoWidget.html#BaconVideoWidget-got-metadata" title='The "got-metadata" signal'>got-metadata</a>"                                   : Run Last
696
689
<tr>
697
690
<td><p><a name="BVW-INFO-COVER--CAPS"></a><span class="term"><code class="literal">BVW_INFO_COVER</code></span></p></td>
698
691
<td> a <a
699
 
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
692
href="/usr/share/gtk-doc/html/gdk-pixbuf3/gdk-pixbuf3-gdk-pixbuf.html#GdkPixbuf"
700
693
><span class="type">GdkPixbuf</span></a> of the cover artwork
701
694
</td>
702
695
</tr>
1051
1044
<div class="refsect2" title="bacon_video_widget_new ()">
1052
1045
<a name="bacon-video-widget-new"></a><h3>bacon_video_widget_new ()</h3>
1053
1046
<pre class="programlisting"><a
1054
 
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
 
1047
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
1055
1048
>GtkWidget</a> *         bacon_video_widget_new              (int width,
1056
1049
                                                         int height,
1057
1050
                                                         <a class="link" href="BaconVideoWidget.html#BvwUseType" title="enum BvwUseType">BvwUseType</a> type,
1102
1095
<tr>
1103
1096
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1104
1097
<td> a new <a class="link" href="BaconVideoWidget.html" title="BaconVideoWidget"><span class="type">BaconVideoWidget</span></a>, or <code class="literal">NULL</code>; destroy with <a
1105
 
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html#gtk-widget-destroy"
 
1098
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html#gtk-widget-destroy"
1106
1099
><code class="function">gtk_widget_destroy()</code></a>
1107
1100
</td>
1108
1101
</tr>
1308
1301
>gboolean</a>            bacon_video_widget_seek_time        (<a class="link" href="BaconVideoWidget.html" title="BaconVideoWidget">BaconVideoWidget</a> *bvw,
1309
1302
                                                         <a
1310
1303
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"
1311
 
>gint64</a> _time,
 
1304
>gint64</a> time,
1312
1305
                                                         <a
1313
1306
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
1314
1307
>GError</a> **error);</pre>
1325
1318
</td>
1326
1319
</tr>
1327
1320
<tr>
1328
 
<td><p><span class="term"><em class="parameter"><code>_time</code></em> :</span></p></td>
 
1321
<td><p><span class="term"><em class="parameter"><code>time</code></em> :</span></p></td>
1329
1322
<td> the time to which to seek, in milliseconds
1330
1323
</td>
1331
1324
</tr>
1811
1804
<div class="refsect2" title="bacon_video_widget_get_current_frame ()">
1812
1805
<a name="bacon-video-widget-get-current-frame"></a><h3>bacon_video_widget_get_current_frame ()</h3>
1813
1806
<pre class="programlisting"><a
1814
 
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
1807
href="/usr/share/gtk-doc/html/gdk-pixbuf3/gdk-pixbuf3-gdk-pixbuf.html#GdkPixbuf"
1815
1808
>GdkPixbuf</a> *         bacon_video_widget_get_current_frame
1816
1809
                                                        (<a class="link" href="BaconVideoWidget.html" title="BaconVideoWidget">BaconVideoWidget</a> *bvw);</pre>
1817
1810
<p>
1818
1811
Returns a <a
1819
 
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
1812
href="/usr/share/gtk-doc/html/gdk-pixbuf3/gdk-pixbuf3-gdk-pixbuf.html#GdkPixbuf"
1820
1813
><span class="type">GdkPixbuf</span></a> containing the current frame from the playing
1821
1814
stream. This will wait for any pending seeks to complete before
1822
1815
capturing the frame.</p>
2180
2173
</p>
2181
2174
<p>
2182
2175
<em class="parameter"><code>device</code></em> should typically be the number of the device (e.g. <code class="literal">0</code> for the first
2183
 
DVD drive.
 
2176
DVD drive, or the number of the DVB adapter).
2184
2177
</p>
2185
2178
<p>
2186
2179
<em class="parameter"><code>type</code></em> can be any value from <a
2192
2185
<p>
2193
2186
A <a class="link" href="BaconVideoWidget.html#BVW-ERROR-NO-PLUGIN-FOR-FILE--CAPS"><code class="literal">BVW_ERROR_NO_PLUGIN_FOR_FILE</code></a> error will be returned if the required GStreamer elements do
2194
2187
not exist for the given <em class="parameter"><code>type</code></em> (for the GStreamer backend). *
2195
 
If <em class="parameter"><code>device</code></em> does not exist, a <a class="link" href="BaconVideoWidget.html#BVW-ERROR-INVALID-DEVICE--CAPS"><code class="literal">BVW_ERROR_INVALID_DEVICE</code></a> error will be returned.</p>
 
2188
If <em class="parameter"><code>device</code></em> does not exist, a <a class="link" href="BaconVideoWidget.html#BVW-ERROR-INVALID-DEVICE--CAPS"><code class="literal">BVW_ERROR_INVALID_DEVICE</code></a> error will be returned.
 
2189
</p>
 
2190
<p>
 
2191
If <em class="parameter"><code>type</code></em> is <code class="literal">MEDIA_TYPE_DVB</code> and the DVB channels file (as given by
 
2192
<code class="function">bacon_video_widget_get_channels_file()</code> for the GStreamer backend)
 
2193
does not exist, a <a class="link" href="BaconVideoWidget.html#BVW-ERROR-FILE-NOT-FOUND--CAPS"><code class="literal">BVW_ERROR_FILE_NOT_FOUND</code></a> error will be returned.</p>
2196
2194
<p>
2197
2195
</p>
2198
2196
<div class="variablelist"><table border="0">
2998
2996
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
2999
2997
>gboolean</a>            bacon_video_widget_step             (<a class="link" href="BaconVideoWidget.html" title="BaconVideoWidget">BaconVideoWidget</a> *bvw,
3000
2998
                                                         <a
3001
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
3002
 
>gboolean</a> forward,
3003
 
                                                         <a
3004
2999
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
3005
3000
>GError</a> **error);</pre>
3006
3001
<p>
3007
 
Step one frame forward, if <em class="parameter"><code>forward</code></em> is <code class="literal">TRUE</code>, or backwards, if <em class="parameter"><code>forward</code></em> is <code class="literal">FALSE</code></p>
 
3002
Step one frame forward.</p>
3008
3003
<p>
3009
3004
</p>
3010
3005
<div class="variablelist"><table border="0">
3016
3011
</td>
3017
3012
</tr>
3018
3013
<tr>
3019
 
<td><p><span class="term"><em class="parameter"><code>forward</code></em> :</span></p></td>
3020
 
<td> the direction of the frame step
3021
 
</td>
3022
 
</tr>
3023
 
<tr>
3024
3014
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
3025
3015
<td> a <a
3026
3016
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
3038
3028
</div>
3039
3029
<div class="refsect1" title="Property Details">
3040
3030
<a name="BaconVideoWidget.property-details"></a><h2>Property Details</h2>
3041
 
<div class="refsect2" title='The "download-filename" property'>
3042
 
<a name="BaconVideoWidget--download-filename"></a><h3>The <code class="literal">"download-filename"</code> property</h3>
3043
 
<pre class="programlisting">  "download-filename"        <a
3044
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
3045
 
>gchar</a>*                : Read / Write</pre>
3046
 
<p>
3047
 
The filename of the fully downloaded stream when using
3048
 
download buffering.</p>
3049
 
<p>
3050
 
</p>
3051
 
<p>Default value: NULL</p>
3052
 
</div>
3053
 
<hr>
3054
3031
<div class="refsect2" title='The "logo-mode" property'>
3055
3032
<a name="BaconVideoWidget--logo-mode"></a><h3>The <code class="literal">"logo-mode"</code> property</h3>
3056
3033
<pre class="programlisting">  "logo-mode"                <a
3231
3208
</table></div>
3232
3209
</div>
3233
3210
<hr>
3234
 
<div class="refsect2" title='The "download-buffering" signal'>
3235
 
<a name="BaconVideoWidget-download-buffering"></a><h3>The <code class="literal">"download-buffering"</code> signal</h3>
3236
 
<pre class="programlisting">void                user_function                      (<a class="link" href="BaconVideoWidget.html" title="BaconVideoWidget">BaconVideoWidget</a> *percentage,
3237
 
                                                        <a
3238
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"
3239
 
>gdouble</a>           arg1,
3240
 
                                                        <a
3241
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
3242
 
>gpointer</a>          user_data)       : Run Last</pre>
3243
 
<p>
3244
 
Emitted regularly when a network stream is being cached on disk, to provide status
3245
 
 updates on the buffering level of the stream.</p>
3246
 
<p>
3247
 
</p>
3248
 
<div class="variablelist"><table border="0">
3249
 
<col align="left" valign="top">
3250
 
<tbody>
3251
 
<tr>
3252
 
<td><p><span class="term"><em class="parameter"><code>percentage</code></em> :</span></p></td>
3253
 
<td> the percentage of download buffering completed, between <code class="literal">0</code> and <code class="literal">1</code>
3254
 
</td>
3255
 
</tr>
3256
 
<tr>
3257
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
3258
 
<td>user data set when the signal handler was connected.</td>
3259
 
</tr>
3260
 
</tbody>
3261
 
</table></div>
3262
 
</div>
3263
 
<hr>
3264
3211
<div class="refsect2" title='The "eos" signal'>
3265
3212
<a name="BaconVideoWidget-eos"></a><h3>The <code class="literal">"eos"</code> signal</h3>
3266
3213
<pre class="programlisting">void                user_function                      (<a class="link" href="BaconVideoWidget.html" title="BaconVideoWidget">BaconVideoWidget</a> *arg0,