gnomemm r1656 - in gstreamermm/trunk: . gstreamer/src



Author: jaalburqu
Date: Wed Jul 30 22:22:04 2008
New Revision: 1656
URL: http://svn.gnome.org/viewvc/gnomemm?rev=1656&view=rev

Log:
2008-07-30  Josà Alburquerque  <jaalburqu svn gnome org>

	* gstreamer/src/element.ccg:
	* gstreamer/src/element.hg: Renamed get_compatible_pad() to
	create_compatible_pad() because it actually creates a pad if one does
	not exist.

	* gstreamer/src/gst_docs.xml: Regenerated gstreamer branch docs.

	* gstreamer/src/bus.hg:
	* gstreamer/src/clock.hg:
	* gstreamer/src/filter.hg:
	* gstreamer/src/index.hg:
	* gstreamer/src/pad.hg:
	* gstreamer/src/plugin.hg:
	* gstreamer/src/pluginfeature.hg:
	* gstreamer/src/structure.hg:
	* gstreamer/src/taglist.hg:
	* gstreamer/src/task.hg: Beautified slot docs a bit.

Modified:
   gstreamermm/trunk/ChangeLog
   gstreamermm/trunk/gstreamer/src/bus.hg
   gstreamermm/trunk/gstreamer/src/clock.hg
   gstreamermm/trunk/gstreamer/src/element.ccg
   gstreamermm/trunk/gstreamer/src/element.hg
   gstreamermm/trunk/gstreamer/src/filter.hg
   gstreamermm/trunk/gstreamer/src/gst_docs.xml
   gstreamermm/trunk/gstreamer/src/index.hg
   gstreamermm/trunk/gstreamer/src/pad.hg
   gstreamermm/trunk/gstreamer/src/plugin.hg
   gstreamermm/trunk/gstreamer/src/pluginfeature.hg
   gstreamermm/trunk/gstreamer/src/structure.hg
   gstreamermm/trunk/gstreamer/src/taglist.hg
   gstreamermm/trunk/gstreamer/src/task.hg

Modified: gstreamermm/trunk/gstreamer/src/bus.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/bus.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/bus.hg	Wed Jul 30 22:22:04 2008
@@ -32,6 +32,13 @@
 class Message;
 
 _WRAP_ENUM(BusFlags, GstBusFlags)
+
+/** The result values for a Gst::Bus::SlotMessageSync.
+ * - Gst::BUS_DROP - Drop the message.
+ * - Gst::BUS_PASS - Pass the message to the async queue.
+ * - Gst::BUS_ASYNC - Pass message to async queue, continue if message is
+ * handled.
+ */
 _WRAP_ENUM(BusSyncReply, GstBusSyncReply)
 
 //TODO: Correct C API reference in class docs below:
@@ -86,7 +93,7 @@
 public:
   /** For example,
    * bool on_bus_message(const Glib::RefPtr<Gst::Bus>& bus, const
-   * Glib::RefPtr<Gst::Message>& message);
+   * Glib::RefPtr<Gst::Message>& message);.
    * The message function should return true if it wants to continue to receive
    * messages, or false otherwise.
    */
@@ -94,7 +101,7 @@
 
   /** For example,
    * BusSyncReply on_bus_sync_message(const Glib::RefPtr<Gst::Bus>& bus, const
-   * Glib::RefPtr<Gst::Message>& message);
+   * Glib::RefPtr<Gst::Message>& message);.
    */
   typedef sigc::slot< BusSyncReply, const Glib::RefPtr<Bus>&, const Glib::RefPtr<Message>& > SlotMessageSync;
 

Modified: gstreamermm/trunk/gstreamer/src/clock.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/clock.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/clock.hg	Wed Jul 30 22:22:04 2008
@@ -72,8 +72,8 @@
 public:
   /** For example,
    * bool on_clock(const Glib::RefPtr<Gst::Clock>& clock, ClockTime time, const
-   * Glib::RefPtr<Gst::ClockID>& id);
-   * The clock function return value is currently unused (see GstClockCallback)
+   * Glib::RefPtr<Gst::ClockID>& id);.
+   * The clock function return value is currently unused (see GstClockCallback).
    */
   typedef sigc::slot< bool, const Glib::RefPtr<Clock>&, ClockTime, const Glib::RefPtr<ClockID>& > SlotClock;
 

Modified: gstreamermm/trunk/gstreamer/src/element.ccg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/element.ccg	(original)
+++ gstreamermm/trunk/gstreamer/src/element.ccg	Wed Jul 30 22:22:04 2008
@@ -68,7 +68,7 @@
     throw std::runtime_error("failed to link: " + get_name() + "->" + dest->get_name());
 }
 
-Glib::RefPtr<Pad> Element::get_compatible_pad(const Glib::RefPtr<Pad>& pad, const Glib::RefPtr<Caps>& caps)
+Glib::RefPtr<Pad> Element::create_compatible_pad(const Glib::RefPtr<Pad>& pad, const Glib::RefPtr<Caps>& caps)
 {
   GstPad* c_pad = gst_element_get_compatible_pad(gobj(), pad->gobj(), caps->gobj());
   return Glib::wrap(c_pad); //gst_element_get_compatible_pad gives us a reference.

Modified: gstreamermm/trunk/gstreamer/src/element.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/element.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/element.hg	Wed Jul 30 22:22:04 2008
@@ -144,7 +144,6 @@
   Glib::RefPtr<Element> link(const Glib::RefPtr<Element>& dest);
 
   _WRAP_METHOD(bool add_pad(const Glib::RefPtr<Pad>& pad), gst_element_add_pad)
-
   //TODO: Remove this (and make sure it is really deprecated in the C API),
   //because the C API says it should not be used because it has unclear refcounting:
   //I asked for that in http://bugzilla.gnome.org/show_bug.cgi?id=533865
@@ -152,9 +151,8 @@
 
   _WRAP_METHOD(void create_all_pads(), gst_element_create_all_pads)
 
-  //TODO: If these get* functions are creators, then maybe rename to create*()? murrayc
   //TODO: Can these be const?
-  Glib::RefPtr<Pad> get_compatible_pad(const Glib::RefPtr<Pad>& pad, const Glib::RefPtr<Caps>& caps);
+  Glib::RefPtr<Pad> create_compatible_pad(const Glib::RefPtr<Pad>& pad, const Glib::RefPtr<Caps>& caps);
   Glib::RefPtr<PadTemplate> get_compatible_pad_template(const Glib::RefPtr<PadTemplate>& padtemplate);
 
   //TODO: The documentation says "The pad should be released with gst_element_release_request_pad().", which is odd. murrayc

Modified: gstreamermm/trunk/gstreamer/src/filter.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/filter.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/filter.hg	Wed Jul 30 22:22:04 2008
@@ -30,7 +30,7 @@
 {
 
 public:
-  /** For example, bool on_filter(const Glib::RefPtr<Glib::Object>& object);
+  /** For example, bool on_filter(const Glib::RefPtr<Glib::Object>& object);.
    * The filter function should return true if object is a match, false
    * otherwise.
    */

Modified: gstreamermm/trunk/gstreamer/src/gst_docs.xml
==============================================================================
--- gstreamermm/trunk/gstreamer/src/gst_docs.xml	(original)
+++ gstreamermm/trunk/gstreamer/src/gst_docs.xml	Wed Jul 30 22:22:04 2008
@@ -4638,34 +4638,6 @@
 <return></return>
 </function>
 
-<function name="gst_net_time_packet_receive">
-<description>
-Receives a #GstNetTimePacket over a socket. Handles interrupted system calls,
-but otherwise returns NULL on error. See recvfrom(2) for more information on
-how to interpret @sockaddr.
-
-MT safe. Caller owns return value (g_free to free).
-
-
-</description>
-<parameters>
-<parameter name="fd">
-<parameter_description> a file descriptor created by socket(2)
-</parameter_description>
-</parameter>
-<parameter name="addr">
-<parameter_description> a pointer to a sockaddr to hold the address of the sender
-</parameter_description>
-</parameter>
-<parameter name="len">
-<parameter_description> a pointer to the size of the data pointed to by @addr
-</parameter_description>
-</parameter>
-</parameters>
-<return> The new #GstNetTimePacket.
-</return>
-</function>
-
 <function name="gst_tag_list_foreach">
 <description>
 Calls the given function for each tag inside the tag list. Note that if there
@@ -4789,15 +4761,6 @@
 </return>
 </function>
 
-<function name="scan">
-<description>
-
-</description>
-<parameters>
-</parameters>
-<return></return>
-</function>
-
 <function name="gst_system_clock_obtain">
 <description>
 Get a handle to the default system clock. The refcount of the
@@ -5410,7 +5373,7 @@
 </parameter_description>
 </parameter>
 </parameters>
-<return> the minumum of the range
+<return> the minimum of the range
 </return>
 </function>
 
@@ -8333,7 +8296,8 @@
 <function name="gst_ghost_pad_set_target">
 <description>
 Set the new target of the ghostpad @gpad. Any existing target
-is unlinked and links to the new target are established.
+is unlinked and links to the new target are established. if @newtarget is
+NULL the target will be cleared.
 
 
 </description>
@@ -11916,13 +11880,16 @@
 </return>
 </function>
 
-<function name="the">
+<function name="gst_lfo_control_source_new">
 <description>
+This returns a new, unbound #GstLFOControlSource.
+
 
 </description>
 <parameters>
 </parameters>
-<return></return>
+<return> a new, unbound #GstLFOControlSource.
+</return>
 </function>
 
 <function name="gst_bus_pop">
@@ -13525,7 +13492,7 @@
 </parameter_description>
 </parameter>
 </parameters>
-<return> the minumum of the range
+<return> the minimum of the range
 </return>
 </function>
 
@@ -16180,7 +16147,7 @@
 </parameter_description>
 </parameter>
 <parameter name="debug">
-<parameter_description> A debugging string for something or other.
+<parameter_description> A debugging string.
 </parameter_description>
 </parameter>
 </parameters>
@@ -18730,13 +18697,32 @@
 <return></return>
 </function>
 
-<function name="input">
+<function name="gst_net_time_packet_receive">
 <description>
+Receives a #GstNetTimePacket over a socket. Handles interrupted system calls,
+but otherwise returns NULL on error. See recvfrom(2) for more information on
+how to interpret @sockaddr.
+
+MT safe. Caller owns return value (g_free to free).
+
 
 </description>
 <parameters>
+<parameter name="fd">
+<parameter_description> a file descriptor created by socket(2)
+</parameter_description>
+</parameter>
+<parameter name="addr">
+<parameter_description> a pointer to a sockaddr to hold the address of the sender
+</parameter_description>
+</parameter>
+<parameter name="len">
+<parameter_description> a pointer to the size of the data pointed to by @addr
+</parameter_description>
+</parameter>
 </parameters>
-<return></return>
+<return> The new #GstNetTimePacket.
+</return>
 </function>
 
 <function name="gst_registry_add_plugin">
@@ -20441,7 +20427,7 @@
 </parameter_description>
 </parameter>
 <parameter name="debug">
-<parameter_description> A debugging string for something or other.
+<parameter_description> A debugging string.
 </parameter_description>
 </parameter>
 </parameters>
@@ -20623,7 +20609,7 @@
 </parameter_description>
 </parameter>
 <parameter name="debug">
-<parameter_description> A debugging string for something or other.
+<parameter_description> A debugging string.
 </parameter_description>
 </parameter>
 </parameters>
@@ -21227,15 +21213,6 @@
 </return>
 </function>
 
-<function name="The">
-<description>
-
-</description>
-<parameters>
-</parameters>
-<return></return>
-</function>
-
 <function name="gst_element_set_bus">
 <description>
 Sets the bus of the element. Increases the refcount on the bus.
@@ -21535,18 +21512,6 @@
 </return>
 </function>
 
-<function name="gst_lfo_control_source_new">
-<description>
-This returns a new, unbound #GstLFOControlSource.
-
-
-</description>
-<parameters>
-</parameters>
-<return> a new, unbound #GstLFOControlSource.
-</return>
-</function>
-
 <function name="gst_element_seek_simple">
 <description>
 Simple API to perform a seek on the given element, meaning it just seeks

Modified: gstreamermm/trunk/gstreamer/src/index.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/index.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/index.hg	Wed Jul 30 22:22:04 2008
@@ -87,7 +87,7 @@
   _WRAP_METHOD(IndexEntry get_assoc_entry(int id, IndexLookupMethod method, AssocFlags flags, Format format, gint64 value) const, gst_index_get_assoc_entry)
 
   /** For example,
-   * bool on_filter(const Glib::RefPtr<Gst::Index>& index, IndexEntry entry);
+   * bool on_filter(const Glib::RefPtr<Gst::Index>& index, IndexEntry entry);.
    * The filter function should return true if the entry is to be added to the
    * index, false otherwise.
    */ 
@@ -97,7 +97,7 @@
 
   /** For example,
    * bool on_resolve(const Glib::RefPtr<Gst::Object>& writer, Glib::ustring&
-   * writer_string);
+   * writer_string);.
    * The resolve function should return true if an id could be assigned to
    * writer.
    */ 

Modified: gstreamermm/trunk/gstreamer/src/pad.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/pad.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/pad.hg	Wed Jul 30 22:22:04 2008
@@ -83,15 +83,15 @@
 
 public:
   /** For example,
-   * void on_block(const Glib::RefPtr<Gst::Pad>& pad, bool blocked);
+   * void on_block(const Glib::RefPtr<Gst::Pad>& pad, bool blocked);.
    */
   typedef sigc::slot<void, const Glib::RefPtr<Pad>&, bool> SlotBlock;
 
   /** For example,
    * bool on_have_data(const Glib::RefPtr<Gst::Pad>& pad, const
-   * Glib::RefPtr<Gst::MiniObjec>& data);
-   * The on_have_data method should return true to keep the data in the
-   * pipeline, false to drop it (throw it away)
+   * Glib::RefPtr<Gst::MiniObjec>& data);.
+   * The data method should return true to keep the data in the pipeline, false
+   * to drop it (throw it away).
    */
   typedef sigc::slot< bool, const Glib::RefPtr<Pad>&, const Glib::RefPtr<MiniObject>& > SlotData;
 

Modified: gstreamermm/trunk/gstreamer/src/plugin.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/plugin.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/plugin.hg	Wed Jul 30 22:22:04 2008
@@ -65,7 +65,7 @@
 
 public:
   /** For example,
-   * bool on_plugin_filter(const Glib::RefPtr<Gst::Plugin>& plugin);
+   * bool on_plugin_filter(const Glib::RefPtr<Gst::Plugin>& plugin);.
    * The filter function should return true if plugin is a match, false
    * otherwise.
    */

Modified: gstreamermm/trunk/gstreamer/src/pluginfeature.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/pluginfeature.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/pluginfeature.hg	Wed Jul 30 22:22:04 2008
@@ -38,7 +38,7 @@
 
 public:
   /** For example,
-   * bool on_filter(const Glib::RefPtr<Gst::PluginFeature>& feature);
+   * bool on_filter(const Glib::RefPtr<Gst::PluginFeature>& feature);.
    * The filter function should return true if the feature is a match, false
    * otherwise.
    */

Modified: gstreamermm/trunk/gstreamer/src/structure.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/structure.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/structure.hg	Wed Jul 30 22:22:04 2008
@@ -268,7 +268,7 @@
   //TODO: Remove any use of Quarks from the API, using plain strings instead? They seem like implementation detail. murrayc.
 
   /** For example,
-   * bool on_foreach(const Glib::QueryQuark& id, const Glib::ValueBase& value);
+   * bool on_foreach(const Glib::QueryQuark& id, const Glib::ValueBase& value);.
    * The foreach function should return true if foreach operation should
    * continue, false if operation should stop with false.
    */
@@ -475,7 +475,7 @@
   bool get_field(const Glib::ustring& fieldname, Gst::FractionRange& value) const;
 
   /** For example,
-   * bool on_map(const Glib::QueryQuark& id, Glib::ValueBase& value);
+   * bool on_map(const Glib::QueryQuark& id, Glib::ValueBase& value);.
    * The map function should return true if map operation should continue,
    * false if operation should stop with false.
    */

Modified: gstreamermm/trunk/gstreamer/src/taglist.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/taglist.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/taglist.hg	Wed Jul 30 22:22:04 2008
@@ -308,7 +308,7 @@
   _WRAP_METHOD(void remove_tag(const Glib::ustring& tag), gst_tag_list_remove_tag)
 
   /** For example,
-   * void on_foreach(const Glib::ustring& tag);
+   * void on_foreach(const Glib::ustring& tag);.
    */
   typedef sigc::slot<void, const Glib::ustring&> SlotForeach;
 

Modified: gstreamermm/trunk/gstreamer/src/task.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/task.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/task.hg	Wed Jul 30 22:22:04 2008
@@ -66,7 +66,7 @@
 
 public:
   /** For example,
-   * void on_do_task();
+   * void on_do_task();.
    */
   typedef sigc::slot<void> SlotTask;
 



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