![]() |
![]() |
![]() |
Totem Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties | Signals |
#include <bacon-video-widget.h> BaconVideoWidget; BaconVideoWidgetClass; enum BvwAspectRatio; enum BvwAudioOutType; enum BvwDVDEvent; enum BvwMetadataType; enum BvwVisualsQuality; enum BvwVideoProperty; enum BvwError; enum BvwUseType; GtkWidget * bacon_video_widget_new (int width, int height, BvwUseType type, GError **error); void bacon_video_widget_init_backend (int *argc, char ***argv); gboolean bacon_video_widget_open (BaconVideoWidget *bvw, const char *mrl, const char *subtitle_uri, GError **error); gboolean bacon_video_widget_play (BaconVideoWidget *bvw, GError **error); void bacon_video_widget_pause (BaconVideoWidget *bvw); gboolean bacon_video_widget_seek (BaconVideoWidget *bvw, double position, GError **error); gboolean bacon_video_widget_seek_time (BaconVideoWidget *bvw, gint64 _time, GError **error); void bacon_video_widget_stop (BaconVideoWidget *bvw); void bacon_video_widget_close (BaconVideoWidget *bvw); gboolean bacon_video_widget_can_deinterlace (BaconVideoWidget *bvw); gboolean bacon_video_widget_can_direct_seek (BaconVideoWidget *bvw); gboolean bacon_video_widget_can_get_frames (BaconVideoWidget *bvw, GError **error); gboolean bacon_video_widget_can_set_volume (BaconVideoWidget *bvw); void bacon_video_widget_dvd_event (BaconVideoWidget *bvw, BvwDVDEvent type); BvwAspectRatio bacon_video_widget_get_aspect_ratio (BaconVideoWidget *bvw); void bacon_video_widget_set_aspect_ratio (BaconVideoWidget *bvw, BvwAspectRatio ratio); BvwAudioOutType bacon_video_widget_get_audio_out_type (BaconVideoWidget *bvw); gboolean bacon_video_widget_set_audio_out_type (BaconVideoWidget *bvw, BvwAudioOutType type); gboolean bacon_video_widget_get_auto_resize (BaconVideoWidget *bvw); void bacon_video_widget_set_auto_resize (BaconVideoWidget *bvw, gboolean auto_resize); char * bacon_video_widget_get_backend_name (BaconVideoWidget *bvw); int bacon_video_widget_get_connection_speed (BaconVideoWidget *bvw); void bacon_video_widget_set_connection_speed (BaconVideoWidget *bvw, int speed); GdkPixbuf * bacon_video_widget_get_current_frame (BaconVideoWidget *bvw); gint64 bacon_video_widget_get_current_time (BaconVideoWidget *bvw); gboolean bacon_video_widget_get_deinterlacing (BaconVideoWidget *bvw); void bacon_video_widget_set_deinterlacing (BaconVideoWidget *bvw, gboolean deinterlace); void bacon_video_widget_set_fullscreen (BaconVideoWidget *bvw, gboolean fullscreen); GList * bacon_video_widget_get_languages (BaconVideoWidget *bvw); int bacon_video_widget_get_language (BaconVideoWidget *bvw); void bacon_video_widget_set_language (BaconVideoWidget *bvw, int language); void bacon_video_widget_set_logo (BaconVideoWidget *bvw, const char *filename); gboolean bacon_video_widget_get_logo_mode (BaconVideoWidget *bvw); void bacon_video_widget_set_logo_mode (BaconVideoWidget *bvw, gboolean logo_mode); void bacon_video_widget_set_logo_pixbuf (BaconVideoWidget *bvw, GdkPixbuf *logo); void bacon_video_widget_get_metadata (BaconVideoWidget *bvw, BvwMetadataType type, GValue *value); gchar ** bacon_video_widget_get_mrls (BaconVideoWidget *bvw, TotemDiscMediaType type, const char *device, GError **error); GOptionGroup* bacon_video_widget_get_option_group (void); double bacon_video_widget_get_position (BaconVideoWidget *bvw); void bacon_video_widget_set_scale_ratio (BaconVideoWidget *bvw, float ratio); gboolean bacon_video_widget_get_show_cursor (BaconVideoWidget *bvw); void bacon_video_widget_set_show_cursor (BaconVideoWidget *bvw, gboolean show_cursor); void bacon_video_widget_set_show_visuals (BaconVideoWidget *bvw, gboolean show_visuals); gint64 bacon_video_widget_get_stream_length (BaconVideoWidget *bvw); GList * bacon_video_widget_get_subtitles (BaconVideoWidget *bvw); int bacon_video_widget_get_subtitle (BaconVideoWidget *bvw); void bacon_video_widget_set_subtitle (BaconVideoWidget *bvw, int subtitle); void bacon_video_widget_set_subtitle_encoding (BaconVideoWidget *bvw, const char *encoding); void bacon_video_widget_set_subtitle_font (BaconVideoWidget *bvw, const char *font); int bacon_video_widget_get_video_property (BaconVideoWidget *bvw, BvwVideoProperty type); void bacon_video_widget_set_video_property (BaconVideoWidget *bvw, BvwVideoProperty type, int value); GList * bacon_video_widget_get_visuals_list (BaconVideoWidget *bvw); gboolean bacon_video_widget_set_visuals (BaconVideoWidget *bvw, const char *name); void bacon_video_widget_set_visuals_quality (BaconVideoWidget *bvw, BvwVisualsQuality quality); double bacon_video_widget_get_volume (BaconVideoWidget *bvw); void bacon_video_widget_set_volume (BaconVideoWidget *bvw, double volume); double bacon_video_widget_get_zoom (BaconVideoWidget *bvw); void bacon_video_widget_set_zoom (BaconVideoWidget *bvw, double zoom); gboolean bacon_video_widget_has_next_track (BaconVideoWidget *bvw); gboolean bacon_video_widget_has_previous_track (BaconVideoWidget *bvw); gboolean bacon_video_widget_is_playing (BaconVideoWidget *bvw); gboolean bacon_video_widget_is_seekable (BaconVideoWidget *bvw);
GObject +----GInitiallyUnowned +----GtkObject +----GtkWidget +----GtkContainer +----GtkBin +----GtkEventBox +----BaconVideoWidget
"logo-mode" gboolean : Read / Write "playing" gboolean : Read "position" gdouble : Read "referrer" gchar* : Read / Write "seekable" gboolean : Read "show-cursor" gboolean : Read / Write "show-visuals" gboolean : Write "stream-length" gint64 : Read "user-agent" gchar* : Read / Write "volume" gdouble : Read / Write
"buffering" : Run Last "channels-change" : Run Last "download-buffering" : Run Last "eos" : Run Last "error" : Run Last "got-metadata" : Run Last "got-redirect" : Run Last "missing-plugins" : Run Last "tick" : Run Last
BaconVideoWidget is a widget to play audio or video streams, with support for visualisations for audio-only streams. It has a GStreamer backend, and abstracts away the differences to provide a simple interface to the functionality required by Totem. It handles all the low-level audio and video work for Totem (or passes the work off to the backend).
typedef struct _BaconVideoWidget BaconVideoWidget;
All the fields in the BaconVideoWidget structure are private and should never be accessed directly.
typedef struct { } BaconVideoWidgetClass;
All the fields in the BaconVideoWidgetClass structure are private and should never be accessed directly.
typedef enum { BVW_RATIO_AUTO = 0, BVW_RATIO_SQUARE = 1, BVW_RATIO_FOURBYTHREE = 2, BVW_RATIO_ANAMORPHIC = 3, BVW_RATIO_DVB = 4 } BvwAspectRatio;
The pixel aspect ratios available in which to display videos using
@bacon_video_widget_set_aspect_ratio()
.
typedef enum { BVW_AUDIO_SOUND_STEREO, BVW_AUDIO_SOUND_4CHANNEL, BVW_AUDIO_SOUND_41CHANNEL, BVW_AUDIO_SOUND_5CHANNEL, BVW_AUDIO_SOUND_51CHANNEL, BVW_AUDIO_SOUND_AC3PASSTHRU } BvwAudioOutType;
The audio output types available for use with bacon_video_widget_set_audio_out_type()
.
typedef enum { BVW_DVD_ROOT_MENU, BVW_DVD_TITLE_MENU, BVW_DVD_SUBPICTURE_MENU, BVW_DVD_AUDIO_MENU, BVW_DVD_ANGLE_MENU, BVW_DVD_CHAPTER_MENU, BVW_DVD_NEXT_CHAPTER, BVW_DVD_PREV_CHAPTER, BVW_DVD_NEXT_TITLE, BVW_DVD_PREV_TITLE, BVW_DVD_NEXT_ANGLE, BVW_DVD_PREV_ANGLE, BVW_DVD_ROOT_MENU_UP, BVW_DVD_ROOT_MENU_DOWN, BVW_DVD_ROOT_MENU_LEFT, BVW_DVD_ROOT_MENU_RIGHT, BVW_DVD_ROOT_MENU_SELECT } BvwDVDEvent;
The DVD navigation actions available to fire as DVD events to the BaconVideoWidget.
root menu | |
title menu | |
subpicture menu (if available) | |
audio menu (if available) | |
angle menu (if available) | |
chapter menu | |
the next chapter | |
the previous chapter | |
the next title in the current chapter | |
the previous title in the current chapter | |
the next angle | |
the previous angle | |
go up in the menu | |
go down in the menu | |
go left in the menu | |
go right in the menu | |
select the current menu entry |
typedef enum { BVW_INFO_TITLE, BVW_INFO_ARTIST, BVW_INFO_YEAR, BVW_INFO_COMMENT, BVW_INFO_ALBUM, BVW_INFO_DURATION, BVW_INFO_TRACK_NUMBER, BVW_INFO_COVER, /* Video */ BVW_INFO_HAS_VIDEO, BVW_INFO_DIMENSION_X, BVW_INFO_DIMENSION_Y, BVW_INFO_VIDEO_BITRATE, BVW_INFO_VIDEO_CODEC, BVW_INFO_FPS, /* Audio */ BVW_INFO_HAS_AUDIO, BVW_INFO_AUDIO_BITRATE, BVW_INFO_AUDIO_CODEC, BVW_INFO_AUDIO_SAMPLE_RATE, BVW_INFO_AUDIO_CHANNELS } BvwMetadataType;
The different metadata available for querying from a BaconVideoWidget
stream with bacon_video_widget_get_metadata()
.
the stream's title | |
the artist who created the work | |
the year in which the work was created | |
a comment attached to the stream | |
the album in which the work was released | |
the stream's duration, in seconds | |
the track number of the work on the album | |
a GdkPixbuf of the cover artwork | |
whether the stream has video | |
the video's width, in pixels | |
the video's height, in pixels | |
the video's bitrate, in kilobits per second | |
the video's codec | |
the number of frames per second in the video | |
whether the stream has audio | |
the audio's bitrate, in kilobits per second | |
the audio's codec | |
the audio sample rate, in bits per second | |
a string describing the number of audio channels in the stream |
typedef enum { VISUAL_SMALL = 0, VISUAL_NORMAL, VISUAL_LARGE, VISUAL_EXTRA_LARGE, NUM_VISUAL_QUALITIES } BvwVisualsQuality;
The different visualisation sizes or qualities available for use
with bacon_video_widget_set_visuals_quality()
.
typedef enum { BVW_VIDEO_BRIGHTNESS, BVW_VIDEO_CONTRAST, BVW_VIDEO_SATURATION, BVW_VIDEO_HUE } BvwVideoProperty;
The video properties queryable with bacon_video_widget_get_video_property()
,
and settable with bacon_video_widget_set_video_property()
.
typedef enum { /* Plugins */ BVW_ERROR_AUDIO_PLUGIN, BVW_ERROR_NO_PLUGIN_FOR_FILE, BVW_ERROR_VIDEO_PLUGIN, BVW_ERROR_AUDIO_BUSY, /* File */ BVW_ERROR_BROKEN_FILE, BVW_ERROR_FILE_GENERIC, BVW_ERROR_FILE_PERMISSION, BVW_ERROR_FILE_ENCRYPTED, BVW_ERROR_FILE_NOT_FOUND, /* Devices */ BVW_ERROR_DVD_ENCRYPTED, BVW_ERROR_INVALID_DEVICE, BVW_ERROR_DEVICE_BUSY, /* Network */ BVW_ERROR_UNKNOWN_HOST, BVW_ERROR_NETWORK_UNREACHABLE, BVW_ERROR_CONNECTION_REFUSED, /* Generic */ BVW_ERROR_INVALID_LOCATION, BVW_ERROR_GENERIC, BVW_ERROR_CODEC_NOT_HANDLED, BVW_ERROR_AUDIO_ONLY, BVW_ERROR_CANNOT_CAPTURE, BVW_ERROR_READ_ERROR, BVW_ERROR_PLUGIN_LOAD, BVW_ERROR_EMPTY_FILE } BvwError;
Error codes for BaconVideoWidget operations.
Error loading audio output plugin or device. | |
A required GStreamer plugin or xine feature is missing. | |
Error loading video output plugin or device. | |
Audio output device is busy. | |
The movie file is broken and cannot be decoded. | |
A generic error for problems with movie files. | |
Permission was refused to access the stream, or authentication was required. | |
The stream is encrypted and cannot be played. | |
The stream cannot be found. | |
The DVD is encrypted and libdvdcss is not installed. | |
The device given in an MRL (e.g. DVD drive or DVB tuner) did not exist. | |
The device was busy. | |
The host for a given stream could not be resolved. | |
The host for a given stream could not be reached. | |
The server for a given stream refused the connection. | |
An MRL was malformed, or CDDB playback was attempted (which is now unsupported). | |
A generic error occurred. | |
The audio or video codec required by the stream is not supported. | |
An audio-only stream could not be played due to missing audio output support. | |
Error determining frame capture support for a video with bacon_video_widget_can_get_frames() .
|
|
A generic error for problems reading streams. | |
A library or plugin could not be loaded. | |
A movie file was empty. |
typedef enum { BVW_USE_TYPE_VIDEO, BVW_USE_TYPE_AUDIO, BVW_USE_TYPE_CAPTURE, BVW_USE_TYPE_METADATA } BvwUseType;
The purpose for which a BaconVideoWidget will be used, as specified to
bacon_video_widget_new()
. This determines which features will be enabled
in the created widget.
GtkWidget * bacon_video_widget_new (int width, int height, BvwUseType type, GError **error);
Creates a new BaconVideoWidget for the purpose specified in type
.
If type
is BVW_USE_TYPE_VIDEO
, the BaconVideoWidget will be fully-featured; other
values of type
will enable less functionality on the widget, which will come with
corresponding decreases in the size of its memory footprint.
width
and height
give the initial or expected video height. Set them to -1
if the
video size is unknown. For small videos, BaconVideoWidget will be configured differently.
A BvwError will be returned on error.
|
initial or expected video width, in pixels, or -1
|
|
initial or expected video height, in pixels, or -1
|
|
the widget's use type |
|
a GError, or NULL
|
Returns : |
a new BaconVideoWidget, or NULL ; destroy with gtk_widget_destroy()
|
void bacon_video_widget_init_backend (int *argc, char ***argv);
Initialises BaconVideoWidget's GStreamer backend. If this fails for the GStreamer backend, your application will be terminated.
Applications must call either this or bacon_video_widget_get_option_group()
exactly
once; but not both.
|
pointer to application's argc |
|
pointer to application's argv |
gboolean bacon_video_widget_open (BaconVideoWidget *bvw, const char *mrl, const char *subtitle_uri, GError **error);
Opens the given mrl
in bvw
for playing. If subtitle_uri
is not NULL
, the given
subtitle file is also loaded. Alternatively, the subtitle URI can be passed in mrl
by adding it after ""
. For example:
http://example.com/video.mpg""/home/user/subtitle.ass
.
If there was a filesystem error, a BVW_ERROR_GENERIC
error will be returned. Otherwise,
more specific BvwError errors will be returned.
On success, the MRL is loaded and waiting to be played with 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
.
|
a BaconVideoWidget |
|
a GError, or NULL
|
Returns : |
TRUE on success, FALSE otherwise
|
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.
|
a BaconVideoWidget |
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.
|
a BaconVideoWidget |
|
the percentage of the way through the stream to which to seek |
|
a GError, or NULL
|
Returns : |
TRUE on success, FALSE otherwise
|
gboolean bacon_video_widget_seek_time (BaconVideoWidget *bvw, gint64 _time, GError **error);
Seeks the currently-playing stream to the absolute position time
, in milliseconds.
|
a BaconVideoWidget |
|
|
|
a GError, or NULL
|
Returns : |
TRUE on success, FALSE otherwise
|
void bacon_video_widget_stop (BaconVideoWidget *bvw);
Stops playing the current stream and resets to the first position in the stream.
|
a BaconVideoWidget |
void bacon_video_widget_close (BaconVideoWidget *bvw);
Closes the current stream and frees the resources associated with it.
|
a BaconVideoWidget |
gboolean bacon_video_widget_can_deinterlace (BaconVideoWidget *bvw);
Returns whether the widget can deinterlace videos.
|
a BaconVideoWidget |
Returns : |
TRUE if deinterlacing is supported, FALSE otherwise
|
gboolean bacon_video_widget_can_direct_seek (BaconVideoWidget *bvw);
Determines whether direct seeking is possible for the current stream.
|
a BaconVideoWidget |
Returns : |
TRUE if direct seeking is possible, FALSE otherwise
|
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.
|
a BaconVideoWidget |
|
a GError, or NULL
|
Returns : |
TRUE if frames can be captured, FALSE otherwise
|
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
.
|
a BaconVideoWidget |
Returns : |
TRUE if the volume can be set, FALSE otherwise
|
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.
|
a BaconVideoWidget |
|
the type of DVD event to issue |
BvwAspectRatio bacon_video_widget_get_aspect_ratio (BaconVideoWidget *bvw);
Returns the current aspect ratio used by the widget, from BaconVideoWidgetAspectRatio.
|
a BaconVideoWidget |
Returns : |
the aspect ratio |
void bacon_video_widget_set_aspect_ratio (BaconVideoWidget *bvw, BvwAspectRatio ratio);
Sets the aspect ratio used by the widget, from BaconVideoWidgetAspectRatio.
Changes to this take effect immediately.
|
a BaconVideoWidget |
|
the new aspect ratio |
BvwAudioOutType bacon_video_widget_get_audio_out_type (BaconVideoWidget *bvw);
Returns the current audio output type (e.g. how many speaker channels) from BaconVideoWidgetAudioOutType.
|
a BaconVideoWidget |
Returns : |
the audio output type, or -1
|
gboolean bacon_video_widget_set_audio_out_type (BaconVideoWidget *bvw, BvwAudioOutType type);
Sets the audio output type (number of speaker channels) in the video widget, and stores it in GConf.
|
a BaconVideoWidget |
|
the new audio output type |
Returns : |
TRUE on success, FALSE otherwise
|
gboolean bacon_video_widget_get_auto_resize (BaconVideoWidget *bvw);
Returns whether the widget will automatically resize to fit videos.
|
a BaconVideoWidget |
Returns : |
TRUE if the widget will resize, FALSE otherwise
|
void bacon_video_widget_set_auto_resize (BaconVideoWidget *bvw, gboolean auto_resize);
Sets whether the widget should automatically resize to fit to new videos when they are loaded. Changes to this will take effect when the next media file is loaded.
|
a BaconVideoWidget |
|
TRUE to automatically resize for new videos, FALSE otherwise
|
char * bacon_video_widget_get_backend_name (BaconVideoWidget *bvw);
Returns the name string for bvw
. For the GStreamer backend, it is the output
of gst_version_string()
. *
|
a BaconVideoWidget |
Returns : |
the backend's name; free with g_free()
|
int bacon_video_widget_get_connection_speed (BaconVideoWidget *bvw);
Returns the current connection speed, where 0
is the lowest speed
and 11
is the highest.
|
a BaconVideoWidget |
Returns : |
the connection speed index |
void bacon_video_widget_set_connection_speed (BaconVideoWidget *bvw, int speed);
Sets the connection speed from the given speed
index, where 0
is the lowest speed
and 11
is the highest.
|
a BaconVideoWidget |
|
the connection speed index |
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.
|
a BaconVideoWidget |
Returns : |
the current frame, or NULL ; unref with g_object_unref()
|
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.
|
a BaconVideoWidget |
Returns : |
time since the beginning of the stream, in milliseconds, or -1
|
gboolean bacon_video_widget_get_deinterlacing (BaconVideoWidget *bvw);
Returns whether deinterlacing of videos is enabled for this widget.
|
a BaconVideoWidget |
Returns : |
TRUE if deinterlacing is enabled, FALSE otherwise
|
void bacon_video_widget_set_deinterlacing (BaconVideoWidget *bvw, gboolean deinterlace);
Sets whether the widget should deinterlace videos. This is a no-op if
bacon_video_widget_can_deinterlace()
returns FALSE
.
|
a BaconVideoWidget |
|
TRUE if videos should be deinterlaced, FALSE otherwise
|
void bacon_video_widget_set_fullscreen (BaconVideoWidget *bvw, gboolean fullscreen);
Sets whether the widget renders the stream in fullscreen mode.
Fullscreen rendering is done only when possible, as xvidmode is required.
|
a BaconVideoWidget |
|
TRUE to go fullscreen, FALSE otherwise
|
GList * bacon_video_widget_get_languages (BaconVideoWidget *bvw);
Returns a list of audio language tags, each in the form AUDIO
,
where x
x
is the language index.
|
a BaconVideoWidget |
Returns : |
a GList of audio language tags, or NULL ; free each element with g_free() and the list with g_list_free()
|
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.
|
a BaconVideoWidget |
Returns : |
the audio language index |
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.
|
a BaconVideoWidget |
|
an audio language index |
void bacon_video_widget_set_logo (BaconVideoWidget *bvw, const char *filename);
Sets the logo displayed on the video widget when no stream is loaded.
|
a BaconVideoWidget |
|
gboolean bacon_video_widget_get_logo_mode (BaconVideoWidget *bvw);
Gets whether the logo is displayed when no stream is loaded.
|
a BaconVideoWidget |
Returns : |
TRUE if the logo is displayed, FALSE otherwise
|
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.
|
a BaconVideoWidget |
|
TRUE to display the logo, FALSE otherwise
|
void bacon_video_widget_set_logo_pixbuf (BaconVideoWidget *bvw, GdkPixbuf *logo);
|
|
|
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()
.
|
a BaconVideoWidget |
|
the type of metadata to return |
|
a GValue |
gchar ** bacon_video_widget_get_mrls (BaconVideoWidget *bvw, TotemDiscMediaType type, const char *device, GError **error);
Returns an array of MRLs available for the given device
and media type
.
device
should typically be the number of the device (e.g. 0
for the first
DVD drive, or the number of the DVB adapter).
type
can be any value from TotemDiscMediaType, but a BVW_ERROR_INVALID_LOCATION
error
will be returned if type
is MEDIA_TYPE_CDDA
, as CDDA support has been removed from
Totem (and hence BaconVideoWidget).
A BVW_ERROR_NO_PLUGIN_FOR_FILE
error will be returned if the required GStreamer elements do
not exist for the given type
(for the GStreamer backend). *
If device
does not exist, a BVW_ERROR_INVALID_DEVICE
error will be returned.
If type
is MEDIA_TYPE_DVB
and the DVB channels file (as given by
bacon_video_widget_get_channels_file()
for the GStreamer backend)
does not exist, a BVW_ERROR_FILE_NOT_FOUND
error will be returned.
|
a BaconVideoWidget |
|
the media type |
|
the device name |
|
a GError, or NULL
|
Returns : |
a NULL -terminated array of MRLs, or NULL ; free with g_strfreev()
|
GOptionGroup* bacon_video_widget_get_option_group (void);
Returns the GOptionGroup containing command-line options for BaconVideoWidget.
Applications must call either this or bacon_video_widget_init_backend()
exactly
once; but not both.
Returns : |
a GOptionGroup giving command-line options for BaconVideoWidget |
double bacon_video_widget_get_position (BaconVideoWidget *bvw);
Returns the current position in the stream, as a value between
0
and 1
.
|
a BaconVideoWidget |
Returns : |
the current position, or -1
|
void bacon_video_widget_set_scale_ratio (BaconVideoWidget *bvw, float ratio);
Sets the ratio by which the widget will scale videos when they are
displayed. If ratio
is set to 0
, the highest ratio possible will
be chosen.
|
a BaconVideoWidget |
|
the new scale ratio |
gboolean bacon_video_widget_get_show_cursor (BaconVideoWidget *bvw);
Returns whether the cursor is shown when it is over the video widget.
|
a BaconVideoWidget |
Returns : |
TRUE if the cursor is shown, FALSE otherwise
|
void bacon_video_widget_set_show_cursor (BaconVideoWidget *bvw, gboolean show_cursor);
Sets whether the cursor should be shown when it is over the video
widget. If show_cursor
is FALSE
, the cursor will be invisible
when it is moved over the video widget.
|
a BaconVideoWidget |
|
TRUE to show the cursor, FALSE otherwise
|
void bacon_video_widget_set_show_visuals (BaconVideoWidget *bvw, gboolean show_visuals);
Sets whether to show visualisations when playing audio-only streams.
|
a BaconVideoWidget |
|
TRUE to show visualisations, FALSE otherwise
|
gint64 bacon_video_widget_get_stream_length (BaconVideoWidget *bvw);
Returns the total length of the stream, in milliseconds.
|
a BaconVideoWidget |
Returns : |
the stream length, in milliseconds, or -1
|
GList * bacon_video_widget_get_subtitles (BaconVideoWidget *bvw);
Returns a list of subtitle tags, each in the form TEXT
,
where x
x
is the subtitle index.
|
a BaconVideoWidget |
Returns : |
a GList of subtitle tags, or NULL ; free each element with g_free() and the list with g_list_free()
|
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.
|
a BaconVideoWidget |
Returns : |
the subtitle index |
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.
|
a BaconVideoWidget |
|
a subtitle index |
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.
|
a BaconVideoWidget |
|
an encoding system |
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()
.
|
a BaconVideoWidget |
|
a font description string |
int bacon_video_widget_get_video_property (BaconVideoWidget *bvw, BvwVideoProperty type);
Returns the given property of the video, such as its brightness or saturation.
It is returned as a percentage in the full range of integer values; from 0
to G_MAXINT
, where G_MAXINT
/2 is the default.
|
a BaconVideoWidget |
|
the type of property |
Returns : |
the property's value, in the range 0 to G_MAXINT
|
void bacon_video_widget_set_video_property (BaconVideoWidget *bvw, BvwVideoProperty type, int value);
Sets the given property of the video, such as its brightness or saturation.
It should be given as a percentage in the full range of integer values; from 0
to G_MAXINT
, where G_MAXINT
/2 is the default.
|
a BaconVideoWidget |
|
the type of property |
|
the property's value, in the range 0 to G_MAXINT
|
GList * bacon_video_widget_get_visuals_list (BaconVideoWidget *bvw);
Returns a list of the visualisations available when playing audio-only streams.
|
a BaconVideoWidget |
Returns : |
a GList of visualisation names; owned by bvw
|
gboolean bacon_video_widget_set_visuals (BaconVideoWidget *bvw, const char *name);
Sets the visualisation to display when playing audio-only streams.
If name
is NULL
, visualisations will be disabled. Otherwise, name
should be from the list returned by bacon_video_widget_get_visuals_list()
.
|
a BaconVideoWidget |
|
the visualisation's name, or NULL
|
Returns : |
TRUE on success, FALSE otherwise
|
void bacon_video_widget_set_visuals_quality (BaconVideoWidget *bvw, BvwVisualsQuality quality);
Sets the quality/size of displayed visualisations.
|
a BaconVideoWidget |
|
the visualisation quality |
double bacon_video_widget_get_volume (BaconVideoWidget *bvw);
Returns the current volume level, as a percentage between 0
and 1
.
|
a BaconVideoWidget |
Returns : |
the volume as a percentage between 0 and 1
|
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.
|
a BaconVideoWidget |
|
the new volume level, as a percentage between 0 and 1
|
double bacon_video_widget_get_zoom (BaconVideoWidget *bvw);
Returns the zoom factor applied to videos displayed by the widget,
as an integeric percentage between 0
and 1
(e.g. 1
means no zooming at all).
|
a BaconVideoWidget |
Returns : |
the zoom factor |
void bacon_video_widget_set_zoom (BaconVideoWidget *bvw, double zoom);
Sets the zoom factor applied to the video when it is displayed,
as an integeric percentage between 0
and 1
(e.g. set zoom
to 1
to not zoom at all).
|
a BaconVideoWidget |
|
a percentage zoom factor |
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.
|
a BaconVideoWidget |
Returns : |
TRUE if there is another track, FALSE otherwise
|
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.
|
a BaconVideoWidget |
Returns : |
TRUE if there is another track, FALSE otherwise
|
gboolean bacon_video_widget_is_playing (BaconVideoWidget *bvw);
Returns whether the widget is currently playing a stream.
|
a BaconVideoWidget |
Returns : |
TRUE if a stream is playing, FALSE otherwise
|
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.
|
a BaconVideoWidget |
Returns : |
TRUE if the stream is seekable, FALSE otherwise
|
"logo-mode"
property"logo-mode" gboolean : Read / Write
Whether the logo should be displayed when no stream is loaded, or the widget should take up no space.
Default value: FALSE
"playing"
property"playing" gboolean : Read
Whether a stream is currently playing.
Default value: FALSE
"position"
property"position" gdouble : Read
The current position in the stream, as a percentage between 0
and 1
.
Allowed values: [0,1]
Default value: 0
"seekable"
property"seekable" gboolean : Read
Whether the current stream can be seeked.
Default value: FALSE
"show-cursor"
property"show-cursor" gboolean : Read / Write
Whether the cursor should be shown, or should be invisible, when it is over the video widget.
Default value: FALSE
"show-visuals"
property"show-visuals" gboolean : Write
Whether visualisations should be shown for audio-only streams.
Default value: FALSE
"stream-length"
property"stream-length" gint64 : Read
The length of the current stream, in milliseconds.
Allowed values: >= 0
Default value: 0
"user-agent"
property"user-agent" gchar* : Read / Write
The HTTP user agent string to use.
Default value: NULL
"volume"
property"volume" gdouble : Read / Write
The current volume level, as a percentage between 0
and 1
.
Allowed values: [0,1]
Default value: 0
"buffering"
signalvoid user_function (BaconVideoWidget *percentage, gint arg1, gpointer user_data) : Run Last
Emitted regularly when a network stream is being buffered, to provide status updates on the buffering progress.
|
the percentage of buffering completed, between 0 and 1
|
|
user data set when the signal handler was connected. |
"channels-change"
signalvoid user_function (BaconVideoWidget *arg0, gpointer user_data) : Run Last
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()
.
|
user data set when the signal handler was connected. |
"download-buffering"
signalvoid user_function (BaconVideoWidget *percentage, gdouble arg1, gpointer user_data) : Run Last
Emitted regularly when a network stream is being cached on disk, to provide status updates on the buffering level of the stream.
|
the percentage of download buffering completed, between 0 and 1
|
|
user data set when the signal handler was connected. |
"eos"
signalvoid user_function (BaconVideoWidget *arg0, gpointer user_data) : Run Last
Emitted when the end of the current stream is reached.
|
user data set when the signal handler was connected. |
"error"
signalvoid user_function (BaconVideoWidget *message, gchar *playback_stopped, gboolean fatal, gboolean arg3, gpointer user_data) : Run Last
Emitted when the backend wishes to asynchronously report an error. If fatal
is TRUE
,
playback of this stream cannot be restarted.
"got-metadata"
signalvoid user_function (BaconVideoWidget *arg0, gpointer user_data) : Run Last
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.
|
user data set when the signal handler was connected. |
"got-redirect"
signalvoid user_function (BaconVideoWidget *new_mrl, gchar *arg1, gpointer user_data) : Run Last
Emitted when a redirect response is received from a stream's server.
|
the new MRL |
|
user data set when the signal handler was connected. |
"missing-plugins"
signalgboolean user_function (BaconVideoWidget *details, GStrv *descriptions, GStrv *playing, gboolean Returns, gpointer user_data) : Run Last
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.
|
a NULL -terminated array of missing plugin details for use when installing the plugins with libgimme-codec
|
|
a NULL -terminated array of missing plugin descriptions for display to the user
|
|
TRUE if the stream could be played even without these plugins, FALSE otherwise
|
|
user data set when the signal handler was connected. |
Returns : |
TRUE if the signal was handled and some action was taken, FALSE otherwise
|
"tick"
signalvoid user_function (BaconVideoWidget *current_time, gint64 stream_length, gint64 current_position, gdouble seekable, gboolean arg4, gpointer user_data) : Run Last
Emitted every time an important time event happens, or at regular intervals when playing a stream.
|
the current position in the stream, in milliseconds since the beginning of the stream |
|
the length of the stream, in milliseconds |
|
the current position in the stream, as a percentage between 0 and 1
|
|
TRUE if the stream can be seeked, FALSE otherwise
|
|
user data set when the signal handler was connected. |