[clutter-gst] doc: Add latest API addition to the gtk-doc sections



commit e652a0a367b9be75c4d1a4dce11c96ef2c8f61d4
Author: Damien Lespiau <damien lespiau intel com>
Date:   Tue Aug 30 12:22:38 2011 +0100

    doc: Add latest API addition to the gtk-doc sections

 clutter-gst/clutter-gst-player.c        |   35 +++++++++++++++++++++++++++++++
 clutter-gst/clutter-gst-video-texture.c |    4 +-
 doc/reference/clutter-gst-sections.txt  |    8 ++++++-
 3 files changed, 44 insertions(+), 3 deletions(-)
---
diff --git a/clutter-gst/clutter-gst-player.c b/clutter-gst/clutter-gst-player.c
index ccb2b0d..9c4101a 100644
--- a/clutter-gst/clutter-gst-player.c
+++ b/clutter-gst/clutter-gst-player.c
@@ -2166,6 +2166,16 @@ clutter_gst_player_set_audio_stream (ClutterGstPlayer *player,
                 NULL);
 }
 
+/**
+ * clutter_gst_player_get_subtitle_tracks:
+ * @player: a #ClutterGstPlayer
+ *
+ * Get the list of subtitles tracks of the current media.
+ *
+ * Return value: a list of strings describing the available subtitles tracks
+ *
+ * Since: 1.4
+ */
 GList *
 clutter_gst_player_get_subtitle_tracks (ClutterGstPlayer *player)
 {
@@ -2187,6 +2197,19 @@ clutter_gst_player_get_subtitle_tracks (ClutterGstPlayer *player)
   return priv->subtitle_tracks;
 }
 
+/**
+ * clutter_gst_player_get_subtitle_track:
+ * @player: a #ClutterGstPlayer
+ *
+ * Get the current subtitles track. The number returned is the index of the
+ * subitles track in the list returned by
+ * clutter_gst_player_get_subtitle_tracks().
+ *
+ * Return value: the index of the current subtitlest track, -1 if the media has
+ * no subtitles track or if the subtitles have been turned off
+ *
+ * Since: 1.4
+ */
 gint
 clutter_gst_player_get_subtitle_track (ClutterGstPlayer *player)
 {
@@ -2207,6 +2230,18 @@ clutter_gst_player_get_subtitle_track (ClutterGstPlayer *player)
 
 }
 
+/**
+ * clutter_gst_player_set_subtitle_track:
+ * @player: a #ClutterGstPlayer
+ * @index_: the index of the subtitles track
+ *
+ * Set the subtitles track to play. @index_ is the index of the stream
+ * in the list returned by clutter_gst_player_get_subtitle_tracks().
+ *
+ * If @index_ is -1, the subtitles are turned off.
+ *
+ * Since: 1.4
+ */
 void
 clutter_gst_player_set_subtitle_track (ClutterGstPlayer *player,
                                        gint              index_)
diff --git a/clutter-gst/clutter-gst-video-texture.c b/clutter-gst/clutter-gst-video-texture.c
index 70fb9a1..0ec9cbf 100644
--- a/clutter-gst/clutter-gst-video-texture.c
+++ b/clutter-gst/clutter-gst-video-texture.c
@@ -852,8 +852,8 @@ clutter_gst_video_texture_get_subtitle_tracks (ClutterGstVideoTexture *texture)
  * subitles track in the list returned by
  * clutter_gst_video_texture_get_subtitle_tracks().
  *
- * Return value: the index of the current subtitlest track, -1 if the media has no
- * subtitles track or if the subtitles have been turned off
+ * Return value: the index of the current subtitlest track, -1 if the media has
+ * no subtitles track or if the subtitles have been turned off
  *
  * Since: 1.4
  */
diff --git a/doc/reference/clutter-gst-sections.txt b/doc/reference/clutter-gst-sections.txt
index 78e2dbf..bd7a710 100644
--- a/doc/reference/clutter-gst-sections.txt
+++ b/doc/reference/clutter-gst-sections.txt
@@ -18,6 +18,7 @@ ClutterGstPlayerIface
 clutter_gst_player_class_init
 clutter_gst_player_init
 clutter_gst_player_get_pipeline
+clutter_gst_player_get_idle
 clutter_gst_player_get_user_agent
 clutter_gst_player_set_user_agent
 clutter_gst_player_set_seek_flags
@@ -27,7 +28,9 @@ clutter_gst_player_set_buffering_mode
 clutter_gst_player_get_audio_streams
 clutter_gst_player_get_audio_stream
 clutter_gst_player_set_audio_stream
-clutter_gst_player_get_idle
+clutter_gst_player_get_subtitle_tracks
+clutter_gst_player_get_subtitle_track
+clutter_gst_player_set_subtitle_track
 <SUBSECTION Standard>
 CLUTTER_GST_PLAYER
 CLUTTER_GST_IS_PLAYER
@@ -56,6 +59,9 @@ clutter_gst_video_texture_set_buffering_mode
 clutter_gst_video_texture_get_audio_streams
 clutter_gst_video_texture_get_audio_stream
 clutter_gst_video_texture_set_audio_stream
+clutter_gst_video_texture_get_subtitle_tracks
+clutter_gst_video_texture_get_subtitle_track
+clutter_gst_video_texture_set_subtitle_track
 <SUBSECTION Standard>
 CLUTTER_GST_VIDEO_TEXTURE
 CLUTTER_GST_IS_VIDEO_TEXTURE



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]