summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@openedhand.com>2007-11-23 16:28:43 +0000
committerEmmanuele Bassi <ebassi@openedhand.com>2007-11-23 16:28:43 +0000
commitf523e4a8337b476477430f982e726e0d595eb1e9 (patch)
treec707d799aef24fbf7a71b4c50445320a94de03d2
parentc51f145ab99198d3cee26e925b3e3b16e6644fa2 (diff)
downloadclutter-gst-f523e4a8337b476477430f982e726e0d595eb1e9.tar.gz
2007-11-23 Emmanuele Bassi <ebassi@openedhand.com>
* clutter-gst/clutter-gst-audio.h: * clutter-gst/clutter-gst-version.h.in: * clutter-gst/clutter-gst-video-sink.h: * clutter-gst/clutter-gst-video-texture.h: Add missing documentation. * doc/reference/Makefile.am: Fix EXTRA_DIST. * doc/reference/clutter-gst-docs.sgml: Fix wording a bit. * examples/video-player.c (effect1_tl_cb): Update for upstream API changes.
-rw-r--r--ChangeLog15
-rw-r--r--clutter-gst/clutter-gst-audio.h13
-rw-r--r--clutter-gst/clutter-gst-version.h.in43
-rw-r--r--clutter-gst/clutter-gst-video-sink.h13
-rw-r--r--clutter-gst/clutter-gst-video-texture.h13
-rw-r--r--doc/reference/Makefile.am2
-rw-r--r--doc/reference/clutter-gst-docs.sgml9
-rw-r--r--examples/video-player.c9
8 files changed, 108 insertions, 9 deletions
diff --git a/ChangeLog b/ChangeLog
index e128328..62d1152 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,18 @@
+2007-11-23 Emmanuele Bassi <ebassi@openedhand.com>
+
+ * clutter-gst/clutter-gst-audio.h:
+ * clutter-gst/clutter-gst-version.h.in:
+ * clutter-gst/clutter-gst-video-sink.h:
+ * clutter-gst/clutter-gst-video-texture.h: Add missing
+ documentation.
+
+ * doc/reference/Makefile.am: Fix EXTRA_DIST.
+
+ * doc/reference/clutter-gst-docs.sgml: Fix wording a bit.
+
+ * examples/video-player.c (effect1_tl_cb): Update for upstream
+ API changes.
+
2007-11-22 Zeeshan Ali Khattak <zeenix@gstreamer.net>
* clutter-gst/clutter-gst-video-sink.c:
diff --git a/clutter-gst/clutter-gst-audio.h b/clutter-gst/clutter-gst-audio.h
index 5d0a590..16dab85 100644
--- a/clutter-gst/clutter-gst-audio.h
+++ b/clutter-gst/clutter-gst-audio.h
@@ -59,6 +59,14 @@ typedef struct _ClutterGstAudio ClutterGstAudio;
typedef struct _ClutterGstAudioClass ClutterGstAudioClass;
typedef struct _ClutterGstAudioPrivate ClutterGstAudioPrivate;
+/**
+ * ClutterGstAudio:
+ *
+ * Simple class for playing audio files.
+ *
+ * The #ClutterGstAudio structure contains only private data and should
+ * not be accessed directly.
+ */
struct _ClutterGstAudio
{
/*< private >*/
@@ -66,6 +74,11 @@ struct _ClutterGstAudio
ClutterGstAudioPrivate *priv;
};
+/**
+ * ClutterGstAudioClass:
+ *
+ * Base class for #ClutterGstAudio.
+ */
struct _ClutterGstAudioClass
{
/*< private >*/
diff --git a/clutter-gst/clutter-gst-version.h.in b/clutter-gst/clutter-gst-version.h.in
index 0b1651e..871fd4d 100644
--- a/clutter-gst/clutter-gst-version.h.in
+++ b/clutter-gst/clutter-gst-version.h.in
@@ -33,16 +33,59 @@
#ifndef __CLUTTER_GST_VERSION_H__
#define __CLUTTER_GST_VERSION_H__
+/**
+ * CLUTTER_GST_MAJOR_VERSION:
+ *
+ * ClutterGst major version (e.g. "1", if %CLUTTER_GST_VERSION is "1.2.3")
+ */
#define CLUTTER_GST_MAJOR_VERSION (@CLUTTER_GST_MAJOR_VERSION@)
+
+/**
+ * CLUTTER_GST_MINOR_VERSION:
+ *
+ * ClutterGst minor version (e.g. "2", if %CLUTTER_GST_VERSION is "1.2.3")
+ */
#define CLUTTER_GST_MINOR_VERSION (@CLUTTER_GST_MINOR_VERSION@)
+
+/**
+ * CLUTTER_GST_MICRO_VERSION:
+ *
+ * ClutterGst micro version (e.g. "3", if %CLUTTER_GST_VERSION is "1.2.3")
+ */
#define CLUTTER_GST_MICRO_VERSION (@CLUTTER_GST_MICRO_VERSION@)
+/**
+ * CLUTTER_GST_VERSION:
+ *
+ * ClutterGst full version (e.g. "1.2.3")
+ */
#define CLUTTER_GST_VERSION (@CLUTTER_GST_VERSION@)
+
+/**
+ * CLUTTER_GST_VERSION_S:
+ *
+ * ClutterGst full version, encoded as a string.
+ */
#define CLUTTER_GST_VERSION_S "@CLUTTER_GST_VERSION@"
+
+/**
+ * CLUTTER_GST_VERSION_HEX:
+ *
+ * ClutterGst full version, encoded as an hexadecimal value.
+ */
#define CLUTTER_GST_VERSION_HEX ((CLUTTER_GST_MAJOR_VERSION << 24) | \
(CLUTTER_GST_MINOR_VERSION << 16) | \
(CLUTTER_GST_MICRO_VERSION << 8))
+/**
+ * CLUTTER_GST_CHECK_VERSION:
+ * @major: major version, like 1 in 1.2.3
+ * @minor: minor version, like 2 in 1.2.3
+ * @micro: micro version, like 3 in 1.2.3
+ *
+ * Evaluates to %TRUE if the version of ClutterGst is greater than
+ * the @major, @minor and @micro values.
+ */
#define CLUTTER_GST_CHECK_VERSION(major,minor,micro) \
(CLUTTER_GST_MAJOR_VERSION > (major) || \
(CLUTTER_GST_MAJOR_VERSION == (major) && CLUTTER_GST_MINOR_VERSION > (minor)) || \
diff --git a/clutter-gst/clutter-gst-video-sink.h b/clutter-gst/clutter-gst-video-sink.h
index e256393..6e63a4d 100644
--- a/clutter-gst/clutter-gst-video-sink.h
+++ b/clutter-gst/clutter-gst-video-sink.h
@@ -61,6 +61,14 @@ typedef struct _ClutterGstVideoSink ClutterGstVideoSink;
typedef struct _ClutterGstVideoSinkClass ClutterGstVideoSinkClass;
typedef struct _ClutterGstVideoSinkPrivate ClutterGstVideoSinkPrivate;
+/**
+ * ClutterGstVideoSink:
+ *
+ * Class implementing a GStreamer sink element for #ClutterTexture<!-- -->s.
+ *
+ * The #ClutterGstVideoSink structure contains only private data and should
+ * not be accessed directly.
+ */
struct _ClutterGstVideoSink
{
/*< private >*/
@@ -68,6 +76,11 @@ struct _ClutterGstVideoSink
ClutterGstVideoSinkPrivate *priv;
};
+/**
+ * ClutterGstVideoSinkClass:
+ *
+ * Base class for #ClutterGstVideoSink.
+ */
struct _ClutterGstVideoSinkClass
{
/*< private >*/
diff --git a/clutter-gst/clutter-gst-video-texture.h b/clutter-gst/clutter-gst-video-texture.h
index 39f23a2..40891af 100644
--- a/clutter-gst/clutter-gst-video-texture.h
+++ b/clutter-gst/clutter-gst-video-texture.h
@@ -62,6 +62,14 @@ typedef struct _ClutterGstVideoTexture ClutterGstVideoTexture;
typedef struct _ClutterGstVideoTextureClass ClutterGstVideoTextureClass;
typedef struct _ClutterGstVideoTexturePrivate ClutterGstVideoTexturePrivate;
+/**
+ * ClutterGstVideoTexture:
+ *
+ * Subclass of #ClutterTexture that displays videos using GStreamer.
+ *
+ * The #ClutterGstVideoTexture structure contains only private data and
+ * should not be accessed directly.
+ */
struct _ClutterGstVideoTexture
{
/*< private >*/
@@ -69,6 +77,11 @@ struct _ClutterGstVideoTexture
ClutterGstVideoTexturePrivate *priv;
};
+/**
+ * ClutterGstVideoTextureClass:
+ *
+ * Base class for #ClutterGstVideoTexture.
+ */
struct _ClutterGstVideoTextureClass
{
/*< private >*/
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index 13c1d6e..682487d 100644
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -77,4 +77,4 @@ include $(top_srcdir)/gtk-doc.make
# Other files to distribute
# e.g. EXTRA_DIST += version.xml.in
-EXTRA_DIST = version.xml.in
+EXTRA_DIST += version.xml.in
diff --git a/doc/reference/clutter-gst-docs.sgml b/doc/reference/clutter-gst-docs.sgml
index 44f6f5d..744c037 100644
--- a/doc/reference/clutter-gst-docs.sgml
+++ b/doc/reference/clutter-gst-docs.sgml
@@ -39,12 +39,12 @@
<chapter>
<title>Clutter Gst Overview</title>
- <para>
- Clutter Gst provides a ClutterMedia interface to GStreamer for basic video and audio playback.
+ <para>Clutter-GStreamer provides a ClutterMedia interface implementation
+ using GStreamer for basic video and audio playback.</para>
+
+ </chapter>
- </para>
- </chapter>
<chapter>
<title>Clutter Actors And Objects</title>
<xi:include href="xml/clutter-gst-video-texture.xml"/>
@@ -53,6 +53,7 @@
<xi:include href="xml/clutter-gst-util.xml"/>
<xi:include href="xml/clutter-gst-version.xml"/>
</chapter>
+
<appendix id="license">
<title>License</title>
diff --git a/examples/video-player.c b/examples/video-player.c
index 2d25fa4..0ecc6bb 100644
--- a/examples/video-player.c
+++ b/examples/video-player.c
@@ -249,10 +249,11 @@ effect1_tl_cb (ClutterTimeline *timeline,
gint frame_num,
VideoApp *app)
{
- clutter_actor_rotate_y (app->vtexture,
- frame_num * 12,
- CLUTTER_STAGE_WIDTH()/2,
- 0);
+ clutter_actor_set_rotation (app->vtexture, CLUTTER_Y_AXIS,
+ frame_num * 12,
+ CLUTTER_STAGE_WIDTH() / 2,
+ 0,
+ 0);
}