From 7c6ae80bfe0c410d91a404926756c4983c4fd15b Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Fri, 7 Nov 2008 18:00:59 +0000 Subject: [PATCH] 2008-11-07 Emmanuele Bassi * clutter/clutter-media.c: Improve documentation of the ClutterMedia interface. --- ChangeLog | 53 ++++++++++++++++++++++------------------- clutter/clutter-media.c | 36 ++++++++++++++++++++++++---- 2 files changed, 61 insertions(+), 28 deletions(-) diff --git a/ChangeLog b/ChangeLog index 2fcc6a534..68303f544 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,21 +1,26 @@ +2008-11-07 Emmanuele Bassi + + * clutter/clutter-media.c: Improve documentation of the + ClutterMedia interface. + 2008-11-07 Matthew Allum - Bug 1238 - [PATCH] Pack bitfields in ClutterTexturePrivate + Bug 1238 - [PATCH] Pack bitfields in ClutterTexturePrivate * clutter/clutter-texture.c: - Using 'guint my_field : 1' for booleans to save space only - makes sense if you group all such fields together. Fix - grouping for ClutterTexturePrivate. Thanks to Owen Taylor for - patch. + Using 'guint my_field : 1' for booleans to save space only + makes sense if you group all such fields together. Fix + grouping for ClutterTexturePrivate. Thanks to Owen Taylor for + patch. 2008-11-07 Matthew Allum Bug 1237 - clutter_texture_set_filter_quality calls - clutter_texture_[un]realize + clutter_texture_[un]realize * clutter/clutter-texture.c: (clutter_texture_set_filter_quality): - Call clutter_actor_[un]realize and keep visibility state + Call clutter_actor_[un]realize and keep visibility state 2008-11-07 Matthew Allum @@ -25,11 +30,11 @@ * clutter/clutter-private.h: * clutter/clutter-texture.c: * clutter/x11/clutter-x11-texture-pixmap.c: - - Attempt to lower overhead of updating TFP's (particularly mipmaped). - Compresses mipmap updates only for visible TFPs. - Avoiding updates for non visible TFP's whilst keeping visible - clones working ok. + + Attempt to lower overhead of updating TFP's (particularly mipmaped). + Compresses mipmap updates only for visible TFPs. + Avoiding updates for non visible TFP's whilst keeping visible + clones working ok. 2008-11-06 Neil Roberts @@ -134,10 +139,10 @@ * clutter/clutter-texture.c: (clutter_texture_set_filter_quality), (clutter_texture_get_filter_quality): - Fix up some logic, typos. + Fix up some logic, typos. * clutter/glx/clutter-glx-texture-pixmap.c: - Improve support for mipmaped TFP textures. + Improve support for mipmaped TFP textures. 2008-10-31 Emmanuele Bassi @@ -1001,7 +1006,7 @@ 2008-07-17 Emmanuele Bassi Bug 1047 - API documentation from release tarball is not - installed by "make install" + installed by "make install" * configure.ac: * Makefile.am: Make the recursion into the documentation @@ -1047,7 +1052,7 @@ 2008-07-13 Matthew Allum * clutter/x11/clutter-x11-texture-pixmap.c: - Call XSync in unredirect X error trap (Thanks to Andy Wingo) + Call XSync in unredirect X error trap (Thanks to Andy Wingo) 2008-07-13 Neil Roberts @@ -1111,7 +1116,7 @@ 2008-07-07 Matthew Allum Bug 1016 - Changing window-redirect-automatic property after - creating ClutterX11TexturePixmap doesn't work. + creating ClutterX11TexturePixmap doesn't work. * clutter/x11/clutter-x11-texture-pixmap.c: (clutter_x11_texture_pixmap_set_window): @@ -1132,7 +1137,7 @@ 2008-07-05 Emmanuele Bassi Bug 1033 - Manually parsing command line options prevents - initializing clutter (Armin Burgmeier) + initializing clutter (Armin Burgmeier) * clutter/clutter-main.c: (post_parse_hook), (clutter_init_real): Set the is_initialized @@ -1275,7 +1280,7 @@ 2008-07-01 Øyvind Kolås Bug 1013 - Per device grabs are not obeyed in pointer device - propagation. + propagation. * clutter/clutter-event.c: (clutter_event_get_device_id): swap arguments of g_return_val_if_fail around. @@ -1369,7 +1374,7 @@ 2008-06-30 Matthew Allum Bug 997 - automatic updates not working for named TFP pixmaps, - at least in x11 + at least in x11 * clutter/glx/clutter-glx-texture-pixmap.c: * clutter/glx/clutter-glx-texture-pixmap.h: @@ -1385,7 +1390,7 @@ 2008-06-30 Emmanuele Bassi Bug 980 - cogl-bitmap-fallback.c compiler error/warning due to - cast issue (Haakon Sporsheim) + cast issue (Haakon Sporsheim) * clutter/cogl/common/cogl-bitmap-fallback.c: (_cogl_unpremult_alpha_last), @@ -1888,7 +1893,7 @@ 2008-06-23 Emmanuele Bassi Bug 984 - pango_clutter_render_layout() declared void, but - returns (Haakon Sporsheim) + returns (Haakon Sporsheim) * clutter/pango/pangoclutter-render.c: (pango_clutter_render_layout): Do not use a return statement. @@ -2120,7 +2125,7 @@ 2008-06-13 Emmanuele Bassi Bug #953 - Actors are not hidden before unrealized or - disposed (Tommi Komulainen) + disposed (Tommi Komulainen) * clutter/clutter-actor.c: (clutter_actor_unrealize): Hide a visible actor when unrealizing @@ -2842,7 +2847,7 @@ 2008-05-31 Emmanuele Bassi Bug #943 - Signals are only emitted within a certain area of - the stage + the stage * clutter/clutter-main.c (clutter_do_event): Use the proper API and not the macros for the default stage, in case we are diff --git a/clutter/clutter-media.c b/clutter/clutter-media.c index f1979f725..1c5f759f7 100644 --- a/clutter/clutter-media.c +++ b/clutter/clutter-media.c @@ -27,7 +27,13 @@ * SECTION:clutter-media * @short_description: An interface for controlling playback of media data. * - * #ClutterMedia is an interface for controlling playback of media data. + * #ClutterMedia is an interface for controlling playback of media sources. + * + * It is not implemented inside Clutter, but other integration libraries + * like Clutter-GStreamer, implement it to offer a uniform API for + * applications. + * + * ClutterMedia is available since Clutter 0.2 */ #ifdef HAVE_CONFIG_H @@ -203,6 +209,8 @@ clutter_media_base_init (gpointer g_iface) * @uri: URI * * Sets the URI of @media to @uri. + * + * Since: 0.2 */ void clutter_media_set_uri (ClutterMedia *media, @@ -220,6 +228,8 @@ clutter_media_set_uri (ClutterMedia *media, * Retrieves the URI from @media. * * Return value: The URI as a string. + * + * Since: 0.2 */ const char* clutter_media_get_uri (ClutterMedia *media) @@ -235,6 +245,8 @@ clutter_media_get_uri (ClutterMedia *media) * @playing: TRUE to start playing, FALSE to stop. * * Starts or stops @media playing. + * + * Since: 0.2 */ void clutter_media_set_playing (ClutterMedia *media, @@ -252,6 +264,8 @@ clutter_media_set_playing (ClutterMedia *media, * Retrieves the playing status of @media. * * Return value: %TRUE if playing, %FALSE if stopped. + * + * Since: 0.2 */ gboolean clutter_media_get_playing (ClutterMedia *media) @@ -267,6 +281,8 @@ clutter_media_get_playing (ClutterMedia *media) * @position: The desired position. * * Sets the playback position of @media to @position. + * + * Since: 0.2 */ void clutter_media_set_position (ClutterMedia *media, @@ -284,6 +300,8 @@ clutter_media_set_position (ClutterMedia *media, * Retrieves the position of @media. * * Return value: The playback position. + * + * Since: 0.2 */ int clutter_media_get_position (ClutterMedia *media) @@ -299,6 +317,8 @@ clutter_media_get_position (ClutterMedia *media) * @volume: The volume as a double between 0.0 and 1.0 * * Sets the playback volume of @media to @volume. + * + * Since: 0.2 */ void clutter_media_set_volume (ClutterMedia *media, @@ -316,6 +336,8 @@ clutter_media_set_volume (ClutterMedia *media, * Retrieves the playback volume of @media. * * Return value: The playback volume between 0.0 and 1.0 + * + * Since: 0.2 */ double clutter_media_get_volume (ClutterMedia *media) @@ -332,6 +354,8 @@ clutter_media_get_volume (ClutterMedia *media) * Retrieves whether @media is seekable or not. * * Return value: %TRUE if @media can seek, %FALSE otherwise. + * + * Since: 0.2 */ gboolean clutter_media_get_can_seek (ClutterMedia *media) @@ -348,6 +372,8 @@ clutter_media_get_can_seek (ClutterMedia *media) * Retrieves the amount of the stream that is buffered. * * Return value: percentage value + * + * Since: 0.2 */ int clutter_media_get_buffer_percent (ClutterMedia *media) @@ -364,6 +390,8 @@ clutter_media_get_buffer_percent (ClutterMedia *media) * Retrieves the duration of the media stream that @media represents. * * Return value: The length of the media stream. + * + * Since: 0.2 */ int clutter_media_get_duration (ClutterMedia *media) @@ -381,6 +409,8 @@ clutter_media_get_duration (ClutterMedia *media) * @filename: A filename to media file. * * Sets the filename of the media source. + * + * Since: 0.2 */ void clutter_media_set_filename (ClutterMedia *media, @@ -398,9 +428,7 @@ clutter_media_set_filename (ClutterMedia *media, g_free (abs_path); } else - { - uri = g_filename_to_uri (filename, NULL, &uri_error); - } + uri = g_filename_to_uri (filename, NULL, &uri_error); if (uri_error) {