[gstreamermm] Repaired docs for Gst::Typefind methods peek() and suggest().



commit 24306e697fb79572567f4c8a0dfb79f9b83f6557
Author: José Alburquerque <jaalburqu svn gnome org>
Date:   Sun Aug 2 20:52:10 2009 -0400

    Repaired docs for Gst::Typefind methods peek() and suggest().

 ChangeLog                           |    9 ++++++
 gstreamer/src/gst_docs_override.xml |   54 +++++++++++++++++++++++++++++++++++
 tests/test-plugin-gen.cc            |    2 +-
 3 files changed, 64 insertions(+), 1 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index abb0736..4b9bd59 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,14 @@
 2009-08-02  José Alburquerque  <jaalburqu svn gnome org>
 
+	Repaired docs for Gst::Typefind methods peek() and suggest().
+
+	* gstreamer/src/gst_docs_override.xml: Repaired docs for Gst::Typefind
+	methods peek() and suggest().
+	* tests/test-plugin-gen.cc: Used (void*)0 for sentinel to correct
+	warning.
+
+2009-08-02  José Alburquerque  <jaalburqu svn gnome org>
+
 	Re-added Gst::TypeFind and Gst::TypeFindFactory.
 
 	* gstreamer/gstreamermm.h:
diff --git a/gstreamer/src/gst_docs_override.xml b/gstreamer/src/gst_docs_override.xml
index 2307762..3672aac 100644
--- a/gstreamer/src/gst_docs_override.xml
+++ b/gstreamer/src/gst_docs_override.xml
@@ -88,5 +88,59 @@ MT safe.
 </return>
 </function>
 
+<function name="gst_type_find_peek">
+<description>
+Returns the @size bytes of the stream to identify beginning at offset. If
+offset is a positive number, the offset is relative to the beginning of the
+stream, if offset is a negative number the offset is relative to the end of
+the stream. The returned memory is valid until the typefinding function
+returns and must not be freed.
+
+Returns: the requested data, or NULL if that data is not available.
+
+</description>
+<parameters>
+<parameter name="find">
+<parameter_description> The #GstTypeFind object the function was called with
+</parameter_description>
+</parameter>
+<parameter name="offset">
+<parameter_description> The offset
+</parameter_description>
+</parameter>
+<parameter name="size">
+<parameter_description> The number of bytes to return
+</parameter_description>
+</parameter>
+</parameters>
+<return> the requested data, or NULL if that data is not available.
+</return>
+</function>
+
+<function name="gst_type_find_suggest">
+<description>
+If a Gst::TypeFind::SlotFind calls this method it suggests the caps with the
+given probability. A Gst::TypeFind::SlotFind may supply different suggestions
+in one call.
+It is up to the caller of the Gst::TypeFind::SlotFind to interpret these
+values.
+
+</description>
+<parameters>
+<parameter name="find">
+<parameter_description> The #GstTypeFind object the function was called with
+</parameter_description>
+</parameter>
+<parameter name="probability">
+<parameter_description> The probability in percent that the suggestion is right
+</parameter_description>
+</parameter>
+<parameter name="caps">
+<parameter_description> The fixed #GstCaps to suggest
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
 
 </root>
diff --git a/tests/test-plugin-gen.cc b/tests/test-plugin-gen.cc
index 835741d..b779f62 100644
--- a/tests/test-plugin-gen.cc
+++ b/tests/test-plugin-gen.cc
@@ -37,7 +37,7 @@ int main(int argc, char* argv[])
 
   gulong mmapsize = 0;
   GstFileSrc* obj = filesrc->gobj();
-  g_object_get(obj, "mmapsize", &mmapsize, 0);
+  g_object_get(obj, "mmapsize", &mmapsize, (void*)0);
 
   std::cout << "mmapsize = "  << mmapsize << std::endl;
 



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