~ubuntu-branches/ubuntu/saucy/totem/saucy-proposed

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Michael Biebl, Sebastien Bacher, Josselin Mouette, Michael Biebl
  • Date: 2011-06-10 00:36:38 UTC
  • mfrom: (1.4.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20110610003638-vnc19ldjqjt02w8w
Tags: 3.0.1-1
[ Sebastien Bacher ]
* New upstream version
* debian/control.in:
  - don't Build-Depends on xulrunner-dev
  - let libtotem0 Replaces totem (<< 3.0.1-1), it's not required for Debian
    but is not an issue either and will lower the delta with Ubuntu
  - update Standards-Version to 3.9.2
* debian/totem-common.install:
  - install the thumbnailers directory there
    Closes: #629536.
* debian/totem.preinst: clean it now that squeeze is out

[ Josselin Mouette ]
* Add libtotem-dev. Closes: #561934.

[ Michael Biebl ]
* debian/watch: Switch to .bz2 tarball.
* Bump debhelper compatibility level to 8.
  - Update Build-Depends on debhelper.
  - Strip leading debian/tmp/ from .install files.
* debian/totem-plugins.install
  - Install tracker and gromit plugin.
* debian/control.in
  - Remove obsolete Build-Depends on dpkg-dev (>= 1.13.19).
* debian/libtotem-dev.install
  - Install libtotem.so symlink.

Show diffs side-by-side

added added

removed removed

Lines of Context:
62
62
enum                <a class="link" href="BaconVideoWidget.html#BvwVisualizationQuality" title="enum BvwVisualizationQuality">BvwVisualizationQuality</a>;
63
63
enum                <a class="link" href="BaconVideoWidget.html#BvwVideoProperty" title="enum BvwVideoProperty">BvwVideoProperty</a>;
64
64
enum                <a class="link" href="BaconVideoWidget.html#BvwError" title="enum BvwError">BvwError</a>;
65
 
enum                <a class="link" href="BaconVideoWidget.html#BvwUseType" title="enum BvwUseType">BvwUseType</a>;
66
 
<a href="http://library.gnome.org/devel/gtk/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="BaconVideoWidget.html#bacon-video-widget-new" title="bacon_video_widget_new ()">bacon_video_widget_new</a>              (<em class="parameter"><code><span class="type">int</span> width</code></em>,
67
 
                                                         <em class="parameter"><code><span class="type">int</span> height</code></em>,
68
 
                                                         <em class="parameter"><code><a class="link" href="BaconVideoWidget.html#BvwUseType" title="enum BvwUseType"><span class="type">BvwUseType</span></a> type</code></em>,
69
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
65
<a href="http://library.gnome.org/devel/gtk/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="BaconVideoWidget.html#bacon-video-widget-new" title="bacon_video_widget_new ()">bacon_video_widget_new</a>              (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
70
66
<span class="returnvalue">void</span>                <a class="link" href="BaconVideoWidget.html#bacon-video-widget-init-backend" title="bacon_video_widget_init_backend ()">bacon_video_widget_init_backend</a>     (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
71
67
                                                         <em class="parameter"><code><span class="type">char</span> ***argv</code></em>);
72
68
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="BaconVideoWidget.html#bacon-video-widget-open" title="bacon_video_widget_open ()">bacon_video_widget_open</a>             (<em class="parameter"><code><a class="link" href="BaconVideoWidget.html" title="BaconVideoWidget"><span class="type">BaconVideoWidget</span></a> *bvw</code></em>,
179
175
<span class="returnvalue">double</span>              <a class="link" href="BaconVideoWidget.html#bacon-video-widget-get-volume" title="bacon_video_widget_get_volume ()">bacon_video_widget_get_volume</a>       (<em class="parameter"><code><a class="link" href="BaconVideoWidget.html" title="BaconVideoWidget"><span class="type">BaconVideoWidget</span></a> *bvw</code></em>);
180
176
<span class="returnvalue">void</span>                <a class="link" href="BaconVideoWidget.html#bacon-video-widget-set-volume" title="bacon_video_widget_set_volume ()">bacon_video_widget_set_volume</a>       (<em class="parameter"><code><a class="link" href="BaconVideoWidget.html" title="BaconVideoWidget"><span class="type">BaconVideoWidget</span></a> *bvw</code></em>,
181
177
                                                         <em class="parameter"><code><span class="type">double</span> volume</code></em>);
182
 
<span class="returnvalue">double</span>              <a class="link" href="BaconVideoWidget.html#bacon-video-widget-get-zoom" title="bacon_video_widget_get_zoom ()">bacon_video_widget_get_zoom</a>         (<em class="parameter"><code><a class="link" href="BaconVideoWidget.html" title="BaconVideoWidget"><span class="type">BaconVideoWidget</span></a> *bvw</code></em>);
 
178
<span class="returnvalue">BvwZoomMode</span>         <a class="link" href="BaconVideoWidget.html#bacon-video-widget-get-zoom" title="bacon_video_widget_get_zoom ()">bacon_video_widget_get_zoom</a>         (<em class="parameter"><code><a class="link" href="BaconVideoWidget.html" title="BaconVideoWidget"><span class="type">BaconVideoWidget</span></a> *bvw</code></em>);
183
179
<span class="returnvalue">void</span>                <a class="link" href="BaconVideoWidget.html#bacon-video-widget-set-zoom" title="bacon_video_widget_set_zoom ()">bacon_video_widget_set_zoom</a>         (<em class="parameter"><code><a class="link" href="BaconVideoWidget.html" title="BaconVideoWidget"><span class="type">BaconVideoWidget</span></a> *bvw</code></em>,
184
 
                                                         <em class="parameter"><code><span class="type">double</span> zoom</code></em>);
 
180
                                                         <em class="parameter"><code><span class="type">BvwZoomMode</span> mode</code></em>);
185
181
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="BaconVideoWidget.html#bacon-video-widget-has-next-track" title="bacon_video_widget_has_next_track ()">bacon_video_widget_has_next_track</a>   (<em class="parameter"><code><a class="link" href="BaconVideoWidget.html" title="BaconVideoWidget"><span class="type">BaconVideoWidget</span></a> *bvw</code></em>);
186
182
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="BaconVideoWidget.html#bacon-video-widget-has-previous-track" title="bacon_video_widget_has_previous_track ()">bacon_video_widget_has_previous_track</a>
187
183
                                                        (<em class="parameter"><code><a class="link" href="BaconVideoWidget.html" title="BaconVideoWidget"><span class="type">BaconVideoWidget</span></a> *bvw</code></em>);
199
195
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
200
196
         +----<a href="http://library.gnome.org/devel/gtk/GtkWidget.html">GtkWidget</a>
201
197
               +----<a href="http://library.gnome.org/devel/gtk/GtkContainer.html">GtkContainer</a>
202
 
                     +----<a href="http://library.gnome.org/devel/gtk/GtkBin.html">GtkBin</a>
203
 
                           +----<a href="http://library.gnome.org/devel/gtk/GtkEventBox.html">GtkEventBox</a>
204
 
                                 +----BaconVideoWidget
 
198
                     +----GtkClutterEmbed
 
199
                           +----BaconVideoWidget
205
200
</pre>
206
201
</div>
207
202
<div class="refsect1">
474
469
        BVW_DVD_PREV_CHAPTER,
475
470
        BVW_DVD_NEXT_TITLE,
476
471
        BVW_DVD_PREV_TITLE,
477
 
        BVW_DVD_NEXT_ANGLE,
478
 
        BVW_DVD_PREV_ANGLE,
479
472
        BVW_DVD_ROOT_MENU_UP,
480
473
        BVW_DVD_ROOT_MENU_DOWN,
481
474
        BVW_DVD_ROOT_MENU_LEFT,
541
534
</td>
542
535
</tr>
543
536
<tr>
544
 
<td><p><a name="BVW-DVD-NEXT-ANGLE:CAPS"></a><span class="term"><code class="literal">BVW_DVD_NEXT_ANGLE</code></span></p></td>
545
 
<td>the next angle
546
 
</td>
547
 
</tr>
548
 
<tr>
549
 
<td><p><a name="BVW-DVD-PREV-ANGLE:CAPS"></a><span class="term"><code class="literal">BVW_DVD_PREV_ANGLE</code></span></p></td>
550
 
<td>the previous angle
551
 
</td>
552
 
</tr>
553
 
<tr>
554
537
<td><p><a name="BVW-DVD-ROOT-MENU-UP:CAPS"></a><span class="term"><code class="literal">BVW_DVD_ROOT_MENU_UP</code></span></p></td>
555
538
<td>go up in the menu
556
539
</td>
590
573
        BVW_INFO_DURATION,
591
574
        BVW_INFO_TRACK_NUMBER,
592
575
        BVW_INFO_COVER,
 
576
        BVW_INFO_CONTAINER,
593
577
        /* Video */
594
578
        BVW_INFO_HAS_VIDEO,
595
579
        BVW_INFO_DIMENSION_X,
653
637
</td>
654
638
</tr>
655
639
<tr>
 
640
<td><p><a name="BVW-INFO-CONTAINER:CAPS"></a><span class="term"><code class="literal">BVW_INFO_CONTAINER</code></span></p></td>
 
641
<td></td>
 
642
</tr>
 
643
<tr>
656
644
<td><p><a name="BVW-INFO-HAS-VIDEO:CAPS"></a><span class="term"><code class="literal">BVW_INFO_HAS_VIDEO</code></span></p></td>
657
645
<td>whether the stream has video
658
646
</td>
950
938
</div>
951
939
<hr>
952
940
<div class="refsect2">
953
 
<a name="BvwUseType"></a><h3>enum BvwUseType</h3>
954
 
<pre class="programlisting">typedef enum {
955
 
        BVW_USE_TYPE_VIDEO,
956
 
        BVW_USE_TYPE_AUDIO,
957
 
        BVW_USE_TYPE_CAPTURE,
958
 
        BVW_USE_TYPE_METADATA
959
 
} BvwUseType;
960
 
</pre>
961
 
<p>
962
 
The purpose for which a <a class="link" href="BaconVideoWidget.html" title="BaconVideoWidget"><span class="type">BaconVideoWidget</span></a> will be used, as specified to
963
 
<a class="link" href="BaconVideoWidget.html#bacon-video-widget-new" title="bacon_video_widget_new ()"><code class="function">bacon_video_widget_new()</code></a>. This determines which features will be enabled
964
 
in the created widget.
965
 
</p>
966
 
<div class="variablelist"><table border="0">
967
 
<col align="left" valign="top">
968
 
<tbody>
969
 
<tr>
970
 
<td><p><a name="BVW-USE-TYPE-VIDEO:CAPS"></a><span class="term"><code class="literal">BVW_USE_TYPE_VIDEO</code></span></p></td>
971
 
<td>fully-featured with video, audio, capture and metadata support
972
 
</td>
973
 
</tr>
974
 
<tr>
975
 
<td><p><a name="BVW-USE-TYPE-AUDIO:CAPS"></a><span class="term"><code class="literal">BVW_USE_TYPE_AUDIO</code></span></p></td>
976
 
<td>audio and metadata support
977
 
</td>
978
 
</tr>
979
 
<tr>
980
 
<td><p><a name="BVW-USE-TYPE-CAPTURE:CAPS"></a><span class="term"><code class="literal">BVW_USE_TYPE_CAPTURE</code></span></p></td>
981
 
<td>capture support only
982
 
</td>
983
 
</tr>
984
 
<tr>
985
 
<td><p><a name="BVW-USE-TYPE-METADATA:CAPS"></a><span class="term"><code class="literal">BVW_USE_TYPE_METADATA</code></span></p></td>
986
 
<td>metadata support only
987
 
</td>
988
 
</tr>
989
 
</tbody>
990
 
</table></div>
991
 
</div>
992
 
<hr>
993
 
<div class="refsect2">
994
941
<a name="bacon-video-widget-new"></a><h3>bacon_video_widget_new ()</h3>
995
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         bacon_video_widget_new              (<em class="parameter"><code><span class="type">int</span> width</code></em>,
996
 
                                                         <em class="parameter"><code><span class="type">int</span> height</code></em>,
997
 
                                                         <em class="parameter"><code><a class="link" href="BaconVideoWidget.html#BvwUseType" title="enum BvwUseType"><span class="type">BvwUseType</span></a> type</code></em>,
998
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
999
 
<p>
1000
 
Creates a new <a class="link" href="BaconVideoWidget.html" title="BaconVideoWidget"><span class="type">BaconVideoWidget</span></a> for the purpose specified in <em class="parameter"><code>type</code></em>.
1001
 
</p>
1002
 
<p>
1003
 
If <em class="parameter"><code>type</code></em> is <a class="link" href="BaconVideoWidget.html#BVW-USE-TYPE-VIDEO:CAPS"><code class="literal">BVW_USE_TYPE_VIDEO</code></a>, the <a class="link" href="BaconVideoWidget.html" title="BaconVideoWidget"><span class="type">BaconVideoWidget</span></a> will be fully-featured; other
1004
 
values of <em class="parameter"><code>type</code></em> will enable less functionality on the widget, which will come with
1005
 
corresponding decreases in the size of its memory footprint.
 
942
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         bacon_video_widget_new              (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
943
<p>
 
944
Creates a new <a class="link" href="BaconVideoWidget.html" title="BaconVideoWidget"><span class="type">BaconVideoWidget</span></a>.
1006
945
</p>
1007
946
<p>
1008
947
<em class="parameter"><code>width</code></em> and <em class="parameter"><code>height</code></em> give the initial or expected video height. Set them to <code class="literal">-1</code> if the
1015
954
<col align="left" valign="top">
1016
955
<tbody>
1017
956
<tr>
1018
 
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
1019
 
<td>initial or expected video width, in pixels, or <code class="literal">-1</code>
1020
 
</td>
1021
 
</tr>
1022
 
<tr>
1023
 
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
1024
 
<td>initial or expected video height, in pixels, or <code class="literal">-1</code>
1025
 
</td>
1026
 
</tr>
1027
 
<tr>
1028
 
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
1029
 
<td>the widget's use type</td>
1030
 
</tr>
1031
 
<tr>
1032
957
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
1033
958
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
1034
959
</td>
1046
971
<a name="bacon-video-widget-init-backend"></a><h3>bacon_video_widget_init_backend ()</h3>
1047
972
<pre class="programlisting"><span class="returnvalue">void</span>                bacon_video_widget_init_backend     (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
1048
973
                                                         <em class="parameter"><code><span class="type">char</span> ***argv</code></em>);</pre>
1049
 
<p>
1050
 
Initialises <a class="link" href="BaconVideoWidget.html" title="BaconVideoWidget"><span class="type">BaconVideoWidget</span></a>'s GStreamer backend. If this fails
1051
 
for the GStreamer backend, your application will be terminated.
1052
 
</p>
1053
 
<p>
1054
 
Applications must call either this or <a class="link" href="BaconVideoWidget.html#bacon-video-widget-get-option-group" title="bacon_video_widget_get_option_group ()"><code class="function">bacon_video_widget_get_option_group()</code></a> exactly
1055
 
once; but not both.
1056
 
</p>
1057
 
<div class="variablelist"><table border="0">
1058
 
<col align="left" valign="top">
1059
 
<tbody>
1060
 
<tr>
1061
 
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
1062
 
<td>pointer to application's argc</td>
1063
 
</tr>
1064
 
<tr>
1065
 
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
1066
 
<td>pointer to application's argv</td>
1067
 
</tr>
1068
 
</tbody>
1069
 
</table></div>
1070
974
</div>
1071
975
<hr>
1072
976
<div class="refsect2">
1406
1310
<tr>
1407
1311
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1408
1312
<td>
1409
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if a menu is displyed, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
 
1313
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if a menu is displayed, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
1410
1314
</tr>
1411
1315
</tbody>
1412
1316
</table></div>
1738
1642
<p>
1739
1643
Sets whether the widget renders the stream in fullscreen mode.
1740
1644
</p>
1741
 
<p>
1742
 
Fullscreen rendering is done only when possible, as xvidmode is required.
1743
 
</p>
1744
1645
<div class="variablelist"><table border="0">
1745
1646
<col align="left" valign="top">
1746
1647
<tbody>
2527
2428
<hr>
2528
2429
<div class="refsect2">
2529
2430
<a name="bacon-video-widget-get-zoom"></a><h3>bacon_video_widget_get_zoom ()</h3>
2530
 
<pre class="programlisting"><span class="returnvalue">double</span>              bacon_video_widget_get_zoom         (<em class="parameter"><code><a class="link" href="BaconVideoWidget.html" title="BaconVideoWidget"><span class="type">BaconVideoWidget</span></a> *bvw</code></em>);</pre>
 
2431
<pre class="programlisting"><span class="returnvalue">BvwZoomMode</span>         bacon_video_widget_get_zoom         (<em class="parameter"><code><a class="link" href="BaconVideoWidget.html" title="BaconVideoWidget"><span class="type">BaconVideoWidget</span></a> *bvw</code></em>);</pre>
2531
2432
<p>
2532
 
Returns the zoom factor applied to videos displayed by the widget,
2533
 
as an integeric percentage between <code class="literal">0</code> and <code class="literal">1</code>
2534
 
(e.g. <code class="literal">1</code> means no zooming at all).
 
2433
Returns the zoom mode applied to videos displayed by the widget.
2535
2434
</p>
2536
2435
<div class="variablelist"><table border="0">
2537
2436
<col align="left" valign="top">
2543
2442
</tr>
2544
2443
<tr>
2545
2444
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2546
 
<td>the zoom factor</td>
 
2445
<td>a <span class="type">BvwZoomMode</span>
 
2446
</td>
2547
2447
</tr>
2548
2448
</tbody>
2549
2449
</table></div>
2552
2452
<div class="refsect2">
2553
2453
<a name="bacon-video-widget-set-zoom"></a><h3>bacon_video_widget_set_zoom ()</h3>
2554
2454
<pre class="programlisting"><span class="returnvalue">void</span>                bacon_video_widget_set_zoom         (<em class="parameter"><code><a class="link" href="BaconVideoWidget.html" title="BaconVideoWidget"><span class="type">BaconVideoWidget</span></a> *bvw</code></em>,
2555
 
                                                         <em class="parameter"><code><span class="type">double</span> zoom</code></em>);</pre>
 
2455
                                                         <em class="parameter"><code><span class="type">BvwZoomMode</span> mode</code></em>);</pre>
2556
2456
<p>
2557
 
Sets the zoom factor applied to the video when it is displayed,
2558
 
as an integeric percentage between <code class="literal">0</code> and <code class="literal">1</code>
2559
 
(e.g. set <em class="parameter"><code>zoom</code></em> to <code class="literal">1</code> to not zoom at all).
 
2457
Sets the zoom type applied to the video when it is displayed.
2560
2458
</p>
2561
2459
<div class="variablelist"><table border="0">
2562
2460
<col align="left" valign="top">
2567
2465
</td>
2568
2466
</tr>
2569
2467
<tr>
2570
 
<td><p><span class="term"><em class="parameter"><code>zoom</code></em> :</span></p></td>
2571
 
<td>a percentage zoom factor</td>
 
2468
<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
 
2469
<td>the <span class="type">BvwZoomMode</span>
 
2470
</td>
2572
2471
</tr>
2573
2472
</tbody>
2574
2473
</table></div>