[gstreamermm] Mixer: Correct the list_tracks() methods docs.



commit ab125a00800447fb28052e329d723df200401d85
Author: José Alburquerque <jaalburqu svn gnome org>
Date:   Tue Dec 22 21:01:51 2009 -0500

    	Mixer: Correct the list_tracks() methods docs.
    
    	* gstreamer/src/mixer.hg (list_tracks): Correct the docs for the two
    	methods because it is not properly generated by pygobject's
    	docextract_to_xml.py.

 ChangeLog              |    8 ++++++++
 gstreamer/src/mixer.hg |   14 ++++++++++++++
 2 files changed, 22 insertions(+), 0 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 6495bc4..fe49ccb 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,13 @@
 2009-12-22  José Alburquerque  <jaalburqu svn gnome org>
 
+	Mixer: Correct the list_tracks() methods docs.
+
+	* gstreamer/src/mixer.hg (list_tracks): Correct the docs for the two
+	methods because it is not properly generated by pygobject's
+	docextract_to_xml.py.
+
+2009-12-22  José Alburquerque  <jaalburqu svn gnome org>
+
 	TagList: Export a lookup function for tags and not the internal array.
 
 	* gstreamer/src/taglist.ccg (_tag_strings): Make array of const char*
diff --git a/gstreamer/src/mixer.hg b/gstreamer/src/mixer.hg
index ab3f8d7..5c41c58 100644
--- a/gstreamer/src/mixer.hg
+++ b/gstreamer/src/mixer.hg
@@ -44,9 +44,23 @@ class Mixer : public Glib::Interface
 
 public:
 #m4 _CONVERSION(`const GList*', `Glib::ListHandle< Glib::RefPtr<Gst::MixerTrack> >', `$2(const_cast<GList*>($3), Glib::OWNERSHIP_NONE)')
+  /** Returns a list of available tracks for this mixer/element. Note that it
+   * is allowed for sink (output) elements to only provide the output tracks
+   * in this list. Likewise, for sources (inputs), it is allowed to only
+   * provide input elements in this list.
+   *
+   * @return A Glib::ListHandle<> consisting of zero or more Gst::MixerTrack. 
+   */
   _WRAP_METHOD(Glib::ListHandle< Glib::RefPtr<Gst::MixerTrack> > list_tracks(), gst_mixer_list_tracks)
 
 #m4 _CONVERSION(`const GList*', `Glib::ListHandle< Glib::RefPtr<const Gst::MixerTrack> >', `$2(const_cast<GList*>($3), Glib::OWNERSHIP_NONE)')
+  /** Returns a list of available tracks for this mixer/element. Note that it
+   * is allowed for sink (output) elements to only provide the output tracks
+   * in this list. Likewise, for sources (inputs), it is allowed to only
+   * provide input elements in this list.
+   *
+   * @return A Glib::ListHandle<> consisting of zero or more Gst::MixerTrack. 
+   */
   _WRAP_METHOD(Glib::ListHandle< Glib::RefPtr<const Gst::MixerTrack> > list_tracks() const, gst_mixer_list_tracks)
 
   /** Get the current volume(s) on the given track.



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