bacon_video_widget_new ()

GtkWidget *
bacon_video_widget_new (GError **error);

Creates a new BaconVideoWidget.

A BvwError will be returned on error.

bacon_video_widget_open ()

void
bacon_video_widget_open (BaconVideoWidget *bvw,
                         const char *mrl);

Opens the given mrl in bvw for playing.

The MRL is loaded and waiting to be played with bacon_video_widget_play().

bacon_video_widget_play ()

gboolean
bacon_video_widget_play (BaconVideoWidget *bvw,
                         GError **error);

Plays the currently-loaded video in bvw .

Errors from the GStreamer backend will be returned asynchronously via the “error” signal, even if this function returns TRUE.

bacon_video_widget_pause ()

void
bacon_video_widget_pause (BaconVideoWidget *bvw);

Pauses the current stream in the video widget.

If a live stream is being played, playback is stopped entirely.

bacon_video_widget_seek ()

gboolean
bacon_video_widget_seek (BaconVideoWidget *bvw,
                         double position,
                         GError **error);

Seeks the currently-playing stream to position as a percentage of the total stream length.

bacon_video_widget_seek_time ()

gboolean
bacon_video_widget_seek_time (BaconVideoWidget *bvw,
                              gint64 _time,
                              gboolean accurate,
                              GError **error);

Seeks the currently-playing stream to the absolute position time , in milliseconds.

bacon_video_widget_stop ()

void
bacon_video_widget_stop (BaconVideoWidget *bvw);

Stops playing the current stream and resets to the first position in the stream.

bacon_video_widget_close ()

void
bacon_video_widget_close (BaconVideoWidget *bvw);

Closes the current stream and frees the resources associated with it.

bacon_video_widget_can_direct_seek ()

gboolean
bacon_video_widget_can_direct_seek (BaconVideoWidget *bvw);

Determines whether direct seeking is possible for the current stream.

bacon_video_widget_can_get_frames ()

gboolean
bacon_video_widget_can_get_frames (BaconVideoWidget *bvw,
                                   GError **error);

Determines whether individual frames from the current stream can be returned using bacon_video_widget_get_current_frame().

Frames cannot be returned for audio-only streams, unless visualisations are enabled.

bacon_video_widget_can_set_volume ()

gboolean
bacon_video_widget_can_set_volume (BaconVideoWidget *bvw);

Returns whether the volume level can be set, given the current settings.

The volume cannot be set if the audio output type is set to BVW_AUDIO_SOUND_AC3PASSTHRU.

bacon_video_widget_dvd_event ()

void
bacon_video_widget_dvd_event (BaconVideoWidget *bvw,
                              BvwDVDEvent type);

Issues a DVD navigation event to the video widget, such as one to skip to the next chapter, or navigate to the DVD title menu.

This is a no-op if the current stream is not navigable.

bacon_video_widget_has_menus ()

gboolean
bacon_video_widget_has_menus (BaconVideoWidget *bvw);

Returns whether the widget is currently displaying a menu, such as a DVD menu.

bacon_video_widget_get_aspect_ratio ()

BvwAspectRatio
bacon_video_widget_get_aspect_ratio (BaconVideoWidget *bvw);

Returns the current aspect ratio used by the widget, from BvwAspectRatio.

bacon_video_widget_set_aspect_ratio ()

void
bacon_video_widget_set_aspect_ratio (BaconVideoWidget *bvw,
                                     BvwAspectRatio ratio);

Sets the aspect ratio used by the widget, from BvwAspectRatio.

Changes to this take effect immediately.

bacon_video_widget_get_audio_output_type ()

BvwAudioOutputType
bacon_video_widget_get_audio_output_type
                               (BaconVideoWidget *bvw);

Returns the current audio output type (e.g. how many speaker channels) from BvwAudioOutputType.

bacon_video_widget_set_audio_output_type ()

void
bacon_video_widget_set_audio_output_type
                               (BaconVideoWidget *bvw,
                                BvwAudioOutputType type);

Sets the audio output type (number of speaker channels) in the video widget.

bacon_video_widget_get_current_frame ()

GdkPixbuf *
bacon_video_widget_get_current_frame (BaconVideoWidget *bvw);

Returns a GdkPixbuf containing the current frame from the playing stream. This will wait for any pending seeks to complete before capturing the frame.

bacon_video_widget_get_current_time ()

gint64
bacon_video_widget_get_current_time (BaconVideoWidget *bvw);

Returns the current position in the stream, as the time (in milliseconds) since the beginning of the stream.

bacon_video_widget_get_deinterlacing ()

gboolean
bacon_video_widget_get_deinterlacing (BaconVideoWidget *bvw);

Returns whether deinterlacing of videos is enabled for this widget.

bacon_video_widget_set_deinterlacing ()

void
bacon_video_widget_set_deinterlacing (BaconVideoWidget *bvw,
                                      gboolean deinterlace);

Sets whether the widget should deinterlace videos.

bacon_video_widget_get_languages ()

GList *
bacon_video_widget_get_languages (BaconVideoWidget *bvw);

Returns a list of BvwLangInfo for each audio track.

bacon_video_widget_lang_info_free ()

void
bacon_video_widget_lang_info_free (BvwLangInfo *info);

bacon_video_widget_get_language ()

int
bacon_video_widget_get_language (BaconVideoWidget *bvw);

Returns the index of the current audio language.

If the widget is not playing, or the default language is in use, -1 will be returned.

bacon_video_widget_set_language ()

void
bacon_video_widget_set_language (BaconVideoWidget *bvw,
                                 int language);

Sets the audio language index for bvw . If language is -1, the default language will be used.

bacon_video_widget_set_logo ()

void
bacon_video_widget_set_logo (BaconVideoWidget *bvw,
                             const char *name);

Sets the logo displayed on the video widget when no stream is loaded.

bacon_video_widget_get_logo_mode ()

gboolean
bacon_video_widget_get_logo_mode (BaconVideoWidget *bvw);

Gets whether the logo is displayed when no stream is loaded.

bacon_video_widget_set_logo_mode ()

void
bacon_video_widget_set_logo_mode (BaconVideoWidget *bvw,
                                  gboolean logo_mode);

Sets whether to display a logo set with bacon_video_widget_set_logo when no stream is loaded. If logo_mode is FALSE, nothing will be displayed and the video widget will take up no space. Otherwise, the logo will be displayed and will requisition a corresponding amount of space.

bacon_video_widget_get_metadata ()

void
bacon_video_widget_get_metadata (BaconVideoWidget *bvw,
                                 BvwMetadataType type,
                                 GValue *value);

Provides metadata of the given type about the current stream in value .

Free the GValue with g_value_unset().

bacon_video_widget_get_option_group ()

GOptionGroup *
bacon_video_widget_get_option_group (void);

Returns the GOptionGroup containing command-line options for BaconVideoWidget.

Applications must call either this exactly once.

bacon_video_widget_get_position ()

double
bacon_video_widget_get_position (BaconVideoWidget *bvw);

Returns the current position in the stream, as a value between

bacon_video_widget_set_referrer ()

void
bacon_video_widget_set_referrer (BaconVideoWidget *bvw,
                                 const char *referrer);

Sets the HTTP referrer URI to use when fetching HTTP ressources.

bacon_video_widget_get_rotation ()

BvwRotation
bacon_video_widget_get_rotation (BaconVideoWidget *bvw);

Returns the angle of rotation of the video, in degrees.

bacon_video_widget_set_rotation ()

void
bacon_video_widget_set_rotation (BaconVideoWidget *bvw,
                                 BvwRotation rotation);

Sets the rotation to be applied to the video when it is displayed.

bacon_video_widget_get_stream_length ()

gint64
bacon_video_widget_get_stream_length (BaconVideoWidget *bvw);

Returns the total length of the stream, in milliseconds.

bacon_video_widget_get_subtitles ()

GList *
bacon_video_widget_get_subtitles (BaconVideoWidget *bvw);

Returns a list of BvwLangInfo for each subtitle track.

bacon_video_widget_get_subtitle ()

int
bacon_video_widget_get_subtitle (BaconVideoWidget *bvw);

Returns the index of the current subtitles.

If the widget is not playing, -2 will be returned. If no subtitles are being used, -1 is returned.

bacon_video_widget_set_subtitle ()

void
bacon_video_widget_set_subtitle (BaconVideoWidget *bvw,
                                 int subtitle);

Sets the subtitle index for bvw . If subtitle is -1, no subtitles will be used.

bacon_video_widget_set_text_subtitle ()

void
bacon_video_widget_set_text_subtitle (BaconVideoWidget *bvw,
                                      const gchar *subtitle_uri);

Sets the URI for the text subtitle file to be displayed alongside the current video. Use NULL if you want to unload the current text subtitle file being used.

bacon_video_widget_set_subtitle_encoding ()

void
bacon_video_widget_set_subtitle_encoding
                               (BaconVideoWidget *bvw,
                                const char *encoding);

Sets the encoding system for the subtitles, so that they can be decoded properly.

bacon_video_widget_set_subtitle_font ()

void
bacon_video_widget_set_subtitle_font (BaconVideoWidget *bvw,
                                      const char *font);

Sets the font size and style in which to display subtitles.

font is a Pango font description string, as understood by pango_font_description_from_string().

bacon_video_widget_set_user_agent ()

void
bacon_video_widget_set_user_agent (BaconVideoWidget *bvw,
                                   const char *user_agent);

Sets the HTTP user agent string to use when fetching HTTP ressources.

bacon_video_widget_get_video_property ()

int
bacon_video_widget_get_video_property (BaconVideoWidget *bvw,
                                       BvwVideoProperty type);

Returns the given property of the video display, such as its brightness or saturation.

It is returned as a percentage in the full range of integer values; from 0 to 65535 (inclusive), where 32768 is the default.

bacon_video_widget_set_video_property ()

void
bacon_video_widget_set_video_property (BaconVideoWidget *bvw,
                                       BvwVideoProperty type,
                                       int value);

Sets the given property of the video display, such as its brightness or saturation.

It should be given as a percentage in the full range of integer values; from 0 to 65535 (inclusive), where 32768 is the default.

bacon_video_widget_get_volume ()

double
bacon_video_widget_get_volume (BaconVideoWidget *bvw);

Returns the current volume level, as a percentage between 0 and 1.

bacon_video_widget_set_volume ()

void
bacon_video_widget_set_volume (BaconVideoWidget *bvw,
                               double volume);

Sets the volume level of the stream as a percentage between 0 and 1.

If bacon_video_widget_can_set_volume() returns FALSE, this is a no-op.

bacon_video_widget_get_zoom ()

BvwZoomMode
bacon_video_widget_get_zoom (BaconVideoWidget *bvw);

Returns the zoom mode applied to videos displayed by the widget.

bacon_video_widget_set_zoom ()

void
bacon_video_widget_set_zoom (BaconVideoWidget *bvw,
                             BvwZoomMode mode);

Sets the zoom type applied to the video when it is displayed.

bacon_video_widget_has_angles ()

gboolean
bacon_video_widget_has_angles (BaconVideoWidget *bvw);

Returns whether the widget is currently playing a stream with multiple angles.

bacon_video_widget_set_next_angle ()

void
bacon_video_widget_set_next_angle (BaconVideoWidget *bvw);

Select the next angle, or video track in the playing stream.

bacon_video_widget_has_next_track ()

gboolean
bacon_video_widget_has_next_track (BaconVideoWidget *bvw);

Determines whether there is another track after the current one, typically as a chapter on a DVD.

bacon_video_widget_has_previous_track ()

gboolean
bacon_video_widget_has_previous_track (BaconVideoWidget *bvw);

Determines whether there is another track before the current one, typically as a chapter on a DVD.

bacon_video_widget_is_playing ()

gboolean
bacon_video_widget_is_playing (BaconVideoWidget *bvw);

Returns whether the widget is currently playing a stream.

bacon_video_widget_is_seekable ()

gboolean
bacon_video_widget_is_seekable (BaconVideoWidget *bvw);

Returns whether seeking is possible in the current stream.

If no stream is loaded, FALSE is returned.

bacon_video_widget_get_rate ()

gfloat
bacon_video_widget_get_rate (BaconVideoWidget *bvw);

Get the current playback rate, with 1.0 being normal rate.

bacon_video_widget_set_rate ()

gboolean
bacon_video_widget_set_rate (BaconVideoWidget *bvw,
                             gfloat new_rate);

Sets the current playback rate.

bacon_video_widget_step ()

gboolean
bacon_video_widget_step (BaconVideoWidget *bvw,
                         gboolean forward,
                         GError **error);

Step one frame forward, if forward is TRUE, or backwards, if forward is FALSE

bacon_video_widget_get_controls_object ()

GObject *
bacon_video_widget_get_controls_object
                               (BaconVideoWidget *bvw);

Get the widget which displays the video controls.

Since: 3.12

bacon_video_widget_get_header_controls_object ()

GObject *
bacon_video_widget_get_header_controls_object
                               (BaconVideoWidget *bvw);

Get the widget which displays the video header controls.

Since: 3.20

bacon_video_widget_set_fullscreen ()

void
bacon_video_widget_set_fullscreen (BaconVideoWidget *bvw,
                                   gboolean fullscreen);

Sets the fullscreen state, enabling a toplevel header bar sliding from the top of the video widget.

bacon_video_widget_set_next_language ()

void
bacon_video_widget_set_next_language (BaconVideoWidget *bvw);

Switch to the next audio language index for the current video. See bacon_video_widget_set_language().

Since: 3.12

bacon_video_widget_set_next_subtitle ()

void
bacon_video_widget_set_next_subtitle (BaconVideoWidget *bvw);

Switch to the next text subtitle index for the current video. See bacon_video_widget_set_subtitle().

Since: 3.12

bacon_video_widget_show_popup ()

void
bacon_video_widget_show_popup (BaconVideoWidget *bvw);

Show the video controls popup, and schedule for it to be hidden again after a timeout.

Since: 3.12

bacon_video_widget_mark_popup_busy ()

void
bacon_video_widget_mark_popup_busy (BaconVideoWidget *bvw,
                                    const char *reason);

Mark the video controls popup as busy, for the given reason . Use bacon_video_widget_unmark_popup_busy() to undo.

Since: 3.12

bacon_video_widget_unmark_popup_busy ()

void
bacon_video_widget_unmark_popup_busy (BaconVideoWidget *bvw,
                                      const char *reason);

Unmark the video controls popup as busy, for the given reason . The popup must previously have been marked as busy using bacon_video_widget_mark_popup_busy().

Since: 3.12

BaconVideoWidget

typedef struct _BaconVideoWidget BaconVideoWidget;

All the fields in the BaconVideoWidget structure are private and should never be accessed directly.

BaconVideoWidgetClass

typedef struct {
} BaconVideoWidgetClass;

All the fields in the BaconVideoWidgetClass structure are private and should never be accessed directly.

enum BvwAspectRatio

The pixel aspect ratios available in which to display videos using bacon_video_widget_set_aspect_ratio() .

enum BvwAudioOutputType

The audio output types available for use with bacon_video_widget_set_audio_output_type().

enum BvwDVDEvent

The DVD navigation actions available to fire as DVD events to the BaconVideoWidget.

BvwLangInfo

typedef struct {
	char *language;
	char *codec;
} BvwLangInfo;

BvwLangInfo holds the language code and codec for each subtitle or audio track for a media, which would allow the front-ends to present appropriate information to the user.

enum BvwMetadataType

The different metadata available for querying from a BaconVideoWidget stream with bacon_video_widget_get_metadata().

enum BvwRotation

The rotation is used by the video widget, as set by bacon_video_widget_set_rotation().

enum BvwTrackType

A type of media track.

enum BvwVideoProperty

The video properties queryable with bacon_video_widget_get_video_property(), and settable with bacon_video_widget_set_video_property().

enum BvwZoomMode

The zoom mode used by the video widget, as set by bacon_video_widget_set_zoom().

enum BvwError

Error codes for BaconVideoWidget operations.

The “audio-output-type” property

  “audio-output-type”        BvwAudioOutputType

The type of audio output to use (e.g. the number of channels).

Owner: BaconVideoWidget

Flags: Read / Write

Default value: BVW_AUDIO_SOUND_STEREO

The “av-offset” property

  “av-offset”                gint64

Control the synchronisation offset between the audio and video streams. Positive values make the audio ahead of the video and negative values make the audio go behind the video.

Owner: BaconVideoWidget

Flags: Read / Write

Default value: 0

The “brightness” property

  “brightness”               gint

The brightness of the video display.

Owner: BaconVideoWidget

Flags: Read / Write

Allowed values: [0,65535]

Default value: 32768

The “contrast” property

  “contrast”                 gint

The contrast of the video display.

Owner: BaconVideoWidget

Flags: Read / Write

Allowed values: [0,65535]

Default value: 32768

The “deinterlacing” property

  “deinterlacing”            gboolean

Whether to automatically deinterlace videos.

Owner: BaconVideoWidget

Flags: Read / Write

Default value: FALSE

The “download-filename” property

  “download-filename”        gchar *

The filename of the fully downloaded stream when using download buffering.

Owner: BaconVideoWidget

Flags: Read / Write

Default value: NULL

The “hue” property

  “hue”                      gint

The hue of the video display.

Owner: BaconVideoWidget

Flags: Read / Write

Allowed values: [0,65535]

Default value: 32768

The “logo-mode” property

  “logo-mode”                gboolean

Whether the logo should be displayed when no stream is loaded, or the widget should take up no space.

Owner: BaconVideoWidget

Flags: Read / Write

Default value: FALSE

The “playing” property

  “playing”                  gboolean

Whether a stream is currently playing.

Owner: BaconVideoWidget

Flags: Read

Default value: FALSE

The “position” property

  “position”                 gdouble

The current position in the stream, as a percentage between 0 and 1.

Owner: BaconVideoWidget

Flags: Read

Allowed values: [0,1]

Default value: 0

The “referrer” property

  “referrer”                 gchar *

The HTTP referrer URI.

Owner: BaconVideoWidget

Flags: Read / Write

Default value: NULL

The “reveal-controls” property

  “reveal-controls”          gboolean

Whether to show or hide the controls.

Owner: BaconVideoWidget

Flags: Read

Default value: FALSE

The “saturation” property

  “saturation”               gint

The saturation of the video display.

Owner: BaconVideoWidget

Flags: Read / Write

Allowed values: [0,65535]

Default value: 32768

The “seekable” property

  “seekable”                 gboolean

Whether the current stream can be seeked.

Owner: BaconVideoWidget

Flags: Read

Default value: FALSE

The “stream-length” property

  “stream-length”            gint64

The length of the current stream, in milliseconds.

Owner: BaconVideoWidget

Flags: Read

Allowed values: >= 0

Default value: 0

The “user-agent” property

  “user-agent”               gchar *

The HTTP user agent string to use.

Owner: BaconVideoWidget

Flags: Read / Write

Default value: NULL

The “volume” property

  “volume”                   gdouble

The current volume level, as a percentage between 0 and 1.

Owner: BaconVideoWidget

Flags: Read / Write

Allowed values: [0,1]

Default value: 0

The “buffering” signal

void
user_function (BaconVideoWidget *bvw,
               gdouble           percentage,
               gpointer          user_data)

Emitted regularly when a network stream is being buffered, to provide status updates on the buffering progress.

Flags: Run Last

The “channels-change” signal

void
user_function (BaconVideoWidget *bvw,
               gpointer          user_data)

Emitted when the number of audio languages available changes, or when the selected audio language is changed.

Query the new list of audio languages with bacon_video_widget_get_languages().

Flags: Run Last

The “download-buffering” signal

void
user_function (BaconVideoWidget *bvw,
               gdouble           percentage,
               gpointer          user_data)

Emitted regularly when a network stream is being cached on disk, to provide status updates on the buffering level of the stream.

Flags: Run Last

The “eos” signal

void
user_function (BaconVideoWidget *bvw,
               gpointer          user_data)

Emitted when the end of the current stream is reached.

Flags: Run Last

The “error” signal

void
user_function (BaconVideoWidget *bvw,
               gchar            *message,
               gboolean          playback_stopped,
               gpointer          user_data)

Emitted when the backend wishes to asynchronously report an error. If fatal is TRUE, playback of this stream cannot be restarted.

Flags: Run Last

The “got-metadata” signal

void
user_function (BaconVideoWidget *bvw,
               gpointer          user_data)

Emitted when the widget has updated the metadata of the current stream. This will typically happen just after opening a stream.

Call bacon_video_widget_get_metadata() to query the updated metadata.

Flags: Run Last

The “got-redirect” signal

void
user_function (BaconVideoWidget *bvw,
               gchar            *new_mrl,
               gpointer          user_data)

Emitted when a redirect response is received from a stream's server.

Flags: Run Last

The “missing-plugins” signal

gboolean
user_function (BaconVideoWidget *bvw,
               GStrv             details,
               GStrv             descriptions,
               gboolean          playing,
               gpointer          user_data)

Emitted when plugins required to play the current stream are not found. This allows the application to request the user install them before proceeding to try and play the stream again.

Note that this signal is only available for the GStreamer backend.

Flags: Run Last

The “seek-requested” signal

void
user_function (BaconVideoWidget *bvw,
               gboolean          forward,
               gpointer          user_data)

Emitted when a gesture, our mouse movement that should seek is made.

Flags: Run Last

The “tick” signal

void
user_function (BaconVideoWidget *bvw,
               gint64            current_time,
               gint64            stream_length,
               gdouble           current_position,
               gboolean          seekable,
               gpointer          user_data)

Emitted every time an important time event happens, or at regular intervals when playing a stream.

Flags: Run Last

The “track-skip-requested” signal

void
user_function (BaconVideoWidget *bvw,
               gboolean          forward,
               gpointer          user_data)

Emitted when a gesture, our mouse movement that should seek is made.

Flags: Run Last

The “volume-change-requested” signal

void
user_function (BaconVideoWidget *bvw,
               gboolean          increase,
               gpointer          user_data)

Emitted when a gesture, our mouse movement that should change the volume is emitted.

Flags: Run Last