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

[jaalburqu svn gnome org]

Author: jaalburqu
Date: Wed Apr 16 05:52:28 2008
New Revision: 1465
URL: http://svn.gnome.org/viewvc/gnomemm?rev=1465&view=rev

Log:
2008-04-16  Josà Alburquerque  <jaalburqu svn gnome org>

	* gstreamer/src/element.hg:
	* gstreamer/src/elementfactory.hg: Used article 'an' instead of 'a'
	where appropriate in class docs

	* gstreamer/src/pad.hg:
	* gstreamer/src/systemclock.hg: Added class docs

	* gstreamer/src/pipeline.hg: Wrapped properties (no signals or vfuncs)

Modified:
   gstreamermm/trunk/ChangeLog
   gstreamermm/trunk/gstreamer/src/element.hg
   gstreamermm/trunk/gstreamer/src/elementfactory.hg
   gstreamermm/trunk/gstreamer/src/pad.hg
   gstreamermm/trunk/gstreamer/src/pipeline.hg
   gstreamermm/trunk/gstreamer/src/systemclock.hg

Modified: gstreamermm/trunk/gstreamer/src/element.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/element.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/element.hg	Wed Apr 16 05:52:28 2008
@@ -66,10 +66,10 @@
  * be used in a GStreamer pipeline. Please refer to the plugin writers guide
  * for more information on creating Element subclasses.
  *
- * The name of a Element can be get with get_name() and set with set_name().
+ * The name of an Element can be get with get_name() and set with set_name().
  *
  * All elements have pads (of the type Pad). These pads link to pads on other
- * elements. Buffer flow between these linked pads. A Element has a GList of
+ * elements. Buffer flow between these linked pads. An Element has a GList of
  * Pad structures for all their input (or sink) and output (or source) pads.
  * Core and plug-in writers can add and remove pads with add_pad() and
  * remove_pad().

Modified: gstreamermm/trunk/gstreamer/src/elementfactory.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/elementfactory.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/elementfactory.hg	Wed Apr 16 05:52:28 2008
@@ -33,11 +33,10 @@
 class Plugin;
 
 /** ElementFactory â Create Elements from a factory.
- * ElementFactory is used to create instances of elements. A Elementfactory can
- * be added to a Plugin as it is also a PluginFeature.
- *
- * Use the find() and create() functions to create element instances. or use
- * the static create() as a convenient shortcut.
+ * ElementFactory is used to create instances of elements. An Elementfactory
+ * can be added to a Plugin as it is also a PluginFeature.  Use the find() and
+ * create() functions to create element instances. or use the static create()
+ * as a convenient shortcut.
  *
  * The following code example shows you how to create a GstFileSrc element.
  *

Modified: gstreamermm/trunk/gstreamer/src/pad.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/pad.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/pad.hg	Wed Apr 16 05:52:28 2008
@@ -43,6 +43,35 @@
 _WRAP_ENUM(FlowReturn, GstFlowReturn)
 _WRAP_ENUM(ActivateMode, GstActivateMode)
 
+/** Pad â Object contained by elements that allows links to other elements.
+ * An Element is linked to other elements via "pads", which are extremely
+ * light-weight generic link points. After two pads are retrieved from an
+ * element with Element::get_pad(), the pads can be link with link(). (For
+ * quick links, you can also use Element::link(), which will make the obvious
+ * link for you if it's straightforward.)
+ *
+ * Pads are typically created from a PadTemplate with the create() method that
+ * takes a PadTemplate.
+ *
+ * Pads have Caps attached to it to describe the media type they are capable of
+ * dealing with. get_caps() and set_caps() are used to manipulate the caps of
+ * the pads. Pads created from a pad template cannot set capabilities that are
+ * incompatible with the pad template capabilities.
+ *
+ * Pads without pad templates can be created with create(), which takes a
+ * direction and a name as an argument.
+ *
+ * get_parent_element() will retrieve the Element that owns the pad.
+ *
+ * An Element creating a pad will typically use the underlying C API to
+ * register callbacks for various events on the pads.
+ *
+ * Elements will use push() and pull_range() to push out or pull in a buffer.
+ *
+ * To send an Event on a pad, use send_event() and push_event().
+ *
+ * Last reviewed on 2006-07-06 (0.10.9)
+ */
 class Pad : public Object 
 {
   _CLASS_GOBJECT(Pad, GstPad, GST_PAD, Object, GstObject)

Modified: gstreamermm/trunk/gstreamer/src/pipeline.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/pipeline.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/pipeline.hg	Wed Apr 16 05:52:28 2008
@@ -100,6 +100,9 @@
   _WRAP_METHOD(bool get_auto_flush_bus() const, gst_pipeline_get_auto_flush_bus)
   _WRAP_METHOD(void set_delay(ClockTime delay), gst_pipeline_set_delay)
   _WRAP_METHOD(ClockTime get_delay() const, gst_pipeline_get_delay)
+
+  _WRAP_PROPERTY("auto-flush-bus", bool)
+  _WRAP_PROPERTY("delay", ClockTime)
 };
 
 } //namespace Gst

Modified: gstreamermm/trunk/gstreamer/src/systemclock.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/systemclock.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/systemclock.hg	Wed Apr 16 05:52:28 2008
@@ -25,6 +25,20 @@
 
 namespace Gst
 {
+
+/** SystemClock â Default clock that uses the current system time.
+ * The GStreamer core provides a SystemClock based on the system time.
+ * Asynchronous callbacks are scheduled from an internal thread.
+ *
+ * Clock implementors are encouraged to subclass this systemclock as it
+ * implements the async notification.
+ *
+ * Subclasses can however override all of the important methods for sync and
+ * async notifications to implement their own callback methods or blocking wait
+ * operations.
+ *
+ * Last reviewed on 2006-03-08 (0.10.4)
+ */
 class SystemClock : public Clock
 {
   _CLASS_GOBJECT(SystemClock, GstSystemClock, GST_SYSTEM_CLOCK, Clock, GstClock)