← Back to branch summary

~kaozilon/totem/test

« back to all changes in this revision

Viewing changes to docs/reference/xml/bacon-video-widget.xml

  • Committer: Bazaar Package Importer
  • Author(s): Raphaël Hertzog, Josselin Mouette, Emilio Pozuelo Monfort, Sjoerd Simons, Frederic Peters, Michael Biebl, Raphaël Hertzog
  • Date: 2011-04-10 18:12:25 UTC
  • mfrom: (1.4.6 upstream) (5.1.19 sid)
  • Revision ID: james.westby@ubuntu.com-20110410181225-srhkesant1gx38pw
Tags: 3.0.0-1
http://bugs.debian.org/599638
http://bugs.debian.org/607436
http://bugs.debian.org/615214
* Team upload to experimental.

[ Josselin Mouette ]
* Only suggest totem-mozilla. Closes: #599638.
* totem-coherence depends on totem-plugins. Closes: #607436.

[ Emilio Pozuelo Monfort ]
* New upstream development release.
  - debian/patches/80_webm.patch,
    debian/patches/81_mpegts.patch,
    debian/patches/82_youtube_api.patch:
    + Removed, applied upstream.
  - debian/patches/90_autotools.patch:
    + Removed, no longer needed.
  - debian/patches/70_bbc_plugin.patch:
    + Disabled, needs porting.
  - debian/control.in:
    + Updated build dependencies and dependencies.
    + Removed transitional totem-xine and totem-gstreamer packages.
    + Don't build totem-coherence for now, it hasn't been ported
      to PyGI and so it's that plugin or all the others.
  - debian/totem-common.install:
    + Don't install the gconf schemas, they're gone. Install the
      gsettings files instead.
  - debian/totem.install:
    + Ship libtotem here.
  - debian/control.in,
    debian/rules,
    debian/gir1.2-totem-1.0.install:
    + Add a gir package and update the plugins package dependencies
      for the new gir dependencies.
* debian/rules,
  debian/control.in,
  debian/source/format:
  - Switch to source format 3.0 (quilt).
* debian/control.in:
  - Remove obsolete build dependency on libhal-dev. Closes: #615214.

[ Sjoerd Simons ]
* New upstream release (2.91.7)
* debian/totem-plugins.install:
  * Don't install the grommit plugin
  * Install the chapters plugin

[ Frederic Peters ]
* New upstream release (2.91.91)
* debian/control.in: bump build-dep on libpeas.
* debian/control.in, debian/totem-plugins.install:
  * The galago plugin has been renamed to im-status, and no longer uses
    libgalago.

[ Michael Biebl ]
* debian/control.in:
  - Add Build-Depends on libtracker-sparql-0.10-dev for media search support
    using Tracker.

[ Raphaël Hertzog ]
* New upstream release (3.0.0).
* Added Build-Depends on gstreamer0.10-gconf.
* Bumped minimal version of build-dependency on totem-plparser-dev to
  2.32.4-2 to match the ./configure requirements and to ensure libquvi-dev
  is there as required by the totem-plparser.pc.
* Add some copyright notices to debian/copyright to please lintian.
* Call dh_pysupport on totem to generate the python dependency for
  totem-bugreport.py
* Tell dh_makeshlibs to skip /usr/lib/nautilus. This avoids generating
  an shlib entry for the plugin it contains.
* Tweaked the totem description to fix lintian warning description-
  synopsis-starts-with-article.
* Updated dependencies of totem-coherence to match the new code using
  introspection but keep the package disabled as python-coherence is
  still PyGTK based and thus incompatible.
* Add lintian overrides for menu-icon-missing (icon is in totem-
  common).
* Add gnome-icon-theme-symbolic to totem's dependencies.
* Bump build-dep on libgdata >= 0.8.0.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/xml/bacon-video-widget.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
3
 
        <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
4
 
        <!ENTITY version SYSTEM "version.xml">
5
 
        <!ENTITY slash "/">
6
 
]>
7
 
<refentry id="BaconVideoWidget">
8
 
<refmeta>
9
 
<refentrytitle role="top_of_page" id="BaconVideoWidget.top_of_page">BaconVideoWidget</refentrytitle>
10
 
<manvolnum>3</manvolnum>
11
 
<refmiscinfo>TOTEM Library</refmiscinfo>
12
 
</refmeta>
13
 
 
14
 
<refnamediv>
15
 
<refname>BaconVideoWidget</refname>
16
 
<refpurpose>video playing widget and abstraction</refpurpose>
17
 
</refnamediv>
18
 
<refsect1 id="BaconVideoWidget.stability-level">
19
 
<title>Stability Level</title>
20
 
Unstable, unless otherwise indicated
21
 
</refsect1>
22
 
 
23
 
<refsynopsisdiv id="BaconVideoWidget.synopsis" role="synopsis">
24
 
<title role="synopsis.title">Synopsis</title>
25
 
 
26
 
<synopsis>
27
 
 
28
 
#include &lt;bacon-video-widget.h&gt;
29
 
 
30
 
                    <link linkend="BaconVideoWidget-struct">BaconVideoWidget</link>;
31
 
                    <link linkend="BaconVideoWidgetClass">BaconVideoWidgetClass</link>;
32
 
enum                <link linkend="BvwAspectRatio">BvwAspectRatio</link>;
33
 
enum                <link linkend="BvwAudioOutType">BvwAudioOutType</link>;
34
 
enum                <link linkend="BvwDVDEvent">BvwDVDEvent</link>;
35
 
enum                <link linkend="BvwMetadataType">BvwMetadataType</link>;
36
 
enum                <link linkend="BvwVisualsQuality">BvwVisualsQuality</link>;
37
 
enum                <link linkend="BvwVideoProperty">BvwVideoProperty</link>;
38
 
enum                <link linkend="BvwError">BvwError</link>;
39
 
enum                <link linkend="BvwUseType">BvwUseType</link>;
40
 
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="bacon-video-widget-new">bacon_video_widget_new</link>              (<link linkend="int">int</link> width,
41
 
                                                         <link linkend="int">int</link> height,
42
 
                                                         <link linkend="BvwUseType">BvwUseType</link> type,
43
 
                                                         <link linkend="GError">GError</link> **error);
44
 
<link linkend="void">void</link>                <link linkend="bacon-video-widget-init-backend">bacon_video_widget_init_backend</link>     (<link linkend="int">int</link> *argc,
45
 
                                                         <link linkend="char">char</link> ***argv);
46
 
<link linkend="gboolean">gboolean</link>            <link linkend="bacon-video-widget-open">bacon_video_widget_open</link>             (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
47
 
                                                         const <link linkend="char">char</link> *mrl,
48
 
                                                         const <link linkend="char">char</link> *subtitle_uri,
49
 
                                                         <link linkend="GError">GError</link> **error);
50
 
<link linkend="gboolean">gboolean</link>            <link linkend="bacon-video-widget-play">bacon_video_widget_play</link>             (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
51
 
                                                         <link linkend="GError">GError</link> **error);
52
 
<link linkend="void">void</link>                <link linkend="bacon-video-widget-pause">bacon_video_widget_pause</link>            (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
53
 
<link linkend="gboolean">gboolean</link>            <link linkend="bacon-video-widget-seek">bacon_video_widget_seek</link>             (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
54
 
                                                         <link linkend="double">double</link> position,
55
 
                                                         <link linkend="GError">GError</link> **error);
56
 
<link linkend="gboolean">gboolean</link>            <link linkend="bacon-video-widget-seek-time">bacon_video_widget_seek_time</link>        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
57
 
                                                         <link linkend="gint64">gint64</link> _time,
58
 
                                                         <link linkend="GError">GError</link> **error);
59
 
<link linkend="void">void</link>                <link linkend="bacon-video-widget-stop">bacon_video_widget_stop</link>             (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
60
 
<link linkend="void">void</link>                <link linkend="bacon-video-widget-close">bacon_video_widget_close</link>            (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
61
 
<link linkend="gboolean">gboolean</link>            <link linkend="bacon-video-widget-can-deinterlace">bacon_video_widget_can_deinterlace</link>  (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
62
 
<link linkend="gboolean">gboolean</link>            <link linkend="bacon-video-widget-can-direct-seek">bacon_video_widget_can_direct_seek</link>  (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
63
 
<link linkend="gboolean">gboolean</link>            <link linkend="bacon-video-widget-can-get-frames">bacon_video_widget_can_get_frames</link>   (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
64
 
                                                         <link linkend="GError">GError</link> **error);
65
 
<link linkend="gboolean">gboolean</link>            <link linkend="bacon-video-widget-can-set-volume">bacon_video_widget_can_set_volume</link>   (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
66
 
<link linkend="void">void</link>                <link linkend="bacon-video-widget-dvd-event">bacon_video_widget_dvd_event</link>        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
67
 
                                                         <link linkend="BvwDVDEvent">BvwDVDEvent</link> type);
68
 
<link linkend="gboolean">gboolean</link>            <link linkend="bacon-video-widget-has-menus">bacon_video_widget_has_menus</link>        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
69
 
<link linkend="BvwAspectRatio">BvwAspectRatio</link>      <link linkend="bacon-video-widget-get-aspect-ratio">bacon_video_widget_get_aspect_ratio</link> (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
70
 
<link linkend="void">void</link>                <link linkend="bacon-video-widget-set-aspect-ratio">bacon_video_widget_set_aspect_ratio</link> (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
71
 
                                                         <link linkend="BvwAspectRatio">BvwAspectRatio</link> ratio);
72
 
<link linkend="BvwAudioOutType">BvwAudioOutType</link>     <link linkend="bacon-video-widget-get-audio-out-type">bacon_video_widget_get_audio_out_type</link>
73
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
74
 
<link linkend="gboolean">gboolean</link>            <link linkend="bacon-video-widget-set-audio-out-type">bacon_video_widget_set_audio_out_type</link>
75
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
76
 
                                                         <link linkend="BvwAudioOutType">BvwAudioOutType</link> type);
77
 
<link linkend="gboolean">gboolean</link>            <link linkend="bacon-video-widget-get-auto-resize">bacon_video_widget_get_auto_resize</link>  (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
78
 
<link linkend="void">void</link>                <link linkend="bacon-video-widget-set-auto-resize">bacon_video_widget_set_auto_resize</link>  (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
79
 
                                                         <link linkend="gboolean">gboolean</link> auto_resize);
80
 
<link linkend="char">char</link> *              <link linkend="bacon-video-widget-get-backend-name">bacon_video_widget_get_backend_name</link> (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
81
 
<link linkend="int">int</link>                 <link linkend="bacon-video-widget-get-connection-speed">bacon_video_widget_get_connection_speed</link>
82
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
83
 
<link linkend="void">void</link>                <link linkend="bacon-video-widget-set-connection-speed">bacon_video_widget_set_connection_speed</link>
84
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
85
 
                                                         <link linkend="int">int</link> speed);
86
 
<link linkend="GdkPixbuf">GdkPixbuf</link> *         <link linkend="bacon-video-widget-get-current-frame">bacon_video_widget_get_current_frame</link>
87
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
88
 
<link linkend="gint64">gint64</link>              <link linkend="bacon-video-widget-get-current-time">bacon_video_widget_get_current_time</link> (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
89
 
<link linkend="gboolean">gboolean</link>            <link linkend="bacon-video-widget-get-deinterlacing">bacon_video_widget_get_deinterlacing</link>
90
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
91
 
<link linkend="void">void</link>                <link linkend="bacon-video-widget-set-deinterlacing">bacon_video_widget_set_deinterlacing</link>
92
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
93
 
                                                         <link linkend="gboolean">gboolean</link> deinterlace);
94
 
<link linkend="void">void</link>                <link linkend="bacon-video-widget-set-fullscreen">bacon_video_widget_set_fullscreen</link>   (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
95
 
                                                         <link linkend="gboolean">gboolean</link> fullscreen);
96
 
<link linkend="GList">GList</link> *             <link linkend="bacon-video-widget-get-languages">bacon_video_widget_get_languages</link>    (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
97
 
<link linkend="int">int</link>                 <link linkend="bacon-video-widget-get-language">bacon_video_widget_get_language</link>     (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
98
 
<link linkend="void">void</link>                <link linkend="bacon-video-widget-set-language">bacon_video_widget_set_language</link>     (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
99
 
                                                         <link linkend="int">int</link> language);
100
 
<link linkend="void">void</link>                <link linkend="bacon-video-widget-set-logo">bacon_video_widget_set_logo</link>         (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
101
 
                                                         const <link linkend="char">char</link> *name);
102
 
<link linkend="gboolean">gboolean</link>            <link linkend="bacon-video-widget-get-logo-mode">bacon_video_widget_get_logo_mode</link>    (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
103
 
<link linkend="void">void</link>                <link linkend="bacon-video-widget-set-logo-mode">bacon_video_widget_set_logo_mode</link>    (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
104
 
                                                         <link linkend="gboolean">gboolean</link> logo_mode);
105
 
<link linkend="void">void</link>                <link linkend="bacon-video-widget-get-metadata">bacon_video_widget_get_metadata</link>     (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
106
 
                                                         <link linkend="BvwMetadataType">BvwMetadataType</link> type,
107
 
                                                         <link linkend="GValue">GValue</link> *value);
108
 
<link linkend="gchar">gchar</link> **            <link linkend="bacon-video-widget-get-mrls">bacon_video_widget_get_mrls</link>         (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
109
 
                                                         <link linkend="TotemDiscMediaType">TotemDiscMediaType</link> type,
110
 
                                                         const <link linkend="char">char</link> *device,
111
 
                                                         <link linkend="GError">GError</link> **error);
112
 
<link linkend="GOptionGroup">GOptionGroup</link>*       <link linkend="bacon-video-widget-get-option-group">bacon_video_widget_get_option_group</link> (void);
113
 
<link linkend="double">double</link>              <link linkend="bacon-video-widget-get-position">bacon_video_widget_get_position</link>     (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
114
 
<link linkend="void">void</link>                <link linkend="bacon-video-widget-set-referrer">bacon_video_widget_set_referrer</link>     (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
115
 
                                                         const <link linkend="char">char</link> *referrer);
116
 
<link linkend="void">void</link>                <link linkend="bacon-video-widget-set-scale-ratio">bacon_video_widget_set_scale_ratio</link>  (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
117
 
                                                         <link linkend="float">float</link> ratio);
118
 
<link linkend="gboolean">gboolean</link>            <link linkend="bacon-video-widget-get-show-cursor">bacon_video_widget_get_show_cursor</link>  (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
119
 
<link linkend="void">void</link>                <link linkend="bacon-video-widget-set-show-cursor">bacon_video_widget_set_show_cursor</link>  (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
120
 
                                                         <link linkend="gboolean">gboolean</link> show_cursor);
121
 
<link linkend="void">void</link>                <link linkend="bacon-video-widget-set-show-visuals">bacon_video_widget_set_show_visuals</link> (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
122
 
                                                         <link linkend="gboolean">gboolean</link> show_visuals);
123
 
<link linkend="gint64">gint64</link>              <link linkend="bacon-video-widget-get-stream-length">bacon_video_widget_get_stream_length</link>
124
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
125
 
<link linkend="GList">GList</link> *             <link linkend="bacon-video-widget-get-subtitles">bacon_video_widget_get_subtitles</link>    (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
126
 
<link linkend="int">int</link>                 <link linkend="bacon-video-widget-get-subtitle">bacon_video_widget_get_subtitle</link>     (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
127
 
<link linkend="void">void</link>                <link linkend="bacon-video-widget-set-subtitle">bacon_video_widget_set_subtitle</link>     (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
128
 
                                                         <link linkend="int">int</link> subtitle);
129
 
<link linkend="void">void</link>                <link linkend="bacon-video-widget-set-subtitle-encoding">bacon_video_widget_set_subtitle_encoding</link>
130
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
131
 
                                                         const <link linkend="char">char</link> *encoding);
132
 
<link linkend="void">void</link>                <link linkend="bacon-video-widget-set-subtitle-font">bacon_video_widget_set_subtitle_font</link>
133
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
134
 
                                                         const <link linkend="char">char</link> *font);
135
 
<link linkend="void">void</link>                <link linkend="bacon-video-widget-set-user-agent">bacon_video_widget_set_user_agent</link>   (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
136
 
                                                         const <link linkend="char">char</link> *user_agent);
137
 
<link linkend="int">int</link>                 <link linkend="bacon-video-widget-get-video-property">bacon_video_widget_get_video_property</link>
138
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
139
 
                                                         <link linkend="BvwVideoProperty">BvwVideoProperty</link> type);
140
 
<link linkend="void">void</link>                <link linkend="bacon-video-widget-set-video-property">bacon_video_widget_set_video_property</link>
141
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
142
 
                                                         <link linkend="BvwVideoProperty">BvwVideoProperty</link> type,
143
 
                                                         <link linkend="int">int</link> value);
144
 
<link linkend="GList">GList</link> *             <link linkend="bacon-video-widget-get-visuals-list">bacon_video_widget_get_visuals_list</link> (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
145
 
<link linkend="gboolean">gboolean</link>            <link linkend="bacon-video-widget-set-visuals">bacon_video_widget_set_visuals</link>      (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
146
 
                                                         const <link linkend="char">char</link> *name);
147
 
<link linkend="void">void</link>                <link linkend="bacon-video-widget-set-visuals-quality">bacon_video_widget_set_visuals_quality</link>
148
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
149
 
                                                         <link linkend="BvwVisualsQuality">BvwVisualsQuality</link> quality);
150
 
<link linkend="double">double</link>              <link linkend="bacon-video-widget-get-volume">bacon_video_widget_get_volume</link>       (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
151
 
<link linkend="void">void</link>                <link linkend="bacon-video-widget-set-volume">bacon_video_widget_set_volume</link>       (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
152
 
                                                         <link linkend="double">double</link> volume);
153
 
<link linkend="double">double</link>              <link linkend="bacon-video-widget-get-zoom">bacon_video_widget_get_zoom</link>         (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
154
 
<link linkend="void">void</link>                <link linkend="bacon-video-widget-set-zoom">bacon_video_widget_set_zoom</link>         (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
155
 
                                                         <link linkend="double">double</link> zoom);
156
 
<link linkend="gboolean">gboolean</link>            <link linkend="bacon-video-widget-has-next-track">bacon_video_widget_has_next_track</link>   (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
157
 
<link linkend="gboolean">gboolean</link>            <link linkend="bacon-video-widget-has-previous-track">bacon_video_widget_has_previous_track</link>
158
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
159
 
<link linkend="gboolean">gboolean</link>            <link linkend="bacon-video-widget-is-playing">bacon_video_widget_is_playing</link>       (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
160
 
<link linkend="gboolean">gboolean</link>            <link linkend="bacon-video-widget-is-seekable">bacon_video_widget_is_seekable</link>      (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);
161
 
<link linkend="gboolean">gboolean</link>            <link linkend="bacon-video-widget-step">bacon_video_widget_step</link>             (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
162
 
                                                         <link linkend="gboolean">gboolean</link> forward,
163
 
                                                         <link linkend="GError">GError</link> **error);
164
 
</synopsis>
165
 
</refsynopsisdiv>
166
 
 
167
 
<refsect1 id="BaconVideoWidget.object-hierarchy" role="object_hierarchy">
168
 
<title role="object_hierarchy.title">Object Hierarchy</title>
169
 
<synopsis>
170
 
  <link linkend="GObject">GObject</link>
171
 
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
172
 
         +----<link linkend="GtkObject">GtkObject</link>
173
 
               +----<link linkend="GtkWidget">GtkWidget</link>
174
 
                     +----<link linkend="GtkContainer">GtkContainer</link>
175
 
                           +----<link linkend="GtkBin">GtkBin</link>
176
 
                                 +----<link linkend="GtkEventBox">GtkEventBox</link>
177
 
                                       +----BaconVideoWidget
178
 
</synopsis>
179
 
</refsect1>
180
 
 
181
 
 
182
 
 
183
 
<refsect1 id="BaconVideoWidget.implemented-interfaces" role="impl_interfaces">
184
 
<title role="impl_interfaces.title">Implemented Interfaces</title>
185
 
<para>
186
 
BaconVideoWidget implements
187
 
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
188
 
</refsect1>
189
 
 
190
 
 
191
 
<refsect1 id="BaconVideoWidget.properties" role="properties">
192
 
<title role="properties.title">Properties</title>
193
 
<synopsis>
194
 
  &quot;<link linkend="BaconVideoWidget--download-filename">download-filename</link>&quot;        <link linkend="gchar">gchar</link>*                : Read / Write
195
 
  &quot;<link linkend="BaconVideoWidget--logo-mode">logo-mode</link>&quot;                <link linkend="gboolean">gboolean</link>              : Read / Write
196
 
  &quot;<link linkend="BaconVideoWidget--playing">playing</link>&quot;                  <link linkend="gboolean">gboolean</link>              : Read
197
 
  &quot;<link linkend="BaconVideoWidget--position">position</link>&quot;                 <link linkend="gdouble">gdouble</link>               : Read
198
 
  &quot;<link linkend="BaconVideoWidget--referrer">referrer</link>&quot;                 <link linkend="gchar">gchar</link>*                : Read / Write
199
 
  &quot;<link linkend="BaconVideoWidget--seekable">seekable</link>&quot;                 <link linkend="gboolean">gboolean</link>              : Read
200
 
  &quot;<link linkend="BaconVideoWidget--show-cursor">show-cursor</link>&quot;              <link linkend="gboolean">gboolean</link>              : Read / Write
201
 
  &quot;<link linkend="BaconVideoWidget--show-visuals">show-visuals</link>&quot;             <link linkend="gboolean">gboolean</link>              : Write
202
 
  &quot;<link linkend="BaconVideoWidget--stream-length">stream-length</link>&quot;            <link linkend="gint64">gint64</link>                : Read
203
 
  &quot;<link linkend="BaconVideoWidget--user-agent">user-agent</link>&quot;               <link linkend="gchar">gchar</link>*                : Read / Write
204
 
  &quot;<link linkend="BaconVideoWidget--volume">volume</link>&quot;                   <link linkend="gdouble">gdouble</link>               : Read / Write
205
 
</synopsis>
206
 
</refsect1>
207
 
 
208
 
<refsect1 id="BaconVideoWidget.signals" role="signal_proto">
209
 
<title role="signal_proto.title">Signals</title>
210
 
<synopsis>
211
 
  &quot;<link linkend="BaconVideoWidget-buffering">buffering</link>&quot;                                      : Run Last
212
 
  &quot;<link linkend="BaconVideoWidget-channels-change">channels-change</link>&quot;                                : Run Last
213
 
  &quot;<link linkend="BaconVideoWidget-download-buffering">download-buffering</link>&quot;                             : Run Last
214
 
  &quot;<link linkend="BaconVideoWidget-eos">eos</link>&quot;                                            : Run Last
215
 
  &quot;<link linkend="BaconVideoWidget-error">error</link>&quot;                                          : Run Last
216
 
  &quot;<link linkend="BaconVideoWidget-got-metadata">got-metadata</link>&quot;                                   : Run Last
217
 
  &quot;<link linkend="BaconVideoWidget-got-redirect">got-redirect</link>&quot;                                   : Run Last
218
 
  &quot;<link linkend="BaconVideoWidget-missing-plugins">missing-plugins</link>&quot;                                : Run Last
219
 
  &quot;<link linkend="BaconVideoWidget-tick">tick</link>&quot;                                           : Run Last
220
 
</synopsis>
221
 
</refsect1>
222
 
 
223
 
 
224
 
<refsect1 id="BaconVideoWidget.description" role="desc">
225
 
<title role="desc.title">Description</title>
226
 
<para>
227
 
<link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link> is a widget to play audio or video streams, with support for visualisations for audio-only streams. It has a GStreamer
228
 
backend, and abstracts away the differences to provide a simple interface to the functionality required by Totem. It handles all the low-level
229
 
audio and video work for Totem (or passes the work off to the backend).</para>
230
 
<para>
231
 
</para>
232
 
</refsect1>
233
 
 
234
 
<refsect1 id="BaconVideoWidget.details" role="details">
235
 
<title role="details.title">Details</title>
236
 
<refsect2 id="BaconVideoWidget-struct" role="struct">
237
 
<title>BaconVideoWidget</title>
238
 
<indexterm zone="BaconVideoWidget-struct"><primary>BaconVideoWidget</primary></indexterm><programlisting>typedef struct _BaconVideoWidget BaconVideoWidget;</programlisting>
239
 
<para>
240
 
All the fields in the <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link> structure are private and should never be accessed directly.</para>
241
 
<para>
242
 
</para></refsect2>
243
 
<refsect2 id="BaconVideoWidgetClass" role="struct">
244
 
<title>BaconVideoWidgetClass</title>
245
 
<indexterm zone="BaconVideoWidgetClass"><primary>BaconVideoWidgetClass</primary></indexterm><programlisting>typedef struct {
246
 
} BaconVideoWidgetClass;
247
 
</programlisting>
248
 
<para>
249
 
All the fields in the <link linkend="BaconVideoWidgetClass"><type>BaconVideoWidgetClass</type></link> structure are private and should never be accessed directly.</para>
250
 
<para>
251
 
</para></refsect2>
252
 
<refsect2 id="BvwAspectRatio" role="enum">
253
 
<title>enum BvwAspectRatio</title>
254
 
<indexterm zone="BvwAspectRatio"><primary>BvwAspectRatio</primary></indexterm><programlisting>typedef enum {
255
 
        BVW_RATIO_AUTO = 0,
256
 
        BVW_RATIO_SQUARE = 1,
257
 
        BVW_RATIO_FOURBYTHREE = 2,
258
 
        BVW_RATIO_ANAMORPHIC = 3,
259
 
        BVW_RATIO_DVB = 4
260
 
} BvwAspectRatio;
261
 
</programlisting>
262
 
<para>
263
 
The pixel aspect ratios available in which to display videos using
264
 
@<link linkend="bacon-video-widget-set-aspect-ratio"><function>bacon_video_widget_set_aspect_ratio()</function></link>.</para>
265
 
<para>
266
 
</para><variablelist role="enum">
267
 
<varlistentry id="BVW-RATIO-AUTO--CAPS" role="constant">
268
 
<term><literal>BVW_RATIO_AUTO</literal></term>
269
 
<listitem><simpara> automatic
270
 
</simpara></listitem>
271
 
</varlistentry>
272
 
<varlistentry id="BVW-RATIO-SQUARE--CAPS" role="constant">
273
 
<term><literal>BVW_RATIO_SQUARE</literal></term>
274
 
<listitem><simpara> square (1:1)
275
 
</simpara></listitem>
276
 
</varlistentry>
277
 
<varlistentry id="BVW-RATIO-FOURBYTHREE--CAPS" role="constant">
278
 
<term><literal>BVW_RATIO_FOURBYTHREE</literal></term>
279
 
<listitem><simpara> four-by-three (4:3)
280
 
</simpara></listitem>
281
 
</varlistentry>
282
 
<varlistentry id="BVW-RATIO-ANAMORPHIC--CAPS" role="constant">
283
 
<term><literal>BVW_RATIO_ANAMORPHIC</literal></term>
284
 
<listitem><simpara> anamorphic (16:9)
285
 
</simpara></listitem>
286
 
</varlistentry>
287
 
<varlistentry id="BVW-RATIO-DVB--CAPS" role="constant">
288
 
<term><literal>BVW_RATIO_DVB</literal></term>
289
 
<listitem><simpara> DVB (20:9)
290
 
</simpara></listitem>
291
 
</varlistentry>
292
 
</variablelist></refsect2>
293
 
<refsect2 id="BvwAudioOutType" role="enum">
294
 
<title>enum BvwAudioOutType</title>
295
 
<indexterm zone="BvwAudioOutType"><primary>BvwAudioOutType</primary></indexterm><programlisting>typedef enum {
296
 
        BVW_AUDIO_SOUND_STEREO,
297
 
        BVW_AUDIO_SOUND_4CHANNEL,
298
 
        BVW_AUDIO_SOUND_41CHANNEL,
299
 
        BVW_AUDIO_SOUND_5CHANNEL,
300
 
        BVW_AUDIO_SOUND_51CHANNEL,
301
 
        BVW_AUDIO_SOUND_AC3PASSTHRU
302
 
} BvwAudioOutType;
303
 
</programlisting>
304
 
<para>
305
 
The audio output types available for use with <link linkend="bacon-video-widget-set-audio-out-type"><function>bacon_video_widget_set_audio_out_type()</function></link>.</para>
306
 
<para>
307
 
</para><variablelist role="enum">
308
 
<varlistentry id="BVW-AUDIO-SOUND-STEREO--CAPS" role="constant">
309
 
<term><literal>BVW_AUDIO_SOUND_STEREO</literal></term>
310
 
<listitem><simpara> stereo output
311
 
</simpara></listitem>
312
 
</varlistentry>
313
 
<varlistentry id="BVW-AUDIO-SOUND-4CHANNEL--CAPS" role="constant">
314
 
<term><literal>BVW_AUDIO_SOUND_4CHANNEL</literal></term>
315
 
<listitem><simpara> 4-channel output
316
 
</simpara></listitem>
317
 
</varlistentry>
318
 
<varlistentry id="BVW-AUDIO-SOUND-41CHANNEL--CAPS" role="constant">
319
 
<term><literal>BVW_AUDIO_SOUND_41CHANNEL</literal></term>
320
 
<listitem><simpara> 4.1-channel output
321
 
</simpara></listitem>
322
 
</varlistentry>
323
 
<varlistentry id="BVW-AUDIO-SOUND-5CHANNEL--CAPS" role="constant">
324
 
<term><literal>BVW_AUDIO_SOUND_5CHANNEL</literal></term>
325
 
<listitem><simpara> 5-channel output
326
 
</simpara></listitem>
327
 
</varlistentry>
328
 
<varlistentry id="BVW-AUDIO-SOUND-51CHANNEL--CAPS" role="constant">
329
 
<term><literal>BVW_AUDIO_SOUND_51CHANNEL</literal></term>
330
 
<listitem><simpara> 5.1-channel output
331
 
</simpara></listitem>
332
 
</varlistentry>
333
 
<varlistentry id="BVW-AUDIO-SOUND-AC3PASSTHRU--CAPS" role="constant">
334
 
<term><literal>BVW_AUDIO_SOUND_AC3PASSTHRU</literal></term>
335
 
<listitem><simpara> AC3 passthrough output
336
 
</simpara></listitem>
337
 
</varlistentry>
338
 
</variablelist></refsect2>
339
 
<refsect2 id="BvwDVDEvent" role="enum">
340
 
<title>enum BvwDVDEvent</title>
341
 
<indexterm zone="BvwDVDEvent"><primary>BvwDVDEvent</primary></indexterm><programlisting>typedef enum {
342
 
        BVW_DVD_ROOT_MENU,
343
 
        BVW_DVD_TITLE_MENU,
344
 
        BVW_DVD_SUBPICTURE_MENU,
345
 
        BVW_DVD_AUDIO_MENU,
346
 
        BVW_DVD_ANGLE_MENU,
347
 
        BVW_DVD_CHAPTER_MENU,
348
 
        BVW_DVD_NEXT_CHAPTER,
349
 
        BVW_DVD_PREV_CHAPTER,
350
 
        BVW_DVD_NEXT_TITLE,
351
 
        BVW_DVD_PREV_TITLE,
352
 
        BVW_DVD_NEXT_ANGLE,
353
 
        BVW_DVD_PREV_ANGLE,
354
 
        BVW_DVD_ROOT_MENU_UP,
355
 
        BVW_DVD_ROOT_MENU_DOWN,
356
 
        BVW_DVD_ROOT_MENU_LEFT,
357
 
        BVW_DVD_ROOT_MENU_RIGHT,
358
 
        BVW_DVD_ROOT_MENU_SELECT
359
 
} BvwDVDEvent;
360
 
</programlisting>
361
 
<para>
362
 
The DVD navigation actions available to fire as DVD events to
363
 
the <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>.</para>
364
 
<para>
365
 
</para><variablelist role="enum">
366
 
<varlistentry id="BVW-DVD-ROOT-MENU--CAPS" role="constant">
367
 
<term><literal>BVW_DVD_ROOT_MENU</literal></term>
368
 
<listitem><simpara> root menu
369
 
</simpara></listitem>
370
 
</varlistentry>
371
 
<varlistentry id="BVW-DVD-TITLE-MENU--CAPS" role="constant">
372
 
<term><literal>BVW_DVD_TITLE_MENU</literal></term>
373
 
<listitem><simpara> title menu
374
 
</simpara></listitem>
375
 
</varlistentry>
376
 
<varlistentry id="BVW-DVD-SUBPICTURE-MENU--CAPS" role="constant">
377
 
<term><literal>BVW_DVD_SUBPICTURE_MENU</literal></term>
378
 
<listitem><simpara> subpicture menu (if available)
379
 
</simpara></listitem>
380
 
</varlistentry>
381
 
<varlistentry id="BVW-DVD-AUDIO-MENU--CAPS" role="constant">
382
 
<term><literal>BVW_DVD_AUDIO_MENU</literal></term>
383
 
<listitem><simpara> audio menu (if available)
384
 
</simpara></listitem>
385
 
</varlistentry>
386
 
<varlistentry id="BVW-DVD-ANGLE-MENU--CAPS" role="constant">
387
 
<term><literal>BVW_DVD_ANGLE_MENU</literal></term>
388
 
<listitem><simpara> angle menu (if available)
389
 
</simpara></listitem>
390
 
</varlistentry>
391
 
<varlistentry id="BVW-DVD-CHAPTER-MENU--CAPS" role="constant">
392
 
<term><literal>BVW_DVD_CHAPTER_MENU</literal></term>
393
 
<listitem><simpara> chapter menu
394
 
</simpara></listitem>
395
 
</varlistentry>
396
 
<varlistentry id="BVW-DVD-NEXT-CHAPTER--CAPS" role="constant">
397
 
<term><literal>BVW_DVD_NEXT_CHAPTER</literal></term>
398
 
<listitem><simpara> the next chapter
399
 
</simpara></listitem>
400
 
</varlistentry>
401
 
<varlistentry id="BVW-DVD-PREV-CHAPTER--CAPS" role="constant">
402
 
<term><literal>BVW_DVD_PREV_CHAPTER</literal></term>
403
 
<listitem><simpara> the previous chapter
404
 
</simpara></listitem>
405
 
</varlistentry>
406
 
<varlistentry id="BVW-DVD-NEXT-TITLE--CAPS" role="constant">
407
 
<term><literal>BVW_DVD_NEXT_TITLE</literal></term>
408
 
<listitem><simpara> the next title in the current chapter
409
 
</simpara></listitem>
410
 
</varlistentry>
411
 
<varlistentry id="BVW-DVD-PREV-TITLE--CAPS" role="constant">
412
 
<term><literal>BVW_DVD_PREV_TITLE</literal></term>
413
 
<listitem><simpara> the previous title in the current chapter
414
 
</simpara></listitem>
415
 
</varlistentry>
416
 
<varlistentry id="BVW-DVD-NEXT-ANGLE--CAPS" role="constant">
417
 
<term><literal>BVW_DVD_NEXT_ANGLE</literal></term>
418
 
<listitem><simpara> the next angle
419
 
</simpara></listitem>
420
 
</varlistentry>
421
 
<varlistentry id="BVW-DVD-PREV-ANGLE--CAPS" role="constant">
422
 
<term><literal>BVW_DVD_PREV_ANGLE</literal></term>
423
 
<listitem><simpara> the previous angle
424
 
</simpara></listitem>
425
 
</varlistentry>
426
 
<varlistentry id="BVW-DVD-ROOT-MENU-UP--CAPS" role="constant">
427
 
<term><literal>BVW_DVD_ROOT_MENU_UP</literal></term>
428
 
<listitem><simpara> go up in the menu
429
 
</simpara></listitem>
430
 
</varlistentry>
431
 
<varlistentry id="BVW-DVD-ROOT-MENU-DOWN--CAPS" role="constant">
432
 
<term><literal>BVW_DVD_ROOT_MENU_DOWN</literal></term>
433
 
<listitem><simpara> go down in the menu
434
 
</simpara></listitem>
435
 
</varlistentry>
436
 
<varlistentry id="BVW-DVD-ROOT-MENU-LEFT--CAPS" role="constant">
437
 
<term><literal>BVW_DVD_ROOT_MENU_LEFT</literal></term>
438
 
<listitem><simpara> go left in the menu
439
 
</simpara></listitem>
440
 
</varlistentry>
441
 
<varlistentry id="BVW-DVD-ROOT-MENU-RIGHT--CAPS" role="constant">
442
 
<term><literal>BVW_DVD_ROOT_MENU_RIGHT</literal></term>
443
 
<listitem><simpara> go right in the menu
444
 
</simpara></listitem>
445
 
</varlistentry>
446
 
<varlistentry id="BVW-DVD-ROOT-MENU-SELECT--CAPS" role="constant">
447
 
<term><literal>BVW_DVD_ROOT_MENU_SELECT</literal></term>
448
 
<listitem><simpara> select the current menu entry
449
 
</simpara></listitem>
450
 
</varlistentry>
451
 
</variablelist></refsect2>
452
 
<refsect2 id="BvwMetadataType" role="enum">
453
 
<title>enum BvwMetadataType</title>
454
 
<indexterm zone="BvwMetadataType"><primary>BvwMetadataType</primary></indexterm><programlisting>typedef enum {
455
 
        BVW_INFO_TITLE,
456
 
        BVW_INFO_ARTIST,
457
 
        BVW_INFO_YEAR,
458
 
        BVW_INFO_COMMENT,
459
 
        BVW_INFO_ALBUM,
460
 
        BVW_INFO_DURATION,
461
 
        BVW_INFO_TRACK_NUMBER,
462
 
        BVW_INFO_COVER,
463
 
        /* Video */
464
 
        BVW_INFO_HAS_VIDEO,
465
 
        BVW_INFO_DIMENSION_X,
466
 
        BVW_INFO_DIMENSION_Y,
467
 
        BVW_INFO_VIDEO_BITRATE,
468
 
        BVW_INFO_VIDEO_CODEC,
469
 
        BVW_INFO_FPS,
470
 
        /* Audio */
471
 
        BVW_INFO_HAS_AUDIO,
472
 
        BVW_INFO_AUDIO_BITRATE,
473
 
        BVW_INFO_AUDIO_CODEC,
474
 
        BVW_INFO_AUDIO_SAMPLE_RATE,
475
 
        BVW_INFO_AUDIO_CHANNELS
476
 
} BvwMetadataType;
477
 
</programlisting>
478
 
<para>
479
 
The different metadata available for querying from a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
480
 
stream with <link linkend="bacon-video-widget-get-metadata"><function>bacon_video_widget_get_metadata()</function></link>.</para>
481
 
<para>
482
 
</para><variablelist role="enum">
483
 
<varlistentry id="BVW-INFO-TITLE--CAPS" role="constant">
484
 
<term><literal>BVW_INFO_TITLE</literal></term>
485
 
<listitem><simpara> the stream's title
486
 
</simpara></listitem>
487
 
</varlistentry>
488
 
<varlistentry id="BVW-INFO-ARTIST--CAPS" role="constant">
489
 
<term><literal>BVW_INFO_ARTIST</literal></term>
490
 
<listitem><simpara> the artist who created the work
491
 
</simpara></listitem>
492
 
</varlistentry>
493
 
<varlistentry id="BVW-INFO-YEAR--CAPS" role="constant">
494
 
<term><literal>BVW_INFO_YEAR</literal></term>
495
 
<listitem><simpara> the year in which the work was created
496
 
</simpara></listitem>
497
 
</varlistentry>
498
 
<varlistentry id="BVW-INFO-COMMENT--CAPS" role="constant">
499
 
<term><literal>BVW_INFO_COMMENT</literal></term>
500
 
<listitem><simpara> a comment attached to the stream
501
 
</simpara></listitem>
502
 
</varlistentry>
503
 
<varlistentry id="BVW-INFO-ALBUM--CAPS" role="constant">
504
 
<term><literal>BVW_INFO_ALBUM</literal></term>
505
 
<listitem><simpara> the album in which the work was released
506
 
</simpara></listitem>
507
 
</varlistentry>
508
 
<varlistentry id="BVW-INFO-DURATION--CAPS" role="constant">
509
 
<term><literal>BVW_INFO_DURATION</literal></term>
510
 
<listitem><simpara> the stream's duration, in seconds
511
 
</simpara></listitem>
512
 
</varlistentry>
513
 
<varlistentry id="BVW-INFO-TRACK-NUMBER--CAPS" role="constant">
514
 
<term><literal>BVW_INFO_TRACK_NUMBER</literal></term>
515
 
<listitem><simpara> the track number of the work on the album
516
 
</simpara></listitem>
517
 
</varlistentry>
518
 
<varlistentry id="BVW-INFO-COVER--CAPS" role="constant">
519
 
<term><literal>BVW_INFO_COVER</literal></term>
520
 
<listitem><simpara> a <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link> of the cover artwork
521
 
</simpara></listitem>
522
 
</varlistentry>
523
 
<varlistentry id="BVW-INFO-HAS-VIDEO--CAPS" role="constant">
524
 
<term><literal>BVW_INFO_HAS_VIDEO</literal></term>
525
 
<listitem><simpara> whether the stream has video
526
 
</simpara></listitem>
527
 
</varlistentry>
528
 
<varlistentry id="BVW-INFO-DIMENSION-X--CAPS" role="constant">
529
 
<term><literal>BVW_INFO_DIMENSION_X</literal></term>
530
 
<listitem><simpara> the video's width, in pixels
531
 
</simpara></listitem>
532
 
</varlistentry>
533
 
<varlistentry id="BVW-INFO-DIMENSION-Y--CAPS" role="constant">
534
 
<term><literal>BVW_INFO_DIMENSION_Y</literal></term>
535
 
<listitem><simpara> the video's height, in pixels
536
 
</simpara></listitem>
537
 
</varlistentry>
538
 
<varlistentry id="BVW-INFO-VIDEO-BITRATE--CAPS" role="constant">
539
 
<term><literal>BVW_INFO_VIDEO_BITRATE</literal></term>
540
 
<listitem><simpara> the video's bitrate, in kilobits per second
541
 
</simpara></listitem>
542
 
</varlistentry>
543
 
<varlistentry id="BVW-INFO-VIDEO-CODEC--CAPS" role="constant">
544
 
<term><literal>BVW_INFO_VIDEO_CODEC</literal></term>
545
 
<listitem><simpara> the video's codec
546
 
</simpara></listitem>
547
 
</varlistentry>
548
 
<varlistentry id="BVW-INFO-FPS--CAPS" role="constant">
549
 
<term><literal>BVW_INFO_FPS</literal></term>
550
 
<listitem><simpara> the number of frames per second in the video
551
 
</simpara></listitem>
552
 
</varlistentry>
553
 
<varlistentry id="BVW-INFO-HAS-AUDIO--CAPS" role="constant">
554
 
<term><literal>BVW_INFO_HAS_AUDIO</literal></term>
555
 
<listitem><simpara> whether the stream has audio
556
 
</simpara></listitem>
557
 
</varlistentry>
558
 
<varlistentry id="BVW-INFO-AUDIO-BITRATE--CAPS" role="constant">
559
 
<term><literal>BVW_INFO_AUDIO_BITRATE</literal></term>
560
 
<listitem><simpara> the audio's bitrate, in kilobits per second
561
 
</simpara></listitem>
562
 
</varlistentry>
563
 
<varlistentry id="BVW-INFO-AUDIO-CODEC--CAPS" role="constant">
564
 
<term><literal>BVW_INFO_AUDIO_CODEC</literal></term>
565
 
<listitem><simpara> the audio's codec
566
 
</simpara></listitem>
567
 
</varlistentry>
568
 
<varlistentry id="BVW-INFO-AUDIO-SAMPLE-RATE--CAPS" role="constant">
569
 
<term><literal>BVW_INFO_AUDIO_SAMPLE_RATE</literal></term>
570
 
<listitem><simpara> the audio sample rate, in bits per second
571
 
</simpara></listitem>
572
 
</varlistentry>
573
 
<varlistentry id="BVW-INFO-AUDIO-CHANNELS--CAPS" role="constant">
574
 
<term><literal>BVW_INFO_AUDIO_CHANNELS</literal></term>
575
 
<listitem><simpara> a string describing the number of audio channels in the stream
576
 
</simpara></listitem>
577
 
</varlistentry>
578
 
</variablelist></refsect2>
579
 
<refsect2 id="BvwVisualsQuality" role="enum">
580
 
<title>enum BvwVisualsQuality</title>
581
 
<indexterm zone="BvwVisualsQuality"><primary>BvwVisualsQuality</primary></indexterm><programlisting>typedef enum {
582
 
        VISUAL_SMALL = 0,
583
 
        VISUAL_NORMAL,
584
 
        VISUAL_LARGE,
585
 
        VISUAL_EXTRA_LARGE,
586
 
        NUM_VISUAL_QUALITIES
587
 
} BvwVisualsQuality;
588
 
</programlisting>
589
 
<para>
590
 
The different visualisation sizes or qualities available for use
591
 
with <link linkend="bacon-video-widget-set-visuals-quality"><function>bacon_video_widget_set_visuals_quality()</function></link>.</para>
592
 
<para>
593
 
</para><variablelist role="enum">
594
 
<varlistentry id="VISUAL-SMALL--CAPS" role="constant">
595
 
<term><literal>VISUAL_SMALL</literal></term>
596
 
<listitem><simpara> small size (240×15)
597
 
</simpara></listitem>
598
 
</varlistentry>
599
 
<varlistentry id="VISUAL-NORMAL--CAPS" role="constant">
600
 
<term><literal>VISUAL_NORMAL</literal></term>
601
 
<listitem><simpara> normal size (320×25)
602
 
</simpara></listitem>
603
 
</varlistentry>
604
 
<varlistentry id="VISUAL-LARGE--CAPS" role="constant">
605
 
<term><literal>VISUAL_LARGE</literal></term>
606
 
<listitem><simpara> large size (480×25)
607
 
</simpara></listitem>
608
 
</varlistentry>
609
 
<varlistentry id="VISUAL-EXTRA-LARGE--CAPS" role="constant">
610
 
<term><literal>VISUAL_EXTRA_LARGE</literal></term>
611
 
<listitem><simpara> extra large size (600×30)
612
 
</simpara></listitem>
613
 
</varlistentry>
614
 
<varlistentry id="NUM-VISUAL-QUALITIES--CAPS" role="constant">
615
 
<term><literal>NUM_VISUAL_QUALITIES</literal></term>
616
 
<listitem><simpara> the number of visual qualities available
617
 
</simpara></listitem>
618
 
</varlistentry>
619
 
</variablelist></refsect2>
620
 
<refsect2 id="BvwVideoProperty" role="enum">
621
 
<title>enum BvwVideoProperty</title>
622
 
<indexterm zone="BvwVideoProperty"><primary>BvwVideoProperty</primary></indexterm><programlisting>typedef enum {
623
 
        BVW_VIDEO_BRIGHTNESS,
624
 
        BVW_VIDEO_CONTRAST,
625
 
        BVW_VIDEO_SATURATION,
626
 
        BVW_VIDEO_HUE
627
 
} BvwVideoProperty;
628
 
</programlisting>
629
 
<para>
630
 
The video properties queryable with <link linkend="bacon-video-widget-get-video-property"><function>bacon_video_widget_get_video_property()</function></link>,
631
 
and settable with <link linkend="bacon-video-widget-set-video-property"><function>bacon_video_widget_set_video_property()</function></link>.</para>
632
 
<para>
633
 
</para><variablelist role="enum">
634
 
<varlistentry id="BVW-VIDEO-BRIGHTNESS--CAPS" role="constant">
635
 
<term><literal>BVW_VIDEO_BRIGHTNESS</literal></term>
636
 
<listitem><simpara> the video brightness
637
 
</simpara></listitem>
638
 
</varlistentry>
639
 
<varlistentry id="BVW-VIDEO-CONTRAST--CAPS" role="constant">
640
 
<term><literal>BVW_VIDEO_CONTRAST</literal></term>
641
 
<listitem><simpara> the video contrast
642
 
</simpara></listitem>
643
 
</varlistentry>
644
 
<varlistentry id="BVW-VIDEO-SATURATION--CAPS" role="constant">
645
 
<term><literal>BVW_VIDEO_SATURATION</literal></term>
646
 
<listitem><simpara> the video saturation
647
 
</simpara></listitem>
648
 
</varlistentry>
649
 
<varlistentry id="BVW-VIDEO-HUE--CAPS" role="constant">
650
 
<term><literal>BVW_VIDEO_HUE</literal></term>
651
 
<listitem><simpara> the video hue
652
 
</simpara></listitem>
653
 
</varlistentry>
654
 
</variablelist></refsect2>
655
 
<refsect2 id="BvwError" role="enum">
656
 
<title>enum BvwError</title>
657
 
<indexterm zone="BvwError"><primary>BvwError</primary></indexterm><programlisting>typedef enum {
658
 
        /* Plugins */
659
 
        BVW_ERROR_AUDIO_PLUGIN,
660
 
        BVW_ERROR_NO_PLUGIN_FOR_FILE,
661
 
        BVW_ERROR_VIDEO_PLUGIN,
662
 
        BVW_ERROR_AUDIO_BUSY,
663
 
        /* File */
664
 
        BVW_ERROR_BROKEN_FILE,
665
 
        BVW_ERROR_FILE_GENERIC,
666
 
        BVW_ERROR_FILE_PERMISSION,
667
 
        BVW_ERROR_FILE_ENCRYPTED,
668
 
        BVW_ERROR_FILE_NOT_FOUND,
669
 
        /* Devices */
670
 
        BVW_ERROR_DVD_ENCRYPTED,
671
 
        BVW_ERROR_INVALID_DEVICE,
672
 
        BVW_ERROR_DEVICE_BUSY,
673
 
        /* Network */
674
 
        BVW_ERROR_UNKNOWN_HOST,
675
 
        BVW_ERROR_NETWORK_UNREACHABLE,
676
 
        BVW_ERROR_CONNECTION_REFUSED,
677
 
        /* Generic */
678
 
        BVW_ERROR_INVALID_LOCATION,
679
 
        BVW_ERROR_GENERIC,
680
 
        BVW_ERROR_CODEC_NOT_HANDLED,
681
 
        BVW_ERROR_AUDIO_ONLY,
682
 
        BVW_ERROR_CANNOT_CAPTURE,
683
 
        BVW_ERROR_READ_ERROR,
684
 
        BVW_ERROR_PLUGIN_LOAD,
685
 
        BVW_ERROR_EMPTY_FILE
686
 
} BvwError;
687
 
</programlisting>
688
 
<para>
689
 
Error codes for <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link> operations.</para>
690
 
<para>
691
 
</para><variablelist role="enum">
692
 
<varlistentry id="BVW-ERROR-AUDIO-PLUGIN--CAPS" role="constant">
693
 
<term><literal>BVW_ERROR_AUDIO_PLUGIN</literal></term>
694
 
<listitem><simpara> Error loading audio output plugin or device.
695
 
</simpara></listitem>
696
 
</varlistentry>
697
 
<varlistentry id="BVW-ERROR-NO-PLUGIN-FOR-FILE--CAPS" role="constant">
698
 
<term><literal>BVW_ERROR_NO_PLUGIN_FOR_FILE</literal></term>
699
 
<listitem><simpara> A required GStreamer plugin or xine feature is missing.
700
 
</simpara></listitem>
701
 
</varlistentry>
702
 
<varlistentry id="BVW-ERROR-VIDEO-PLUGIN--CAPS" role="constant">
703
 
<term><literal>BVW_ERROR_VIDEO_PLUGIN</literal></term>
704
 
<listitem><simpara> Error loading video output plugin or device.
705
 
</simpara></listitem>
706
 
</varlistentry>
707
 
<varlistentry id="BVW-ERROR-AUDIO-BUSY--CAPS" role="constant">
708
 
<term><literal>BVW_ERROR_AUDIO_BUSY</literal></term>
709
 
<listitem><simpara> Audio output device is busy.
710
 
</simpara></listitem>
711
 
</varlistentry>
712
 
<varlistentry id="BVW-ERROR-BROKEN-FILE--CAPS" role="constant">
713
 
<term><literal>BVW_ERROR_BROKEN_FILE</literal></term>
714
 
<listitem><simpara> The movie file is broken and cannot be decoded.
715
 
</simpara></listitem>
716
 
</varlistentry>
717
 
<varlistentry id="BVW-ERROR-FILE-GENERIC--CAPS" role="constant">
718
 
<term><literal>BVW_ERROR_FILE_GENERIC</literal></term>
719
 
<listitem><simpara> A generic error for problems with movie files.
720
 
</simpara></listitem>
721
 
</varlistentry>
722
 
<varlistentry id="BVW-ERROR-FILE-PERMISSION--CAPS" role="constant">
723
 
<term><literal>BVW_ERROR_FILE_PERMISSION</literal></term>
724
 
<listitem><simpara> Permission was refused to access the stream, or authentication was required.
725
 
</simpara></listitem>
726
 
</varlistentry>
727
 
<varlistentry id="BVW-ERROR-FILE-ENCRYPTED--CAPS" role="constant">
728
 
<term><literal>BVW_ERROR_FILE_ENCRYPTED</literal></term>
729
 
<listitem><simpara> The stream is encrypted and cannot be played.
730
 
</simpara></listitem>
731
 
</varlistentry>
732
 
<varlistentry id="BVW-ERROR-FILE-NOT-FOUND--CAPS" role="constant">
733
 
<term><literal>BVW_ERROR_FILE_NOT_FOUND</literal></term>
734
 
<listitem><simpara> The stream cannot be found.
735
 
</simpara></listitem>
736
 
</varlistentry>
737
 
<varlistentry id="BVW-ERROR-DVD-ENCRYPTED--CAPS" role="constant">
738
 
<term><literal>BVW_ERROR_DVD_ENCRYPTED</literal></term>
739
 
<listitem><simpara> The DVD is encrypted and libdvdcss is not installed.
740
 
</simpara></listitem>
741
 
</varlistentry>
742
 
<varlistentry id="BVW-ERROR-INVALID-DEVICE--CAPS" role="constant">
743
 
<term><literal>BVW_ERROR_INVALID_DEVICE</literal></term>
744
 
<listitem><simpara> The device given in an MRL (e.g. DVD drive or DVB tuner) did not exist.
745
 
</simpara></listitem>
746
 
</varlistentry>
747
 
<varlistentry id="BVW-ERROR-DEVICE-BUSY--CAPS" role="constant">
748
 
<term><literal>BVW_ERROR_DEVICE_BUSY</literal></term>
749
 
<listitem><simpara> The device was busy.
750
 
</simpara></listitem>
751
 
</varlistentry>
752
 
<varlistentry id="BVW-ERROR-UNKNOWN-HOST--CAPS" role="constant">
753
 
<term><literal>BVW_ERROR_UNKNOWN_HOST</literal></term>
754
 
<listitem><simpara> The host for a given stream could not be resolved.
755
 
</simpara></listitem>
756
 
</varlistentry>
757
 
<varlistentry id="BVW-ERROR-NETWORK-UNREACHABLE--CAPS" role="constant">
758
 
<term><literal>BVW_ERROR_NETWORK_UNREACHABLE</literal></term>
759
 
<listitem><simpara> The host for a given stream could not be reached.
760
 
</simpara></listitem>
761
 
</varlistentry>
762
 
<varlistentry id="BVW-ERROR-CONNECTION-REFUSED--CAPS" role="constant">
763
 
<term><literal>BVW_ERROR_CONNECTION_REFUSED</literal></term>
764
 
<listitem><simpara> The server for a given stream refused the connection.
765
 
</simpara></listitem>
766
 
</varlistentry>
767
 
<varlistentry id="BVW-ERROR-INVALID-LOCATION--CAPS" role="constant">
768
 
<term><literal>BVW_ERROR_INVALID_LOCATION</literal></term>
769
 
<listitem><simpara> An MRL was malformed, or CDDB playback was attempted (which is now unsupported).
770
 
</simpara></listitem>
771
 
</varlistentry>
772
 
<varlistentry id="BVW-ERROR-GENERIC--CAPS" role="constant">
773
 
<term><literal>BVW_ERROR_GENERIC</literal></term>
774
 
<listitem><simpara> A generic error occurred.
775
 
</simpara></listitem>
776
 
</varlistentry>
777
 
<varlistentry id="BVW-ERROR-CODEC-NOT-HANDLED--CAPS" role="constant">
778
 
<term><literal>BVW_ERROR_CODEC_NOT_HANDLED</literal></term>
779
 
<listitem><simpara> The audio or video codec required by the stream is not supported.
780
 
</simpara></listitem>
781
 
</varlistentry>
782
 
<varlistentry id="BVW-ERROR-AUDIO-ONLY--CAPS" role="constant">
783
 
<term><literal>BVW_ERROR_AUDIO_ONLY</literal></term>
784
 
<listitem><simpara> An audio-only stream could not be played due to missing audio output support.
785
 
</simpara></listitem>
786
 
</varlistentry>
787
 
<varlistentry id="BVW-ERROR-CANNOT-CAPTURE--CAPS" role="constant">
788
 
<term><literal>BVW_ERROR_CANNOT_CAPTURE</literal></term>
789
 
<listitem><simpara> Error determining frame capture support for a video with <link linkend="bacon-video-widget-can-get-frames"><function>bacon_video_widget_can_get_frames()</function></link>.
790
 
</simpara></listitem>
791
 
</varlistentry>
792
 
<varlistentry id="BVW-ERROR-READ-ERROR--CAPS" role="constant">
793
 
<term><literal>BVW_ERROR_READ_ERROR</literal></term>
794
 
<listitem><simpara> A generic error for problems reading streams.
795
 
</simpara></listitem>
796
 
</varlistentry>
797
 
<varlistentry id="BVW-ERROR-PLUGIN-LOAD--CAPS" role="constant">
798
 
<term><literal>BVW_ERROR_PLUGIN_LOAD</literal></term>
799
 
<listitem><simpara> A library or plugin could not be loaded.
800
 
</simpara></listitem>
801
 
</varlistentry>
802
 
<varlistentry id="BVW-ERROR-EMPTY-FILE--CAPS" role="constant">
803
 
<term><literal>BVW_ERROR_EMPTY_FILE</literal></term>
804
 
<listitem><simpara> A movie file was empty.
805
 
</simpara></listitem>
806
 
</varlistentry>
807
 
</variablelist></refsect2>
808
 
<refsect2 id="BvwUseType" role="enum">
809
 
<title>enum BvwUseType</title>
810
 
<indexterm zone="BvwUseType"><primary>BvwUseType</primary></indexterm><programlisting>typedef enum {
811
 
        BVW_USE_TYPE_VIDEO,
812
 
        BVW_USE_TYPE_AUDIO,
813
 
        BVW_USE_TYPE_CAPTURE,
814
 
        BVW_USE_TYPE_METADATA
815
 
} BvwUseType;
816
 
</programlisting>
817
 
<para>
818
 
The purpose for which a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link> will be used, as specified to
819
 
<link linkend="bacon-video-widget-new"><function>bacon_video_widget_new()</function></link>. This determines which features will be enabled
820
 
in the created widget.</para>
821
 
<para>
822
 
</para><variablelist role="enum">
823
 
<varlistentry id="BVW-USE-TYPE-VIDEO--CAPS" role="constant">
824
 
<term><literal>BVW_USE_TYPE_VIDEO</literal></term>
825
 
<listitem><simpara> fully-featured with video, audio, capture and metadata support
826
 
</simpara></listitem>
827
 
</varlistentry>
828
 
<varlistentry id="BVW-USE-TYPE-AUDIO--CAPS" role="constant">
829
 
<term><literal>BVW_USE_TYPE_AUDIO</literal></term>
830
 
<listitem><simpara> audio and metadata support
831
 
</simpara></listitem>
832
 
</varlistentry>
833
 
<varlistentry id="BVW-USE-TYPE-CAPTURE--CAPS" role="constant">
834
 
<term><literal>BVW_USE_TYPE_CAPTURE</literal></term>
835
 
<listitem><simpara> capture support only
836
 
</simpara></listitem>
837
 
</varlistentry>
838
 
<varlistentry id="BVW-USE-TYPE-METADATA--CAPS" role="constant">
839
 
<term><literal>BVW_USE_TYPE_METADATA</literal></term>
840
 
<listitem><simpara> metadata support only
841
 
</simpara></listitem>
842
 
</varlistentry>
843
 
</variablelist></refsect2>
844
 
<refsect2 id="bacon-video-widget-new" role="function">
845
 
<title>bacon_video_widget_new ()</title>
846
 
<indexterm zone="bacon-video-widget-new"><primary>bacon_video_widget_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         bacon_video_widget_new              (<link linkend="int">int</link> width,
847
 
                                                         <link linkend="int">int</link> height,
848
 
                                                         <link linkend="BvwUseType">BvwUseType</link> type,
849
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
850
 
<para>
851
 
Creates a new <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link> for the purpose specified in <parameter>type</parameter>.
852
 
</para>
853
 
<para>
854
 
If <parameter>type</parameter> is <link linkend="BVW-USE-TYPE-VIDEO--CAPS"><literal>BVW_USE_TYPE_VIDEO</literal></link>, the <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link> will be fully-featured; other
855
 
values of <parameter>type</parameter> will enable less functionality on the widget, which will come with
856
 
corresponding decreases in the size of its memory footprint.
857
 
</para>
858
 
<para>
859
 
<parameter>width</parameter> and <parameter>height</parameter> give the initial or expected video height. Set them to <link linkend="1--CAPS"><literal>-1</literal></link> if the
860
 
video size is unknown. For small videos, <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link> will be configured differently.
861
 
</para>
862
 
<para>
863
 
A <link linkend="BvwError"><type>BvwError</type></link> will be returned on error.</para>
864
 
<para>
865
 
</para><variablelist role="params">
866
 
<varlistentry><term><parameter>width</parameter>&#160;:</term>
867
 
<listitem><simpara> initial or expected video width, in pixels, or <link linkend="1--CAPS"><literal>-1</literal></link>
868
 
</simpara></listitem></varlistentry>
869
 
<varlistentry><term><parameter>height</parameter>&#160;:</term>
870
 
<listitem><simpara> initial or expected video height, in pixels, or <link linkend="1--CAPS"><literal>-1</literal></link>
871
 
</simpara></listitem></varlistentry>
872
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
873
 
<listitem><simpara> the widget's use type
874
 
</simpara></listitem></varlistentry>
875
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
876
 
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
877
 
</simpara></listitem></varlistentry>
878
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>; destroy with <link linkend="gtk-widget-destroy"><function>gtk_widget_destroy()</function></link>
879
 
</simpara></listitem></varlistentry>
880
 
</variablelist></refsect2>
881
 
<refsect2 id="bacon-video-widget-init-backend" role="function">
882
 
<title>bacon_video_widget_init_backend ()</title>
883
 
<indexterm zone="bacon-video-widget-init-backend"><primary>bacon_video_widget_init_backend</primary></indexterm><programlisting><link linkend="void">void</link>                bacon_video_widget_init_backend     (<link linkend="int">int</link> *argc,
884
 
                                                         <link linkend="char">char</link> ***argv);</programlisting>
885
 
<para>
886
 
Initialises <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>'s GStreamer backend. If this fails
887
 
for the GStreamer backend, your application will be terminated.
888
 
</para>
889
 
<para>
890
 
Applications must call either this or <link linkend="bacon-video-widget-get-option-group"><function>bacon_video_widget_get_option_group()</function></link> exactly
891
 
once; but not both.</para>
892
 
<para>
893
 
</para><variablelist role="params">
894
 
<varlistentry><term><parameter>argc</parameter>&#160;:</term>
895
 
<listitem><simpara> pointer to application's argc
896
 
</simpara></listitem></varlistentry>
897
 
<varlistentry><term><parameter>argv</parameter>&#160;:</term>
898
 
<listitem><simpara> pointer to application's argv
899
 
</simpara></listitem></varlistentry>
900
 
</variablelist></refsect2>
901
 
<refsect2 id="bacon-video-widget-open" role="function">
902
 
<title>bacon_video_widget_open ()</title>
903
 
<indexterm zone="bacon-video-widget-open"><primary>bacon_video_widget_open</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            bacon_video_widget_open             (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
904
 
                                                         const <link linkend="char">char</link> *mrl,
905
 
                                                         const <link linkend="char">char</link> *subtitle_uri,
906
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
907
 
<para>
908
 
Opens the given <parameter>mrl</parameter> in <parameter>bvw</parameter> for playing. If <parameter>subtitle_uri</parameter> is not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, the given
909
 
subtitle file is also loaded. Alternatively, the subtitle URI can be passed in <parameter>mrl</parameter>
910
 
by adding it after <literal><link linkend="subtitle--"><type>""</type></link></literal>. For example:
911
 
<literal>http://example.com/video.mpg<link linkend="subtitle--"><type>""</type></link>/home/user/subtitle.ass</literal>.
912
 
</para>
913
 
<para>
914
 
If there was a filesystem error, a <link linkend="BVW-ERROR-GENERIC--CAPS"><literal>BVW_ERROR_GENERIC</literal></link> error will be returned. Otherwise,
915
 
more specific <link linkend="BvwError"><type>BvwError</type></link> errors will be returned.
916
 
</para>
917
 
<para>
918
 
On success, the MRL is loaded and waiting to be played with <link linkend="bacon-video-widget-play"><function>bacon_video_widget_play()</function></link>.</para>
919
 
<para>
920
 
</para><variablelist role="params">
921
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
922
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
923
 
</simpara></listitem></varlistentry>
924
 
<varlistentry><term><parameter>mrl</parameter>&#160;:</term>
925
 
<listitem><simpara> an MRL
926
 
</simpara></listitem></varlistentry>
927
 
<varlistentry><term><parameter>subtitle_uri</parameter>&#160;:</term>
928
 
<listitem><simpara> the URI of a subtitle file, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
929
 
</simpara></listitem></varlistentry>
930
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
931
 
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
932
 
</simpara></listitem></varlistentry>
933
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> on success, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
934
 
</simpara></listitem></varlistentry>
935
 
</variablelist></refsect2>
936
 
<refsect2 id="bacon-video-widget-play" role="function">
937
 
<title>bacon_video_widget_play ()</title>
938
 
<indexterm zone="bacon-video-widget-play"><primary>bacon_video_widget_play</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            bacon_video_widget_play             (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
939
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
940
 
<para>
941
 
Plays the currently-loaded video in <parameter>bvw</parameter>.
942
 
</para>
943
 
<para>
944
 
Errors from the GStreamer backend will be returned asynchronously via the
945
 
<link linkend="BaconVideoWidget-error"><type>"error"</type></link> signal, even if this function returns <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>.</para>
946
 
<para>
947
 
</para><variablelist role="params">
948
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
949
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
950
 
</simpara></listitem></varlistentry>
951
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
952
 
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
953
 
</simpara></listitem></varlistentry>
954
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> on success, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
955
 
</simpara></listitem></varlistentry>
956
 
</variablelist></refsect2>
957
 
<refsect2 id="bacon-video-widget-pause" role="function">
958
 
<title>bacon_video_widget_pause ()</title>
959
 
<indexterm zone="bacon-video-widget-pause"><primary>bacon_video_widget_pause</primary></indexterm><programlisting><link linkend="void">void</link>                bacon_video_widget_pause            (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
960
 
<para>
961
 
Pauses the current stream in the video widget.
962
 
</para>
963
 
<para>
964
 
If a live stream is being played, playback is stopped entirely.</para>
965
 
<para>
966
 
</para><variablelist role="params">
967
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
968
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
969
 
</simpara></listitem></varlistentry>
970
 
</variablelist></refsect2>
971
 
<refsect2 id="bacon-video-widget-seek" role="function">
972
 
<title>bacon_video_widget_seek ()</title>
973
 
<indexterm zone="bacon-video-widget-seek"><primary>bacon_video_widget_seek</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            bacon_video_widget_seek             (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
974
 
                                                         <link linkend="double">double</link> position,
975
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
976
 
<para>
977
 
Seeks the currently-playing stream to <parameter>position</parameter> as a percentage of the total
978
 
stream length.</para>
979
 
<para>
980
 
</para><variablelist role="params">
981
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
982
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
983
 
</simpara></listitem></varlistentry>
984
 
<varlistentry><term><parameter>position</parameter>&#160;:</term>
985
 
<listitem><simpara> the percentage of the way through the stream to which to seek
986
 
</simpara></listitem></varlistentry>
987
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
988
 
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
989
 
</simpara></listitem></varlistentry>
990
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> on success, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
991
 
</simpara></listitem></varlistentry>
992
 
</variablelist></refsect2>
993
 
<refsect2 id="bacon-video-widget-seek-time" role="function">
994
 
<title>bacon_video_widget_seek_time ()</title>
995
 
<indexterm zone="bacon-video-widget-seek-time"><primary>bacon_video_widget_seek_time</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            bacon_video_widget_seek_time        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
996
 
                                                         <link linkend="gint64">gint64</link> _time,
997
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
998
 
<para>
999
 
Seeks the currently-playing stream to the absolute position <parameter>time</parameter>, in milliseconds.</para>
1000
 
<para>
1001
 
</para><variablelist role="params">
1002
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1003
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1004
 
</simpara></listitem></varlistentry>
1005
 
<varlistentry><term><parameter>_time</parameter>&#160;:</term>
1006
 
<listitem><simpara> the time to which to seek, in milliseconds
1007
 
</simpara></listitem></varlistentry>
1008
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1009
 
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1010
 
</simpara></listitem></varlistentry>
1011
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> on success, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1012
 
</simpara></listitem></varlistentry>
1013
 
</variablelist></refsect2>
1014
 
<refsect2 id="bacon-video-widget-stop" role="function">
1015
 
<title>bacon_video_widget_stop ()</title>
1016
 
<indexterm zone="bacon-video-widget-stop"><primary>bacon_video_widget_stop</primary></indexterm><programlisting><link linkend="void">void</link>                bacon_video_widget_stop             (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1017
 
<para>
1018
 
Stops playing the current stream and resets to the first position in the stream.</para>
1019
 
<para>
1020
 
</para><variablelist role="params">
1021
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1022
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1023
 
</simpara></listitem></varlistentry>
1024
 
</variablelist></refsect2>
1025
 
<refsect2 id="bacon-video-widget-close" role="function">
1026
 
<title>bacon_video_widget_close ()</title>
1027
 
<indexterm zone="bacon-video-widget-close"><primary>bacon_video_widget_close</primary></indexterm><programlisting><link linkend="void">void</link>                bacon_video_widget_close            (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1028
 
<para>
1029
 
Closes the current stream and frees the resources associated with it.</para>
1030
 
<para>
1031
 
</para><variablelist role="params">
1032
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1033
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1034
 
</simpara></listitem></varlistentry>
1035
 
</variablelist></refsect2>
1036
 
<refsect2 id="bacon-video-widget-can-deinterlace" role="function">
1037
 
<title>bacon_video_widget_can_deinterlace ()</title>
1038
 
<indexterm zone="bacon-video-widget-can-deinterlace"><primary>bacon_video_widget_can_deinterlace</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            bacon_video_widget_can_deinterlace  (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1039
 
<para>
1040
 
Returns whether the widget can deinterlace videos.</para>
1041
 
<para>
1042
 
</para><variablelist role="params">
1043
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1044
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1045
 
</simpara></listitem></varlistentry>
1046
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if deinterlacing is supported, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1047
 
</simpara></listitem></varlistentry>
1048
 
</variablelist></refsect2>
1049
 
<refsect2 id="bacon-video-widget-can-direct-seek" role="function">
1050
 
<title>bacon_video_widget_can_direct_seek ()</title>
1051
 
<indexterm zone="bacon-video-widget-can-direct-seek"><primary>bacon_video_widget_can_direct_seek</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            bacon_video_widget_can_direct_seek  (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1052
 
<para>
1053
 
Determines whether direct seeking is possible for the current stream.</para>
1054
 
<para>
1055
 
</para><variablelist role="params">
1056
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1057
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1058
 
</simpara></listitem></varlistentry>
1059
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if direct seeking is possible, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1060
 
</simpara></listitem></varlistentry>
1061
 
</variablelist></refsect2>
1062
 
<refsect2 id="bacon-video-widget-can-get-frames" role="function">
1063
 
<title>bacon_video_widget_can_get_frames ()</title>
1064
 
<indexterm zone="bacon-video-widget-can-get-frames"><primary>bacon_video_widget_can_get_frames</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            bacon_video_widget_can_get_frames   (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1065
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
1066
 
<para>
1067
 
Determines whether individual frames from the current stream can
1068
 
be returned using <link linkend="bacon-video-widget-get-current-frame"><function>bacon_video_widget_get_current_frame()</function></link>.
1069
 
</para>
1070
 
<para>
1071
 
Frames cannot be returned for audio-only streams, unless visualisations
1072
 
are enabled.</para>
1073
 
<para>
1074
 
</para><variablelist role="params">
1075
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1076
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1077
 
</simpara></listitem></varlistentry>
1078
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1079
 
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1080
 
</simpara></listitem></varlistentry>
1081
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if frames can be captured, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1082
 
</simpara></listitem></varlistentry>
1083
 
</variablelist></refsect2>
1084
 
<refsect2 id="bacon-video-widget-can-set-volume" role="function">
1085
 
<title>bacon_video_widget_can_set_volume ()</title>
1086
 
<indexterm zone="bacon-video-widget-can-set-volume"><primary>bacon_video_widget_can_set_volume</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            bacon_video_widget_can_set_volume   (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1087
 
<para>
1088
 
Returns whether the volume level can be set, given the current settings.
1089
 
</para>
1090
 
<para>
1091
 
The volume cannot be set if the audio output type is set to
1092
 
<link linkend="BVW-AUDIO-SOUND-AC3PASSTHRU--CAPS"><literal>BVW_AUDIO_SOUND_AC3PASSTHRU</literal></link>.</para>
1093
 
<para>
1094
 
</para><variablelist role="params">
1095
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1096
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1097
 
</simpara></listitem></varlistentry>
1098
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the volume can be set, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1099
 
</simpara></listitem></varlistentry>
1100
 
</variablelist></refsect2>
1101
 
<refsect2 id="bacon-video-widget-dvd-event" role="function">
1102
 
<title>bacon_video_widget_dvd_event ()</title>
1103
 
<indexterm zone="bacon-video-widget-dvd-event"><primary>bacon_video_widget_dvd_event</primary></indexterm><programlisting><link linkend="void">void</link>                bacon_video_widget_dvd_event        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1104
 
                                                         <link linkend="BvwDVDEvent">BvwDVDEvent</link> type);</programlisting>
1105
 
<para>
1106
 
Issues a DVD navigation event to the video widget, such as one to skip to the
1107
 
next chapter, or navigate to the DVD title menu.
1108
 
</para>
1109
 
<para>
1110
 
This is a no-op if the current stream is not navigable.</para>
1111
 
<para>
1112
 
</para><variablelist role="params">
1113
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1114
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1115
 
</simpara></listitem></varlistentry>
1116
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
1117
 
<listitem><simpara> the type of DVD event to issue
1118
 
</simpara></listitem></varlistentry>
1119
 
</variablelist></refsect2>
1120
 
<refsect2 id="bacon-video-widget-has-menus" role="function">
1121
 
<title>bacon_video_widget_has_menus ()</title>
1122
 
<indexterm zone="bacon-video-widget-has-menus"><primary>bacon_video_widget_has_menus</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            bacon_video_widget_has_menus        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1123
 
<para>
1124
 
Returns whether the widget is currently displaying a menu,
1125
 
such as a DVD menu.</para>
1126
 
<para>
1127
 
</para><variablelist role="params">
1128
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1129
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1130
 
</simpara></listitem></varlistentry>
1131
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if a menu is displyed, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1132
 
</simpara></listitem></varlistentry>
1133
 
</variablelist></refsect2>
1134
 
<refsect2 id="bacon-video-widget-get-aspect-ratio" role="function">
1135
 
<title>bacon_video_widget_get_aspect_ratio ()</title>
1136
 
<indexterm zone="bacon-video-widget-get-aspect-ratio"><primary>bacon_video_widget_get_aspect_ratio</primary></indexterm><programlisting><link linkend="BvwAspectRatio">BvwAspectRatio</link>      bacon_video_widget_get_aspect_ratio (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1137
 
<para>
1138
 
Returns the current aspect ratio used by the widget, from
1139
 
<link linkend="BaconVideoWidgetAspectRatio"><type>BaconVideoWidgetAspectRatio</type></link>.</para>
1140
 
<para>
1141
 
</para><variablelist role="params">
1142
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1143
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1144
 
</simpara></listitem></varlistentry>
1145
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the aspect ratio
1146
 
</simpara></listitem></varlistentry>
1147
 
</variablelist></refsect2>
1148
 
<refsect2 id="bacon-video-widget-set-aspect-ratio" role="function">
1149
 
<title>bacon_video_widget_set_aspect_ratio ()</title>
1150
 
<indexterm zone="bacon-video-widget-set-aspect-ratio"><primary>bacon_video_widget_set_aspect_ratio</primary></indexterm><programlisting><link linkend="void">void</link>                bacon_video_widget_set_aspect_ratio (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1151
 
                                                         <link linkend="BvwAspectRatio">BvwAspectRatio</link> ratio);</programlisting>
1152
 
<para>
1153
 
Sets the aspect ratio used by the widget, from <link linkend="BaconVideoWidgetAspectRatio"><type>BaconVideoWidgetAspectRatio</type></link>.
1154
 
</para>
1155
 
<para>
1156
 
Changes to this take effect immediately.</para>
1157
 
<para>
1158
 
</para><variablelist role="params">
1159
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1160
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1161
 
</simpara></listitem></varlistentry>
1162
 
<varlistentry><term><parameter>ratio</parameter>&#160;:</term>
1163
 
<listitem><simpara> the new aspect ratio
1164
 
</simpara></listitem></varlistentry>
1165
 
</variablelist></refsect2>
1166
 
<refsect2 id="bacon-video-widget-get-audio-out-type" role="function">
1167
 
<title>bacon_video_widget_get_audio_out_type ()</title>
1168
 
<indexterm zone="bacon-video-widget-get-audio-out-type"><primary>bacon_video_widget_get_audio_out_type</primary></indexterm><programlisting><link linkend="BvwAudioOutType">BvwAudioOutType</link>     bacon_video_widget_get_audio_out_type
1169
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1170
 
<para>
1171
 
Returns the current audio output type (e.g. how many speaker channels)
1172
 
from <link linkend="BaconVideoWidgetAudioOutType"><type>BaconVideoWidgetAudioOutType</type></link>.</para>
1173
 
<para>
1174
 
</para><variablelist role="params">
1175
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1176
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1177
 
</simpara></listitem></varlistentry>
1178
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the audio output type, or <link linkend="1--CAPS"><literal>-1</literal></link>
1179
 
</simpara></listitem></varlistentry>
1180
 
</variablelist></refsect2>
1181
 
<refsect2 id="bacon-video-widget-set-audio-out-type" role="function">
1182
 
<title>bacon_video_widget_set_audio_out_type ()</title>
1183
 
<indexterm zone="bacon-video-widget-set-audio-out-type"><primary>bacon_video_widget_set_audio_out_type</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            bacon_video_widget_set_audio_out_type
1184
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1185
 
                                                         <link linkend="BvwAudioOutType">BvwAudioOutType</link> type);</programlisting>
1186
 
<para>
1187
 
Sets the audio output type (number of speaker channels) in the video widget,
1188
 
and stores it in GConf.</para>
1189
 
<para>
1190
 
</para><variablelist role="params">
1191
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1192
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1193
 
</simpara></listitem></varlistentry>
1194
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
1195
 
<listitem><simpara> the new audio output type
1196
 
</simpara></listitem></varlistentry>
1197
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> on success, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1198
 
</simpara></listitem></varlistentry>
1199
 
</variablelist></refsect2>
1200
 
<refsect2 id="bacon-video-widget-get-auto-resize" role="function">
1201
 
<title>bacon_video_widget_get_auto_resize ()</title>
1202
 
<indexterm zone="bacon-video-widget-get-auto-resize"><primary>bacon_video_widget_get_auto_resize</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            bacon_video_widget_get_auto_resize  (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1203
 
<para>
1204
 
Returns whether the widget will automatically resize to fit videos.</para>
1205
 
<para>
1206
 
</para><variablelist role="params">
1207
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1208
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1209
 
</simpara></listitem></varlistentry>
1210
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the widget will resize, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1211
 
</simpara></listitem></varlistentry>
1212
 
</variablelist></refsect2>
1213
 
<refsect2 id="bacon-video-widget-set-auto-resize" role="function">
1214
 
<title>bacon_video_widget_set_auto_resize ()</title>
1215
 
<indexterm zone="bacon-video-widget-set-auto-resize"><primary>bacon_video_widget_set_auto_resize</primary></indexterm><programlisting><link linkend="void">void</link>                bacon_video_widget_set_auto_resize  (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1216
 
                                                         <link linkend="gboolean">gboolean</link> auto_resize);</programlisting>
1217
 
<para>
1218
 
Sets whether the widget should automatically resize to fit to new videos when
1219
 
they are loaded. Changes to this will take effect when the next media file is
1220
 
loaded.</para>
1221
 
<para>
1222
 
</para><variablelist role="params">
1223
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1224
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1225
 
</simpara></listitem></varlistentry>
1226
 
<varlistentry><term><parameter>auto_resize</parameter>&#160;:</term>
1227
 
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to automatically resize for new videos, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1228
 
</simpara></listitem></varlistentry>
1229
 
</variablelist></refsect2>
1230
 
<refsect2 id="bacon-video-widget-get-backend-name" role="function">
1231
 
<title>bacon_video_widget_get_backend_name ()</title>
1232
 
<indexterm zone="bacon-video-widget-get-backend-name"><primary>bacon_video_widget_get_backend_name</primary></indexterm><programlisting><link linkend="char">char</link> *              bacon_video_widget_get_backend_name (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1233
 
<para>
1234
 
Returns the name string for <parameter>bvw</parameter>. For the GStreamer backend, it is the output
1235
 
of <link linkend="gst-version-string"><function>gst_version_string()</function></link>. *</para>
1236
 
<para>
1237
 
</para><variablelist role="params">
1238
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1239
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1240
 
</simpara></listitem></varlistentry>
1241
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the backend's name; free with <link linkend="g-free"><function>g_free()</function></link>
1242
 
</simpara></listitem></varlistentry>
1243
 
</variablelist></refsect2>
1244
 
<refsect2 id="bacon-video-widget-get-connection-speed" role="function">
1245
 
<title>bacon_video_widget_get_connection_speed ()</title>
1246
 
<indexterm zone="bacon-video-widget-get-connection-speed"><primary>bacon_video_widget_get_connection_speed</primary></indexterm><programlisting><link linkend="int">int</link>                 bacon_video_widget_get_connection_speed
1247
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1248
 
<para>
1249
 
Returns the current connection speed, where <link linkend="0--CAPS"><literal>0</literal></link> is the lowest speed
1250
 
and <link linkend="11--CAPS"><literal>11</literal></link> is the highest.</para>
1251
 
<para>
1252
 
</para><variablelist role="params">
1253
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1254
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1255
 
</simpara></listitem></varlistentry>
1256
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the connection speed index
1257
 
</simpara></listitem></varlistentry>
1258
 
</variablelist></refsect2>
1259
 
<refsect2 id="bacon-video-widget-set-connection-speed" role="function">
1260
 
<title>bacon_video_widget_set_connection_speed ()</title>
1261
 
<indexterm zone="bacon-video-widget-set-connection-speed"><primary>bacon_video_widget_set_connection_speed</primary></indexterm><programlisting><link linkend="void">void</link>                bacon_video_widget_set_connection_speed
1262
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1263
 
                                                         <link linkend="int">int</link> speed);</programlisting>
1264
 
<para>
1265
 
Sets the connection speed from the given <parameter>speed</parameter> index, where <link linkend="0--CAPS"><literal>0</literal></link> is the lowest speed
1266
 
and <link linkend="11--CAPS"><literal>11</literal></link> is the highest.</para>
1267
 
<para>
1268
 
</para><variablelist role="params">
1269
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1270
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1271
 
</simpara></listitem></varlistentry>
1272
 
<varlistentry><term><parameter>speed</parameter>&#160;:</term>
1273
 
<listitem><simpara> the connection speed index
1274
 
</simpara></listitem></varlistentry>
1275
 
</variablelist></refsect2>
1276
 
<refsect2 id="bacon-video-widget-get-current-frame" role="function">
1277
 
<title>bacon_video_widget_get_current_frame ()</title>
1278
 
<indexterm zone="bacon-video-widget-get-current-frame"><primary>bacon_video_widget_get_current_frame</primary></indexterm><programlisting><link linkend="GdkPixbuf">GdkPixbuf</link> *         bacon_video_widget_get_current_frame
1279
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1280
 
<para>
1281
 
Returns a <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link> containing the current frame from the playing
1282
 
stream. This will wait for any pending seeks to complete before
1283
 
capturing the frame.</para>
1284
 
<para>
1285
 
</para><variablelist role="params">
1286
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1287
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1288
 
</simpara></listitem></varlistentry>
1289
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the current frame, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>; unref with <link linkend="g-object-unref"><function>g_object_unref()</function></link>
1290
 
</simpara></listitem></varlistentry>
1291
 
</variablelist></refsect2>
1292
 
<refsect2 id="bacon-video-widget-get-current-time" role="function">
1293
 
<title>bacon_video_widget_get_current_time ()</title>
1294
 
<indexterm zone="bacon-video-widget-get-current-time"><primary>bacon_video_widget_get_current_time</primary></indexterm><programlisting><link linkend="gint64">gint64</link>              bacon_video_widget_get_current_time (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1295
 
<para>
1296
 
Returns the current position in the stream, as the time (in milliseconds)
1297
 
since the beginning of the stream.</para>
1298
 
<para>
1299
 
</para><variablelist role="params">
1300
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1301
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1302
 
</simpara></listitem></varlistentry>
1303
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> time since the beginning of the stream, in milliseconds, or <link linkend="1--CAPS"><literal>-1</literal></link>
1304
 
</simpara></listitem></varlistentry>
1305
 
</variablelist></refsect2>
1306
 
<refsect2 id="bacon-video-widget-get-deinterlacing" role="function">
1307
 
<title>bacon_video_widget_get_deinterlacing ()</title>
1308
 
<indexterm zone="bacon-video-widget-get-deinterlacing"><primary>bacon_video_widget_get_deinterlacing</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            bacon_video_widget_get_deinterlacing
1309
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1310
 
<para>
1311
 
Returns whether deinterlacing of videos is enabled for this widget.</para>
1312
 
<para>
1313
 
</para><variablelist role="params">
1314
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1315
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1316
 
</simpara></listitem></varlistentry>
1317
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if deinterlacing is enabled, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1318
 
</simpara></listitem></varlistentry>
1319
 
</variablelist></refsect2>
1320
 
<refsect2 id="bacon-video-widget-set-deinterlacing" role="function">
1321
 
<title>bacon_video_widget_set_deinterlacing ()</title>
1322
 
<indexterm zone="bacon-video-widget-set-deinterlacing"><primary>bacon_video_widget_set_deinterlacing</primary></indexterm><programlisting><link linkend="void">void</link>                bacon_video_widget_set_deinterlacing
1323
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1324
 
                                                         <link linkend="gboolean">gboolean</link> deinterlace);</programlisting>
1325
 
<para>
1326
 
Sets whether the widget should deinterlace videos. This is a no-op if
1327
 
<link linkend="bacon-video-widget-can-deinterlace"><function>bacon_video_widget_can_deinterlace()</function></link> returns <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>.</para>
1328
 
<para>
1329
 
</para><variablelist role="params">
1330
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1331
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1332
 
</simpara></listitem></varlistentry>
1333
 
<varlistentry><term><parameter>deinterlace</parameter>&#160;:</term>
1334
 
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if videos should be deinterlaced, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1335
 
</simpara></listitem></varlistentry>
1336
 
</variablelist></refsect2>
1337
 
<refsect2 id="bacon-video-widget-set-fullscreen" role="function">
1338
 
<title>bacon_video_widget_set_fullscreen ()</title>
1339
 
<indexterm zone="bacon-video-widget-set-fullscreen"><primary>bacon_video_widget_set_fullscreen</primary></indexterm><programlisting><link linkend="void">void</link>                bacon_video_widget_set_fullscreen   (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1340
 
                                                         <link linkend="gboolean">gboolean</link> fullscreen);</programlisting>
1341
 
<para>
1342
 
Sets whether the widget renders the stream in fullscreen mode.
1343
 
</para>
1344
 
<para>
1345
 
Fullscreen rendering is done only when possible, as xvidmode is required.</para>
1346
 
<para>
1347
 
</para><variablelist role="params">
1348
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1349
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1350
 
</simpara></listitem></varlistentry>
1351
 
<varlistentry><term><parameter>fullscreen</parameter>&#160;:</term>
1352
 
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to go fullscreen, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1353
 
</simpara></listitem></varlistentry>
1354
 
</variablelist></refsect2>
1355
 
<refsect2 id="bacon-video-widget-get-languages" role="function">
1356
 
<title>bacon_video_widget_get_languages ()</title>
1357
 
<indexterm zone="bacon-video-widget-get-languages"><primary>bacon_video_widget_get_languages</primary></indexterm><programlisting><link linkend="GList">GList</link> *             bacon_video_widget_get_languages    (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1358
 
<para>
1359
 
Returns a list of audio language tags, each in the form <literal>AUDIO <replaceable>x</replaceable></literal>,
1360
 
where <replaceable>x</replaceable> is the language index.</para>
1361
 
<para>
1362
 
</para><variablelist role="params">
1363
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1364
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1365
 
</simpara></listitem></varlistentry>
1366
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GList"><type>GList</type></link> of audio language tags, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>; free each element with <link linkend="g-free"><function>g_free()</function></link> and the list with <link linkend="g-list-free"><function>g_list_free()</function></link>
1367
 
</simpara></listitem></varlistentry>
1368
 
</variablelist></refsect2>
1369
 
<refsect2 id="bacon-video-widget-get-language" role="function">
1370
 
<title>bacon_video_widget_get_language ()</title>
1371
 
<indexterm zone="bacon-video-widget-get-language"><primary>bacon_video_widget_get_language</primary></indexterm><programlisting><link linkend="int">int</link>                 bacon_video_widget_get_language     (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1372
 
<para>
1373
 
Returns the index of the current audio language.
1374
 
</para>
1375
 
<para>
1376
 
If the widget is not playing, or the default language is in use, <link linkend="1--CAPS"><literal>-1</literal></link> will be returned.</para>
1377
 
<para>
1378
 
</para><variablelist role="params">
1379
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1380
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1381
 
</simpara></listitem></varlistentry>
1382
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the audio language index
1383
 
</simpara></listitem></varlistentry>
1384
 
</variablelist></refsect2>
1385
 
<refsect2 id="bacon-video-widget-set-language" role="function">
1386
 
<title>bacon_video_widget_set_language ()</title>
1387
 
<indexterm zone="bacon-video-widget-set-language"><primary>bacon_video_widget_set_language</primary></indexterm><programlisting><link linkend="void">void</link>                bacon_video_widget_set_language     (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1388
 
                                                         <link linkend="int">int</link> language);</programlisting>
1389
 
<para>
1390
 
Sets the audio language index for <parameter>bvw</parameter>. If <parameter>language</parameter> is <link linkend="1--CAPS"><literal>-1</literal></link>, the default language will
1391
 
be used.</para>
1392
 
<para>
1393
 
</para><variablelist role="params">
1394
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1395
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1396
 
</simpara></listitem></varlistentry>
1397
 
<varlistentry><term><parameter>language</parameter>&#160;:</term>
1398
 
<listitem><simpara> an audio language index
1399
 
</simpara></listitem></varlistentry>
1400
 
</variablelist></refsect2>
1401
 
<refsect2 id="bacon-video-widget-set-logo" role="function">
1402
 
<title>bacon_video_widget_set_logo ()</title>
1403
 
<indexterm zone="bacon-video-widget-set-logo"><primary>bacon_video_widget_set_logo</primary></indexterm><programlisting><link linkend="void">void</link>                bacon_video_widget_set_logo         (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1404
 
                                                         const <link linkend="char">char</link> *name);</programlisting>
1405
 
<para>
1406
 
Sets the logo displayed on the video widget when no stream is loaded.</para>
1407
 
<para>
1408
 
</para><variablelist role="params">
1409
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1410
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1411
 
</simpara></listitem></varlistentry>
1412
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
1413
 
<listitem><simpara> the icon name of the logo
1414
 
</simpara></listitem></varlistentry>
1415
 
</variablelist></refsect2>
1416
 
<refsect2 id="bacon-video-widget-get-logo-mode" role="function">
1417
 
<title>bacon_video_widget_get_logo_mode ()</title>
1418
 
<indexterm zone="bacon-video-widget-get-logo-mode"><primary>bacon_video_widget_get_logo_mode</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            bacon_video_widget_get_logo_mode    (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1419
 
<para>
1420
 
Gets whether the logo is displayed when no stream is loaded.</para>
1421
 
<para>
1422
 
</para><variablelist role="params">
1423
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1424
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1425
 
</simpara></listitem></varlistentry>
1426
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the logo is displayed, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1427
 
</simpara></listitem></varlistentry>
1428
 
</variablelist></refsect2>
1429
 
<refsect2 id="bacon-video-widget-set-logo-mode" role="function">
1430
 
<title>bacon_video_widget_set_logo_mode ()</title>
1431
 
<indexterm zone="bacon-video-widget-set-logo-mode"><primary>bacon_video_widget_set_logo_mode</primary></indexterm><programlisting><link linkend="void">void</link>                bacon_video_widget_set_logo_mode    (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1432
 
                                                         <link linkend="gboolean">gboolean</link> logo_mode);</programlisting>
1433
 
<para>
1434
 
Sets whether to display a logo set with <parameter>bacon_video_widget_set_logo</parameter> when
1435
 
no stream is loaded. If <parameter>logo_mode</parameter> is <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>, nothing will be displayed
1436
 
and the video widget will take up no space. Otherwise, the logo will be
1437
 
displayed and will requisition a corresponding amount of space.</para>
1438
 
<para>
1439
 
</para><variablelist role="params">
1440
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1441
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1442
 
</simpara></listitem></varlistentry>
1443
 
<varlistentry><term><parameter>logo_mode</parameter>&#160;:</term>
1444
 
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to display the logo, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1445
 
</simpara></listitem></varlistentry>
1446
 
</variablelist></refsect2>
1447
 
<refsect2 id="bacon-video-widget-get-metadata" role="function">
1448
 
<title>bacon_video_widget_get_metadata ()</title>
1449
 
<indexterm zone="bacon-video-widget-get-metadata"><primary>bacon_video_widget_get_metadata</primary></indexterm><programlisting><link linkend="void">void</link>                bacon_video_widget_get_metadata     (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1450
 
                                                         <link linkend="BvwMetadataType">BvwMetadataType</link> type,
1451
 
                                                         <link linkend="GValue">GValue</link> *value);</programlisting>
1452
 
<para>
1453
 
Provides metadata of the given <parameter>type</parameter> about the current stream in <parameter>value</parameter>.
1454
 
</para>
1455
 
<para>
1456
 
Free the <link linkend="GValue"><type>GValue</type></link> with <link linkend="g-value-unset"><function>g_value_unset()</function></link>.</para>
1457
 
<para>
1458
 
</para><variablelist role="params">
1459
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1460
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1461
 
</simpara></listitem></varlistentry>
1462
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
1463
 
<listitem><simpara> the type of metadata to return
1464
 
</simpara></listitem></varlistentry>
1465
 
<varlistentry><term><parameter>value</parameter>&#160;:</term>
1466
 
<listitem><simpara> a <link linkend="GValue"><type>GValue</type></link>
1467
 
</simpara></listitem></varlistentry>
1468
 
</variablelist></refsect2>
1469
 
<refsect2 id="bacon-video-widget-get-mrls" role="function">
1470
 
<title>bacon_video_widget_get_mrls ()</title>
1471
 
<indexterm zone="bacon-video-widget-get-mrls"><primary>bacon_video_widget_get_mrls</primary></indexterm><programlisting><link linkend="gchar">gchar</link> **            bacon_video_widget_get_mrls         (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1472
 
                                                         <link linkend="TotemDiscMediaType">TotemDiscMediaType</link> type,
1473
 
                                                         const <link linkend="char">char</link> *device,
1474
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
1475
 
<para>
1476
 
Returns an array of MRLs available for the given <parameter>device</parameter> and media <parameter>type</parameter>.
1477
 
</para>
1478
 
<para>
1479
 
<parameter>device</parameter> should typically be the number of the device (e.g. <link linkend="0--CAPS"><literal>0</literal></link> for the first
1480
 
DVD drive.
1481
 
</para>
1482
 
<para>
1483
 
<parameter>type</parameter> can be any value from <link linkend="TotemDiscMediaType"><type>TotemDiscMediaType</type></link>, but a <link linkend="BVW-ERROR-INVALID-LOCATION--CAPS"><literal>BVW_ERROR_INVALID_LOCATION</literal></link> error
1484
 
will be returned if <parameter>type</parameter> is <link linkend="MEDIA-TYPE-CDDA--CAPS"><literal>MEDIA_TYPE_CDDA</literal></link>, as CDDA support has been removed from
1485
 
Totem (and hence <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>).
1486
 
</para>
1487
 
<para>
1488
 
A <link linkend="BVW-ERROR-NO-PLUGIN-FOR-FILE--CAPS"><literal>BVW_ERROR_NO_PLUGIN_FOR_FILE</literal></link> error will be returned if the required GStreamer elements do
1489
 
not exist for the given <parameter>type</parameter> (for the GStreamer backend). *
1490
 
If <parameter>device</parameter> does not exist, a <link linkend="BVW-ERROR-INVALID-DEVICE--CAPS"><literal>BVW_ERROR_INVALID_DEVICE</literal></link> error will be returned.</para>
1491
 
<para>
1492
 
</para><variablelist role="params">
1493
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1494
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1495
 
</simpara></listitem></varlistentry>
1496
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
1497
 
<listitem><simpara> the media type
1498
 
</simpara></listitem></varlistentry>
1499
 
<varlistentry><term><parameter>device</parameter>&#160;:</term>
1500
 
<listitem><simpara> the device name
1501
 
</simpara></listitem></varlistentry>
1502
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1503
 
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1504
 
</simpara></listitem></varlistentry>
1505
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="NULL--CAPS"><literal>NULL</literal></link>-terminated array of MRLs, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>; free with <link linkend="g-strfreev"><function>g_strfreev()</function></link>
1506
 
</simpara></listitem></varlistentry>
1507
 
</variablelist></refsect2>
1508
 
<refsect2 id="bacon-video-widget-get-option-group" role="function">
1509
 
<title>bacon_video_widget_get_option_group ()</title>
1510
 
<indexterm zone="bacon-video-widget-get-option-group"><primary>bacon_video_widget_get_option_group</primary></indexterm><programlisting><link linkend="GOptionGroup">GOptionGroup</link>*       bacon_video_widget_get_option_group (void);</programlisting>
1511
 
<para>
1512
 
Returns the <link linkend="GOptionGroup"><type>GOptionGroup</type></link> containing command-line options for
1513
 
<link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>.
1514
 
</para>
1515
 
<para>
1516
 
Applications must call either this or <link linkend="bacon-video-widget-init-backend"><function>bacon_video_widget_init_backend()</function></link> exactly
1517
 
once; but not both.</para>
1518
 
<para>
1519
 
</para><variablelist role="params">
1520
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GOptionGroup"><type>GOptionGroup</type></link> giving command-line options for <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1521
 
</simpara></listitem></varlistentry>
1522
 
</variablelist></refsect2>
1523
 
<refsect2 id="bacon-video-widget-get-position" role="function">
1524
 
<title>bacon_video_widget_get_position ()</title>
1525
 
<indexterm zone="bacon-video-widget-get-position"><primary>bacon_video_widget_get_position</primary></indexterm><programlisting><link linkend="double">double</link>              bacon_video_widget_get_position     (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1526
 
<para>
1527
 
Returns the current position in the stream, as a value between
1528
 
<link linkend="0--CAPS"><literal>0</literal></link> and <link linkend="1--CAPS"><literal>1</literal></link>.</para>
1529
 
<para>
1530
 
</para><variablelist role="params">
1531
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1532
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1533
 
</simpara></listitem></varlistentry>
1534
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the current position, or <link linkend="1--CAPS"><literal>-1</literal></link>
1535
 
</simpara></listitem></varlistentry>
1536
 
</variablelist></refsect2>
1537
 
<refsect2 id="bacon-video-widget-set-referrer" role="function">
1538
 
<title>bacon_video_widget_set_referrer ()</title>
1539
 
<indexterm zone="bacon-video-widget-set-referrer"><primary>bacon_video_widget_set_referrer</primary></indexterm><programlisting><link linkend="void">void</link>                bacon_video_widget_set_referrer     (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1540
 
                                                         const <link linkend="char">char</link> *referrer);</programlisting>
1541
 
<para>
1542
 
Sets the HTTP referrer URI to use when fetching HTTP ressources.</para>
1543
 
<para>
1544
 
</para><variablelist role="params">
1545
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1546
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1547
 
</simpara></listitem></varlistentry>
1548
 
<varlistentry><term><parameter>referrer</parameter>&#160;:</term>
1549
 
<listitem><simpara> a HTTP referrer URI, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1550
 
</simpara></listitem></varlistentry>
1551
 
</variablelist></refsect2>
1552
 
<refsect2 id="bacon-video-widget-set-scale-ratio" role="function">
1553
 
<title>bacon_video_widget_set_scale_ratio ()</title>
1554
 
<indexterm zone="bacon-video-widget-set-scale-ratio"><primary>bacon_video_widget_set_scale_ratio</primary></indexterm><programlisting><link linkend="void">void</link>                bacon_video_widget_set_scale_ratio  (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1555
 
                                                         <link linkend="float">float</link> ratio);</programlisting>
1556
 
<para>
1557
 
Sets the ratio by which the widget will scale videos when they are
1558
 
displayed. If <parameter>ratio</parameter> is set to <link linkend="0--CAPS"><literal>0</literal></link>, the highest ratio possible will
1559
 
be chosen.</para>
1560
 
<para>
1561
 
</para><variablelist role="params">
1562
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1563
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1564
 
</simpara></listitem></varlistentry>
1565
 
<varlistentry><term><parameter>ratio</parameter>&#160;:</term>
1566
 
<listitem><simpara> the new scale ratio
1567
 
</simpara></listitem></varlistentry>
1568
 
</variablelist></refsect2>
1569
 
<refsect2 id="bacon-video-widget-get-show-cursor" role="function">
1570
 
<title>bacon_video_widget_get_show_cursor ()</title>
1571
 
<indexterm zone="bacon-video-widget-get-show-cursor"><primary>bacon_video_widget_get_show_cursor</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            bacon_video_widget_get_show_cursor  (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1572
 
<para>
1573
 
Returns whether the cursor is shown when it is over the video widget.</para>
1574
 
<para>
1575
 
</para><variablelist role="params">
1576
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1577
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1578
 
</simpara></listitem></varlistentry>
1579
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the cursor is shown, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1580
 
</simpara></listitem></varlistentry>
1581
 
</variablelist></refsect2>
1582
 
<refsect2 id="bacon-video-widget-set-show-cursor" role="function">
1583
 
<title>bacon_video_widget_set_show_cursor ()</title>
1584
 
<indexterm zone="bacon-video-widget-set-show-cursor"><primary>bacon_video_widget_set_show_cursor</primary></indexterm><programlisting><link linkend="void">void</link>                bacon_video_widget_set_show_cursor  (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1585
 
                                                         <link linkend="gboolean">gboolean</link> show_cursor);</programlisting>
1586
 
<para>
1587
 
Sets whether the cursor should be shown when it is over the video
1588
 
widget. If <parameter>show_cursor</parameter> is <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>, the cursor will be invisible
1589
 
when it is moved over the video widget.</para>
1590
 
<para>
1591
 
</para><variablelist role="params">
1592
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1593
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1594
 
</simpara></listitem></varlistentry>
1595
 
<varlistentry><term><parameter>show_cursor</parameter>&#160;:</term>
1596
 
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to show the cursor, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1597
 
</simpara></listitem></varlistentry>
1598
 
</variablelist></refsect2>
1599
 
<refsect2 id="bacon-video-widget-set-show-visuals" role="function">
1600
 
<title>bacon_video_widget_set_show_visuals ()</title>
1601
 
<indexterm zone="bacon-video-widget-set-show-visuals"><primary>bacon_video_widget_set_show_visuals</primary></indexterm><programlisting><link linkend="void">void</link>                bacon_video_widget_set_show_visuals (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1602
 
                                                         <link linkend="gboolean">gboolean</link> show_visuals);</programlisting>
1603
 
<para>
1604
 
Sets whether to show visualisations when playing audio-only streams.</para>
1605
 
<para>
1606
 
</para><variablelist role="params">
1607
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1608
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1609
 
</simpara></listitem></varlistentry>
1610
 
<varlistentry><term><parameter>show_visuals</parameter>&#160;:</term>
1611
 
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to show visualisations, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1612
 
</simpara></listitem></varlistentry>
1613
 
</variablelist></refsect2>
1614
 
<refsect2 id="bacon-video-widget-get-stream-length" role="function">
1615
 
<title>bacon_video_widget_get_stream_length ()</title>
1616
 
<indexterm zone="bacon-video-widget-get-stream-length"><primary>bacon_video_widget_get_stream_length</primary></indexterm><programlisting><link linkend="gint64">gint64</link>              bacon_video_widget_get_stream_length
1617
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1618
 
<para>
1619
 
Returns the total length of the stream, in milliseconds.</para>
1620
 
<para>
1621
 
</para><variablelist role="params">
1622
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1623
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1624
 
</simpara></listitem></varlistentry>
1625
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the stream length, in milliseconds, or <link linkend="1--CAPS"><literal>-1</literal></link>
1626
 
</simpara></listitem></varlistentry>
1627
 
</variablelist></refsect2>
1628
 
<refsect2 id="bacon-video-widget-get-subtitles" role="function">
1629
 
<title>bacon_video_widget_get_subtitles ()</title>
1630
 
<indexterm zone="bacon-video-widget-get-subtitles"><primary>bacon_video_widget_get_subtitles</primary></indexterm><programlisting><link linkend="GList">GList</link> *             bacon_video_widget_get_subtitles    (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1631
 
<para>
1632
 
Returns a list of subtitle tags, each in the form <literal>TEXT <replaceable>x</replaceable></literal>,
1633
 
where <replaceable>x</replaceable> is the subtitle index.</para>
1634
 
<para>
1635
 
</para><variablelist role="params">
1636
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1637
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1638
 
</simpara></listitem></varlistentry>
1639
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GList"><type>GList</type></link> of subtitle tags, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>; free each element with <link linkend="g-free"><function>g_free()</function></link> and the list with <link linkend="g-list-free"><function>g_list_free()</function></link>
1640
 
</simpara></listitem></varlistentry>
1641
 
</variablelist></refsect2>
1642
 
<refsect2 id="bacon-video-widget-get-subtitle" role="function">
1643
 
<title>bacon_video_widget_get_subtitle ()</title>
1644
 
<indexterm zone="bacon-video-widget-get-subtitle"><primary>bacon_video_widget_get_subtitle</primary></indexterm><programlisting><link linkend="int">int</link>                 bacon_video_widget_get_subtitle     (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1645
 
<para>
1646
 
Returns the index of the current subtitles.
1647
 
</para>
1648
 
<para>
1649
 
If the widget is not playing, <link linkend="2--CAPS"><literal>-2</literal></link> will be returned. If no subtitles are
1650
 
being used, <link linkend="1--CAPS"><literal>-1</literal></link> is returned.</para>
1651
 
<para>
1652
 
</para><variablelist role="params">
1653
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1654
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1655
 
</simpara></listitem></varlistentry>
1656
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the subtitle index
1657
 
</simpara></listitem></varlistentry>
1658
 
</variablelist></refsect2>
1659
 
<refsect2 id="bacon-video-widget-set-subtitle" role="function">
1660
 
<title>bacon_video_widget_set_subtitle ()</title>
1661
 
<indexterm zone="bacon-video-widget-set-subtitle"><primary>bacon_video_widget_set_subtitle</primary></indexterm><programlisting><link linkend="void">void</link>                bacon_video_widget_set_subtitle     (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1662
 
                                                         <link linkend="int">int</link> subtitle);</programlisting>
1663
 
<para>
1664
 
Sets the subtitle index for <parameter>bvw</parameter>. If <parameter>subtitle</parameter> is <link linkend="1--CAPS"><literal>-1</literal></link>, no subtitles will
1665
 
be used.</para>
1666
 
<para>
1667
 
</para><variablelist role="params">
1668
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1669
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1670
 
</simpara></listitem></varlistentry>
1671
 
<varlistentry><term><parameter>subtitle</parameter>&#160;:</term>
1672
 
<listitem><simpara> a subtitle index
1673
 
</simpara></listitem></varlistentry>
1674
 
</variablelist></refsect2>
1675
 
<refsect2 id="bacon-video-widget-set-subtitle-encoding" role="function">
1676
 
<title>bacon_video_widget_set_subtitle_encoding ()</title>
1677
 
<indexterm zone="bacon-video-widget-set-subtitle-encoding"><primary>bacon_video_widget_set_subtitle_encoding</primary></indexterm><programlisting><link linkend="void">void</link>                bacon_video_widget_set_subtitle_encoding
1678
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1679
 
                                                         const <link linkend="char">char</link> *encoding);</programlisting>
1680
 
<para>
1681
 
Sets the encoding system for the subtitles, so that they can be decoded
1682
 
properly.</para>
1683
 
<para>
1684
 
</para><variablelist role="params">
1685
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1686
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1687
 
</simpara></listitem></varlistentry>
1688
 
<varlistentry><term><parameter>encoding</parameter>&#160;:</term>
1689
 
<listitem><simpara> an encoding system
1690
 
</simpara></listitem></varlistentry>
1691
 
</variablelist></refsect2>
1692
 
<refsect2 id="bacon-video-widget-set-subtitle-font" role="function">
1693
 
<title>bacon_video_widget_set_subtitle_font ()</title>
1694
 
<indexterm zone="bacon-video-widget-set-subtitle-font"><primary>bacon_video_widget_set_subtitle_font</primary></indexterm><programlisting><link linkend="void">void</link>                bacon_video_widget_set_subtitle_font
1695
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1696
 
                                                         const <link linkend="char">char</link> *font);</programlisting>
1697
 
<para>
1698
 
Sets the font size and style in which to display subtitles.
1699
 
</para>
1700
 
<para>
1701
 
<parameter>font</parameter> is a Pango font description string, as understood by
1702
 
<link linkend="pango-font-description-from-string"><function>pango_font_description_from_string()</function></link>.</para>
1703
 
<para>
1704
 
</para><variablelist role="params">
1705
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1706
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1707
 
</simpara></listitem></varlistentry>
1708
 
<varlistentry><term><parameter>font</parameter>&#160;:</term>
1709
 
<listitem><simpara> a font description string
1710
 
</simpara></listitem></varlistentry>
1711
 
</variablelist></refsect2>
1712
 
<refsect2 id="bacon-video-widget-set-user-agent" role="function">
1713
 
<title>bacon_video_widget_set_user_agent ()</title>
1714
 
<indexterm zone="bacon-video-widget-set-user-agent"><primary>bacon_video_widget_set_user_agent</primary></indexterm><programlisting><link linkend="void">void</link>                bacon_video_widget_set_user_agent   (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1715
 
                                                         const <link linkend="char">char</link> *user_agent);</programlisting>
1716
 
<para>
1717
 
Sets the HTTP user agent string to use when fetching HTTP ressources.</para>
1718
 
<para>
1719
 
</para><variablelist role="params">
1720
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1721
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1722
 
</simpara></listitem></varlistentry>
1723
 
<varlistentry><term><parameter>user_agent</parameter>&#160;:</term>
1724
 
<listitem><simpara> a HTTP user agent string, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> to use the default
1725
 
</simpara></listitem></varlistentry>
1726
 
</variablelist></refsect2>
1727
 
<refsect2 id="bacon-video-widget-get-video-property" role="function">
1728
 
<title>bacon_video_widget_get_video_property ()</title>
1729
 
<indexterm zone="bacon-video-widget-get-video-property"><primary>bacon_video_widget_get_video_property</primary></indexterm><programlisting><link linkend="int">int</link>                 bacon_video_widget_get_video_property
1730
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1731
 
                                                         <link linkend="BvwVideoProperty">BvwVideoProperty</link> type);</programlisting>
1732
 
<para>
1733
 
Returns the given property of the video, such as its brightness or saturation.
1734
 
</para>
1735
 
<para>
1736
 
It is returned as a percentage in the full range of integer values; from <link linkend="0--CAPS"><literal>0</literal></link>
1737
 
to <link linkend="G-MAXINT--CAPS"><literal>G_MAXINT</literal></link>, where <link linkend="G-MAXINT--CAPS"><literal>G_MAXINT</literal></link>/2 is the default.</para>
1738
 
<para>
1739
 
</para><variablelist role="params">
1740
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1741
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1742
 
</simpara></listitem></varlistentry>
1743
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
1744
 
<listitem><simpara> the type of property
1745
 
</simpara></listitem></varlistentry>
1746
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the property's value, in the range <link linkend="0--CAPS"><literal>0</literal></link> to <link linkend="G-MAXINT--CAPS"><literal>G_MAXINT</literal></link>
1747
 
</simpara></listitem></varlistentry>
1748
 
</variablelist></refsect2>
1749
 
<refsect2 id="bacon-video-widget-set-video-property" role="function">
1750
 
<title>bacon_video_widget_set_video_property ()</title>
1751
 
<indexterm zone="bacon-video-widget-set-video-property"><primary>bacon_video_widget_set_video_property</primary></indexterm><programlisting><link linkend="void">void</link>                bacon_video_widget_set_video_property
1752
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1753
 
                                                         <link linkend="BvwVideoProperty">BvwVideoProperty</link> type,
1754
 
                                                         <link linkend="int">int</link> value);</programlisting>
1755
 
<para>
1756
 
Sets the given property of the video, such as its brightness or saturation.
1757
 
</para>
1758
 
<para>
1759
 
It should be given as a percentage in the full range of integer values; from <link linkend="0--CAPS"><literal>0</literal></link>
1760
 
to <link linkend="G-MAXINT--CAPS"><literal>G_MAXINT</literal></link>, where <link linkend="G-MAXINT--CAPS"><literal>G_MAXINT</literal></link>/2 is the default.</para>
1761
 
<para>
1762
 
</para><variablelist role="params">
1763
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1764
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1765
 
</simpara></listitem></varlistentry>
1766
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
1767
 
<listitem><simpara> the type of property
1768
 
</simpara></listitem></varlistentry>
1769
 
<varlistentry><term><parameter>value</parameter>&#160;:</term>
1770
 
<listitem><simpara> the property's value, in the range <link linkend="0--CAPS"><literal>0</literal></link> to <link linkend="G-MAXINT--CAPS"><literal>G_MAXINT</literal></link>
1771
 
</simpara></listitem></varlistentry>
1772
 
</variablelist></refsect2>
1773
 
<refsect2 id="bacon-video-widget-get-visuals-list" role="function">
1774
 
<title>bacon_video_widget_get_visuals_list ()</title>
1775
 
<indexterm zone="bacon-video-widget-get-visuals-list"><primary>bacon_video_widget_get_visuals_list</primary></indexterm><programlisting><link linkend="GList">GList</link> *             bacon_video_widget_get_visuals_list (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1776
 
<para>
1777
 
Returns a list of the visualisations available when playing audio-only streams.</para>
1778
 
<para>
1779
 
</para><variablelist role="params">
1780
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1781
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1782
 
</simpara></listitem></varlistentry>
1783
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GList"><type>GList</type></link> of visualisation names; owned by <parameter>bvw</parameter>
1784
 
</simpara></listitem></varlistentry>
1785
 
</variablelist></refsect2>
1786
 
<refsect2 id="bacon-video-widget-set-visuals" role="function">
1787
 
<title>bacon_video_widget_set_visuals ()</title>
1788
 
<indexterm zone="bacon-video-widget-set-visuals"><primary>bacon_video_widget_set_visuals</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            bacon_video_widget_set_visuals      (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1789
 
                                                         const <link linkend="char">char</link> *name);</programlisting>
1790
 
<para>
1791
 
Sets the visualisation to display when playing audio-only streams.
1792
 
</para>
1793
 
<para>
1794
 
If <parameter>name</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>, visualisations will be disabled. Otherwise, <parameter>name</parameter>
1795
 
should be from the list returned by <link linkend="bacon-video-widget-get-visuals-list"><function>bacon_video_widget_get_visuals_list()</function></link>.</para>
1796
 
<para>
1797
 
</para><variablelist role="params">
1798
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1799
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1800
 
</simpara></listitem></varlistentry>
1801
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
1802
 
<listitem><simpara> the visualisation's name, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1803
 
</simpara></listitem></varlistentry>
1804
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> on success, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1805
 
</simpara></listitem></varlistentry>
1806
 
</variablelist></refsect2>
1807
 
<refsect2 id="bacon-video-widget-set-visuals-quality" role="function">
1808
 
<title>bacon_video_widget_set_visuals_quality ()</title>
1809
 
<indexterm zone="bacon-video-widget-set-visuals-quality"><primary>bacon_video_widget_set_visuals_quality</primary></indexterm><programlisting><link linkend="void">void</link>                bacon_video_widget_set_visuals_quality
1810
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1811
 
                                                         <link linkend="BvwVisualsQuality">BvwVisualsQuality</link> quality);</programlisting>
1812
 
<para>
1813
 
Sets the quality/size of displayed visualisations.</para>
1814
 
<para>
1815
 
</para><variablelist role="params">
1816
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1817
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1818
 
</simpara></listitem></varlistentry>
1819
 
<varlistentry><term><parameter>quality</parameter>&#160;:</term>
1820
 
<listitem><simpara> the visualisation quality
1821
 
</simpara></listitem></varlistentry>
1822
 
</variablelist></refsect2>
1823
 
<refsect2 id="bacon-video-widget-get-volume" role="function">
1824
 
<title>bacon_video_widget_get_volume ()</title>
1825
 
<indexterm zone="bacon-video-widget-get-volume"><primary>bacon_video_widget_get_volume</primary></indexterm><programlisting><link linkend="double">double</link>              bacon_video_widget_get_volume       (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1826
 
<para>
1827
 
Returns the current volume level, as a percentage between <link linkend="0--CAPS"><literal>0</literal></link> and <link linkend="1--CAPS"><literal>1</literal></link>.</para>
1828
 
<para>
1829
 
</para><variablelist role="params">
1830
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1831
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1832
 
</simpara></listitem></varlistentry>
1833
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the volume as a percentage between <link linkend="0--CAPS"><literal>0</literal></link> and <link linkend="1--CAPS"><literal>1</literal></link>
1834
 
</simpara></listitem></varlistentry>
1835
 
</variablelist></refsect2>
1836
 
<refsect2 id="bacon-video-widget-set-volume" role="function">
1837
 
<title>bacon_video_widget_set_volume ()</title>
1838
 
<indexterm zone="bacon-video-widget-set-volume"><primary>bacon_video_widget_set_volume</primary></indexterm><programlisting><link linkend="void">void</link>                bacon_video_widget_set_volume       (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1839
 
                                                         <link linkend="double">double</link> volume);</programlisting>
1840
 
<para>
1841
 
Sets the volume level of the stream as a percentage between <link linkend="0--CAPS"><literal>0</literal></link> and <link linkend="1--CAPS"><literal>1</literal></link>.
1842
 
</para>
1843
 
<para>
1844
 
If <link linkend="bacon-video-widget-can-set-volume"><function>bacon_video_widget_can_set_volume()</function></link> returns <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>, this is a no-op.</para>
1845
 
<para>
1846
 
</para><variablelist role="params">
1847
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1848
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1849
 
</simpara></listitem></varlistentry>
1850
 
<varlistentry><term><parameter>volume</parameter>&#160;:</term>
1851
 
<listitem><simpara> the new volume level, as a percentage between <link linkend="0--CAPS"><literal>0</literal></link> and <link linkend="1--CAPS"><literal>1</literal></link>
1852
 
</simpara></listitem></varlistentry>
1853
 
</variablelist></refsect2>
1854
 
<refsect2 id="bacon-video-widget-get-zoom" role="function">
1855
 
<title>bacon_video_widget_get_zoom ()</title>
1856
 
<indexterm zone="bacon-video-widget-get-zoom"><primary>bacon_video_widget_get_zoom</primary></indexterm><programlisting><link linkend="double">double</link>              bacon_video_widget_get_zoom         (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1857
 
<para>
1858
 
Returns the zoom factor applied to videos displayed by the widget,
1859
 
as an integeric percentage between <link linkend="0--CAPS"><literal>0</literal></link> and <link linkend="1--CAPS"><literal>1</literal></link>
1860
 
(e.g. <link linkend="1--CAPS"><literal>1</literal></link> means no zooming at all).</para>
1861
 
<para>
1862
 
</para><variablelist role="params">
1863
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1864
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1865
 
</simpara></listitem></varlistentry>
1866
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the zoom factor
1867
 
</simpara></listitem></varlistentry>
1868
 
</variablelist></refsect2>
1869
 
<refsect2 id="bacon-video-widget-set-zoom" role="function">
1870
 
<title>bacon_video_widget_set_zoom ()</title>
1871
 
<indexterm zone="bacon-video-widget-set-zoom"><primary>bacon_video_widget_set_zoom</primary></indexterm><programlisting><link linkend="void">void</link>                bacon_video_widget_set_zoom         (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1872
 
                                                         <link linkend="double">double</link> zoom);</programlisting>
1873
 
<para>
1874
 
Sets the zoom factor applied to the video when it is displayed,
1875
 
as an integeric percentage between <link linkend="0--CAPS"><literal>0</literal></link> and <link linkend="1--CAPS"><literal>1</literal></link>
1876
 
(e.g. set <parameter>zoom</parameter> to <link linkend="1--CAPS"><literal>1</literal></link> to not zoom at all).</para>
1877
 
<para>
1878
 
</para><variablelist role="params">
1879
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1880
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1881
 
</simpara></listitem></varlistentry>
1882
 
<varlistentry><term><parameter>zoom</parameter>&#160;:</term>
1883
 
<listitem><simpara> a percentage zoom factor
1884
 
</simpara></listitem></varlistentry>
1885
 
</variablelist></refsect2>
1886
 
<refsect2 id="bacon-video-widget-has-next-track" role="function">
1887
 
<title>bacon_video_widget_has_next_track ()</title>
1888
 
<indexterm zone="bacon-video-widget-has-next-track"><primary>bacon_video_widget_has_next_track</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            bacon_video_widget_has_next_track   (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1889
 
<para>
1890
 
Determines whether there is another track after the current one, typically
1891
 
as a chapter on a DVD.</para>
1892
 
<para>
1893
 
</para><variablelist role="params">
1894
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1895
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1896
 
</simpara></listitem></varlistentry>
1897
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if there is another track, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1898
 
</simpara></listitem></varlistentry>
1899
 
</variablelist></refsect2>
1900
 
<refsect2 id="bacon-video-widget-has-previous-track" role="function">
1901
 
<title>bacon_video_widget_has_previous_track ()</title>
1902
 
<indexterm zone="bacon-video-widget-has-previous-track"><primary>bacon_video_widget_has_previous_track</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            bacon_video_widget_has_previous_track
1903
 
                                                        (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1904
 
<para>
1905
 
Determines whether there is another track before the current one, typically
1906
 
as a chapter on a DVD.</para>
1907
 
<para>
1908
 
</para><variablelist role="params">
1909
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1910
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1911
 
</simpara></listitem></varlistentry>
1912
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if there is another track, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1913
 
</simpara></listitem></varlistentry>
1914
 
</variablelist></refsect2>
1915
 
<refsect2 id="bacon-video-widget-is-playing" role="function">
1916
 
<title>bacon_video_widget_is_playing ()</title>
1917
 
<indexterm zone="bacon-video-widget-is-playing"><primary>bacon_video_widget_is_playing</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            bacon_video_widget_is_playing       (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1918
 
<para>
1919
 
Returns whether the widget is currently playing a stream.</para>
1920
 
<para>
1921
 
</para><variablelist role="params">
1922
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1923
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1924
 
</simpara></listitem></varlistentry>
1925
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if a stream is playing, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1926
 
</simpara></listitem></varlistentry>
1927
 
</variablelist></refsect2>
1928
 
<refsect2 id="bacon-video-widget-is-seekable" role="function">
1929
 
<title>bacon_video_widget_is_seekable ()</title>
1930
 
<indexterm zone="bacon-video-widget-is-seekable"><primary>bacon_video_widget_is_seekable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            bacon_video_widget_is_seekable      (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw);</programlisting>
1931
 
<para>
1932
 
Returns whether seeking is possible in the current stream.
1933
 
</para>
1934
 
<para>
1935
 
If no stream is loaded, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> is returned.</para>
1936
 
<para>
1937
 
</para><variablelist role="params">
1938
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1939
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1940
 
</simpara></listitem></varlistentry>
1941
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the stream is seekable, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1942
 
</simpara></listitem></varlistentry>
1943
 
</variablelist></refsect2>
1944
 
<refsect2 id="bacon-video-widget-step" role="function">
1945
 
<title>bacon_video_widget_step ()</title>
1946
 
<indexterm zone="bacon-video-widget-step"><primary>bacon_video_widget_step</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            bacon_video_widget_step             (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *bvw,
1947
 
                                                         <link linkend="gboolean">gboolean</link> forward,
1948
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
1949
 
<para>
1950
 
Step one frame forward, if <parameter>forward</parameter> is <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>, or backwards, if <parameter>forward</parameter> is <link linkend="FALSE--CAPS"><literal>FALSE</literal></link></para>
1951
 
<para>
1952
 
</para><variablelist role="params">
1953
 
<varlistentry><term><parameter>bvw</parameter>&#160;:</term>
1954
 
<listitem><simpara> a <link linkend="BaconVideoWidget"><type>BaconVideoWidget</type></link>
1955
 
</simpara></listitem></varlistentry>
1956
 
<varlistentry><term><parameter>forward</parameter>&#160;:</term>
1957
 
<listitem><simpara> the direction of the frame step
1958
 
</simpara></listitem></varlistentry>
1959
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1960
 
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1961
 
</simpara></listitem></varlistentry>
1962
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> on success, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1963
 
</simpara></listitem></varlistentry>
1964
 
</variablelist></refsect2>
1965
 
 
1966
 
</refsect1>
1967
 
<refsect1 id="BaconVideoWidget.property-details" role="property_details">
1968
 
<title role="property_details.title">Property Details</title>
1969
 
<refsect2 id="BaconVideoWidget--download-filename" role="property"><title>The <literal>&quot;download-filename&quot;</literal> property</title>
1970
 
<indexterm zone="BaconVideoWidget--download-filename"><primary>BaconVideoWidget:download-filename</primary></indexterm><programlisting>  &quot;download-filename&quot;        <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
1971
 
<para>
1972
 
The filename of the fully downloaded stream when using
1973
 
download buffering.</para>
1974
 
<para>
1975
 
</para><para>Default value: NULL</para>
1976
 
</refsect2>
1977
 
<refsect2 id="BaconVideoWidget--logo-mode" role="property"><title>The <literal>&quot;logo-mode&quot;</literal> property</title>
1978
 
<indexterm zone="BaconVideoWidget--logo-mode"><primary>BaconVideoWidget:logo-mode</primary></indexterm><programlisting>  &quot;logo-mode&quot;                <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
1979
 
<para>
1980
 
Whether the logo should be displayed when no stream is loaded, or the widget
1981
 
should take up no space.</para>
1982
 
<para>
1983
 
</para><para>Default value: FALSE</para>
1984
 
</refsect2>
1985
 
<refsect2 id="BaconVideoWidget--playing" role="property"><title>The <literal>&quot;playing&quot;</literal> property</title>
1986
 
<indexterm zone="BaconVideoWidget--playing"><primary>BaconVideoWidget:playing</primary></indexterm><programlisting>  &quot;playing&quot;                  <link linkend="gboolean">gboolean</link>              : Read</programlisting>
1987
 
<para>
1988
 
Whether a stream is currently playing.</para>
1989
 
<para>
1990
 
</para><para>Default value: FALSE</para>
1991
 
</refsect2>
1992
 
<refsect2 id="BaconVideoWidget--position" role="property"><title>The <literal>&quot;position&quot;</literal> property</title>
1993
 
<indexterm zone="BaconVideoWidget--position"><primary>BaconVideoWidget:position</primary></indexterm><programlisting>  &quot;position&quot;                 <link linkend="gdouble">gdouble</link>               : Read</programlisting>
1994
 
<para>
1995
 
The current position in the stream, as a percentage between <link linkend="0--CAPS"><literal>0</literal></link> and <link linkend="1--CAPS"><literal>1</literal></link>.</para>
1996
 
<para>
1997
 
</para><para>Allowed values: [0,1]</para>
1998
 
<para>Default value: 0</para>
1999
 
</refsect2>
2000
 
<refsect2 id="BaconVideoWidget--referrer" role="property"><title>The <literal>&quot;referrer&quot;</literal> property</title>
2001
 
<indexterm zone="BaconVideoWidget--referrer"><primary>BaconVideoWidget:referrer</primary></indexterm><programlisting>  &quot;referrer&quot;                 <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
2002
 
<para>
2003
 
The HTTP referrer URI.</para>
2004
 
<para>
2005
 
</para><para>Default value: NULL</para>
2006
 
</refsect2>
2007
 
<refsect2 id="BaconVideoWidget--seekable" role="property"><title>The <literal>&quot;seekable&quot;</literal> property</title>
2008
 
<indexterm zone="BaconVideoWidget--seekable"><primary>BaconVideoWidget:seekable</primary></indexterm><programlisting>  &quot;seekable&quot;                 <link linkend="gboolean">gboolean</link>              : Read</programlisting>
2009
 
<para>
2010
 
Whether the current stream can be seeked.</para>
2011
 
<para>
2012
 
</para><para>Default value: FALSE</para>
2013
 
</refsect2>
2014
 
<refsect2 id="BaconVideoWidget--show-cursor" role="property"><title>The <literal>&quot;show-cursor&quot;</literal> property</title>
2015
 
<indexterm zone="BaconVideoWidget--show-cursor"><primary>BaconVideoWidget:show-cursor</primary></indexterm><programlisting>  &quot;show-cursor&quot;              <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
2016
 
<para>
2017
 
Whether the cursor should be shown, or should be invisible, when it is over
2018
 
the video widget.</para>
2019
 
<para>
2020
 
</para><para>Default value: FALSE</para>
2021
 
</refsect2>
2022
 
<refsect2 id="BaconVideoWidget--show-visuals" role="property"><title>The <literal>&quot;show-visuals&quot;</literal> property</title>
2023
 
<indexterm zone="BaconVideoWidget--show-visuals"><primary>BaconVideoWidget:show-visuals</primary></indexterm><programlisting>  &quot;show-visuals&quot;             <link linkend="gboolean">gboolean</link>              : Write</programlisting>
2024
 
<para>
2025
 
Whether visualisations should be shown for audio-only streams.</para>
2026
 
<para>
2027
 
</para><para>Default value: FALSE</para>
2028
 
</refsect2>
2029
 
<refsect2 id="BaconVideoWidget--stream-length" role="property"><title>The <literal>&quot;stream-length&quot;</literal> property</title>
2030
 
<indexterm zone="BaconVideoWidget--stream-length"><primary>BaconVideoWidget:stream-length</primary></indexterm><programlisting>  &quot;stream-length&quot;            <link linkend="gint64">gint64</link>                : Read</programlisting>
2031
 
<para>
2032
 
The length of the current stream, in milliseconds.</para>
2033
 
<para>
2034
 
</para><para>Allowed values: &gt;= 0</para>
2035
 
<para>Default value: 0</para>
2036
 
</refsect2>
2037
 
<refsect2 id="BaconVideoWidget--user-agent" role="property"><title>The <literal>&quot;user-agent&quot;</literal> property</title>
2038
 
<indexterm zone="BaconVideoWidget--user-agent"><primary>BaconVideoWidget:user-agent</primary></indexterm><programlisting>  &quot;user-agent&quot;               <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
2039
 
<para>
2040
 
The HTTP user agent string to use.</para>
2041
 
<para>
2042
 
</para><para>Default value: NULL</para>
2043
 
</refsect2>
2044
 
<refsect2 id="BaconVideoWidget--volume" role="property"><title>The <literal>&quot;volume&quot;</literal> property</title>
2045
 
<indexterm zone="BaconVideoWidget--volume"><primary>BaconVideoWidget:volume</primary></indexterm><programlisting>  &quot;volume&quot;                   <link linkend="gdouble">gdouble</link>               : Read / Write</programlisting>
2046
 
<para>
2047
 
The current volume level, as a percentage between <link linkend="0--CAPS"><literal>0</literal></link> and <link linkend="1--CAPS"><literal>1</literal></link>.</para>
2048
 
<para>
2049
 
</para><para>Allowed values: [0,1]</para>
2050
 
<para>Default value: 0</para>
2051
 
</refsect2>
2052
 
</refsect1>
2053
 
 
2054
 
<refsect1 id="BaconVideoWidget.signal-details" role="signals">
2055
 
<title role="signals.title">Signal Details</title>
2056
 
<refsect2 id="BaconVideoWidget-buffering" role="signal"><title>The <literal>&quot;buffering&quot;</literal> signal</title>
2057
 
<indexterm zone="BaconVideoWidget-buffering"><primary>BaconVideoWidget::buffering</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *percentage,
2058
 
                                                        <link linkend="gint">gint</link>              arg1,
2059
 
                                                        <link linkend="gpointer">gpointer</link>          user_data)       : Run Last</programlisting>
2060
 
<para>
2061
 
Emitted regularly when a network stream is being buffered, to provide status updates on the buffering
2062
 
progress.</para>
2063
 
<para>
2064
 
</para><variablelist role="params">
2065
 
<varlistentry><term><parameter>percentage</parameter>&#160;:</term>
2066
 
<listitem><simpara> the percentage of buffering completed, between <link linkend="0--CAPS"><literal>0</literal></link> and <link linkend="1--CAPS"><literal>1</literal></link>
2067
 
</simpara></listitem></varlistentry>
2068
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
2069
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
2070
 
</variablelist></refsect2><refsect2 id="BaconVideoWidget-channels-change" role="signal"><title>The <literal>&quot;channels-change&quot;</literal> signal</title>
2071
 
<indexterm zone="BaconVideoWidget-channels-change"><primary>BaconVideoWidget::channels-change</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *arg0,
2072
 
                                                        <link linkend="gpointer">gpointer</link>          user_data)      : Run Last</programlisting>
2073
 
<para>
2074
 
Emitted when the number of audio languages available changes, or when the
2075
 
selected audio language is changed.
2076
 
</para>
2077
 
<para>
2078
 
Query the new list of audio languages with <link linkend="bacon-video-widget-get-languages"><function>bacon_video_widget_get_languages()</function></link>.</para>
2079
 
<para>
2080
 
</para><variablelist role="params">
2081
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
2082
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
2083
 
</variablelist></refsect2><refsect2 id="BaconVideoWidget-download-buffering" role="signal"><title>The <literal>&quot;download-buffering&quot;</literal> signal</title>
2084
 
<indexterm zone="BaconVideoWidget-download-buffering"><primary>BaconVideoWidget::download-buffering</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *percentage,
2085
 
                                                        <link linkend="gdouble">gdouble</link>           arg1,
2086
 
                                                        <link linkend="gpointer">gpointer</link>          user_data)       : Run Last</programlisting>
2087
 
<para>
2088
 
Emitted regularly when a network stream is being cached on disk, to provide status
2089
 
 updates on the buffering level of the stream.</para>
2090
 
<para>
2091
 
</para><variablelist role="params">
2092
 
<varlistentry><term><parameter>percentage</parameter>&#160;:</term>
2093
 
<listitem><simpara> the percentage of download buffering completed, between <link linkend="0--CAPS"><literal>0</literal></link> and <link linkend="1--CAPS"><literal>1</literal></link>
2094
 
</simpara></listitem></varlistentry>
2095
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
2096
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
2097
 
</variablelist></refsect2><refsect2 id="BaconVideoWidget-eos" role="signal"><title>The <literal>&quot;eos&quot;</literal> signal</title>
2098
 
<indexterm zone="BaconVideoWidget-eos"><primary>BaconVideoWidget::eos</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *arg0,
2099
 
                                                        <link linkend="gpointer">gpointer</link>          user_data)      : Run Last</programlisting>
2100
 
<para>
2101
 
Emitted when the end of the current stream is reached.</para>
2102
 
<para>
2103
 
</para><variablelist role="params">
2104
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
2105
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
2106
 
</variablelist></refsect2><refsect2 id="BaconVideoWidget-error" role="signal"><title>The <literal>&quot;error&quot;</literal> signal</title>
2107
 
<indexterm zone="BaconVideoWidget-error"><primary>BaconVideoWidget::error</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *message,
2108
 
                                                        <link linkend="gchar">gchar</link>            *playback_stopped,
2109
 
                                                        <link linkend="gboolean">gboolean</link>          fatal,
2110
 
                                                        <link linkend="gboolean">gboolean</link>          arg3,
2111
 
                                                        <link linkend="gpointer">gpointer</link>          user_data)             : Run Last</programlisting>
2112
 
<para>
2113
 
Emitted when the backend wishes to asynchronously report an error. If <parameter>fatal</parameter> is <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>,
2114
 
playback of this stream cannot be restarted.</para>
2115
 
<para>
2116
 
</para><variablelist role="params">
2117
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
2118
 
<listitem><simpara> the error message
2119
 
</simpara></listitem></varlistentry>
2120
 
<varlistentry><term><parameter>playback_stopped</parameter>&#160;:</term>
2121
 
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if playback has stopped due to the error, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
2122
 
</simpara></listitem></varlistentry>
2123
 
<varlistentry><term><parameter>fatal</parameter>&#160;:</term>
2124
 
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the error was fatal to playback, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
2125
 
</simpara></listitem></varlistentry>
2126
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
2127
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
2128
 
</variablelist></refsect2><refsect2 id="BaconVideoWidget-got-metadata" role="signal"><title>The <literal>&quot;got-metadata&quot;</literal> signal</title>
2129
 
<indexterm zone="BaconVideoWidget-got-metadata"><primary>BaconVideoWidget::got-metadata</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *arg0,
2130
 
                                                        <link linkend="gpointer">gpointer</link>          user_data)      : Run Last</programlisting>
2131
 
<para>
2132
 
Emitted when the widget has updated the metadata of the current stream. This
2133
 
will typically happen just after opening a stream.
2134
 
</para>
2135
 
<para>
2136
 
Call <link linkend="bacon-video-widget-get-metadata"><function>bacon_video_widget_get_metadata()</function></link> to query the updated metadata.</para>
2137
 
<para>
2138
 
</para><variablelist role="params">
2139
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
2140
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
2141
 
</variablelist></refsect2><refsect2 id="BaconVideoWidget-got-redirect" role="signal"><title>The <literal>&quot;got-redirect&quot;</literal> signal</title>
2142
 
<indexterm zone="BaconVideoWidget-got-redirect"><primary>BaconVideoWidget::got-redirect</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *new_mrl,
2143
 
                                                        <link linkend="gchar">gchar</link>            *arg1,
2144
 
                                                        <link linkend="gpointer">gpointer</link>          user_data)      : Run Last</programlisting>
2145
 
<para>
2146
 
Emitted when a redirect response is received from a stream's server.</para>
2147
 
<para>
2148
 
</para><variablelist role="params">
2149
 
<varlistentry><term><parameter>new_mrl</parameter>&#160;:</term>
2150
 
<listitem><simpara> the new MRL
2151
 
</simpara></listitem></varlistentry>
2152
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
2153
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
2154
 
</variablelist></refsect2><refsect2 id="BaconVideoWidget-missing-plugins" role="signal"><title>The <literal>&quot;missing-plugins&quot;</literal> signal</title>
2155
 
<indexterm zone="BaconVideoWidget-missing-plugins"><primary>BaconVideoWidget::missing-plugins</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            user_function                      (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *details,
2156
 
                                                        <link linkend="GStrv">GStrv</link>            *descriptions,
2157
 
                                                        <link linkend="GStrv">GStrv</link>            *playing,
2158
 
                                                        <link linkend="gboolean">gboolean</link>          Returns,
2159
 
                                                        <link linkend="gpointer">gpointer</link>          user_data)         : Run Last</programlisting>
2160
 
<para>
2161
 
Emitted when plugins required to play the current stream are not found. This allows the application
2162
 
to request the user install them before proceeding to try and play the stream again.
2163
 
</para>
2164
 
<para>
2165
 
Note that this signal is only available for the GStreamer backend.</para>
2166
 
<para>
2167
 
</para><variablelist role="params">
2168
 
<varlistentry><term><parameter>details</parameter>&#160;:</term>
2169
 
<listitem><simpara> a <link linkend="NULL--CAPS"><literal>NULL</literal></link>-terminated array of missing plugin details for use when installing the plugins with libgimme-codec
2170
 
</simpara></listitem></varlistentry>
2171
 
<varlistentry><term><parameter>descriptions</parameter>&#160;:</term>
2172
 
<listitem><simpara> a <link linkend="NULL--CAPS"><literal>NULL</literal></link>-terminated array of missing plugin descriptions for display to the user
2173
 
</simpara></listitem></varlistentry>
2174
 
<varlistentry><term><parameter>playing</parameter>&#160;:</term>
2175
 
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the stream could be played even without these plugins, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
2176
 
</simpara></listitem></varlistentry>
2177
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
2178
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
2179
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the signal was handled and some action was taken, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
2180
 
</simpara></listitem></varlistentry>
2181
 
</variablelist></refsect2><refsect2 id="BaconVideoWidget-tick" role="signal"><title>The <literal>&quot;tick&quot;</literal> signal</title>
2182
 
<indexterm zone="BaconVideoWidget-tick"><primary>BaconVideoWidget::tick</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="BaconVideoWidget">BaconVideoWidget</link> *current_time,
2183
 
                                                        <link linkend="gint64">gint64</link>            stream_length,
2184
 
                                                        <link linkend="gint64">gint64</link>            current_position,
2185
 
                                                        <link linkend="gdouble">gdouble</link>           seekable,
2186
 
                                                        <link linkend="gboolean">gboolean</link>          arg4,
2187
 
                                                        <link linkend="gpointer">gpointer</link>          user_data)             : Run Last</programlisting>
2188
 
<para>
2189
 
Emitted every time an important time event happens, or at regular intervals when playing a stream.</para>
2190
 
<para>
2191
 
</para><variablelist role="params">
2192
 
<varlistentry><term><parameter>current_time</parameter>&#160;:</term>
2193
 
<listitem><simpara> the current position in the stream, in milliseconds since the beginning of the stream
2194
 
</simpara></listitem></varlistentry>
2195
 
<varlistentry><term><parameter>stream_length</parameter>&#160;:</term>
2196
 
<listitem><simpara> the length of the stream, in milliseconds
2197
 
</simpara></listitem></varlistentry>
2198
 
<varlistentry><term><parameter>current_position</parameter>&#160;:</term>
2199
 
<listitem><simpara> the current position in the stream, as a percentage between <link linkend="0--CAPS"><literal>0</literal></link> and <link linkend="1--CAPS"><literal>1</literal></link>
2200
 
</simpara></listitem></varlistentry>
2201
 
<varlistentry><term><parameter>seekable</parameter>&#160;:</term>
2202
 
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the stream can be seeked, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
2203
 
</simpara></listitem></varlistentry>
2204
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
2205
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
2206
 
</variablelist></refsect2>
2207
 
</refsect1>
2208
 
 
2209
 
 
2210
 
 
2211
 
</refentry>