diff options
author | Damien Lespiau <damien.lespiau@intel.com> | 2011-08-30 12:22:38 +0100 |
---|---|---|
committer | Damien Lespiau <damien.lespiau@intel.com> | 2011-08-30 12:24:49 +0100 |
commit | e652a0a367b9be75c4d1a4dce11c96ef2c8f61d4 (patch) | |
tree | 9c7ce00c9f20796483cac07f16209600db4c90c4 /clutter-gst | |
parent | 812df2a0d3522a7151aa754c4a41cc87cd8e23b0 (diff) | |
download | clutter-gst-e652a0a367b9be75c4d1a4dce11c96ef2c8f61d4.tar.gz |
doc: Add latest API addition to the gtk-doc sections
Diffstat (limited to 'clutter-gst')
-rw-r--r-- | clutter-gst/clutter-gst-player.c | 35 | ||||
-rw-r--r-- | clutter-gst/clutter-gst-video-texture.c | 4 |
2 files changed, 37 insertions, 2 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 */ |