summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Kost <ensonic@users.sf.net>2011-08-20 14:07:55 +0200
committerStefan Kost <ensonic@users.sf.net>2011-08-20 14:07:55 +0200
commitcce32ba0a29cdebc34cf6bf66e72a3f554be3028 (patch)
tree7b8f43378b75d9727f8fd76661fe2c823c83b56b
parenta3611c139a4a0178c73ac29d5b105cbbcba7dc33 (diff)
docs: more clarification for element docs
Don't suggest deprecated method in the desction docs and try to be more helpful in other places by suggesting related functions.
-rw-r--r--gst/gstelement.c12
1 files changed, 9 insertions, 3 deletions
diff --git a/gst/gstelement.c b/gst/gstelement.c
index ac1372066..17c0c61bb 100644
--- a/gst/gstelement.c
+++ b/gst/gstelement.c
@@ -41,7 +41,10 @@
* Core and plug-in writers can add and remove pads with gst_element_add_pad()
* and gst_element_remove_pad().
*
- * A pad of an element can be retrieved by name with gst_element_get_pad().
+ * An existing pad of an element can be retrieved by name with
+ * gst_element_get_static_pad(). A new dynamic pad can be created using
+ * gst_element_request_pad() with a #GstPadTemplate or
+ * gst_element_get_request_pad() with the template name such as "src_%d".
* An iterator of all pads can be retrieved with gst_element_iterate_pads().
*
* Elements can be linked through their pads.
@@ -1154,6 +1157,8 @@ gst_element_get_request_pad (GstElement * element, const gchar * name)
* request. Can be %NULL.
*
* Retrieves a request pad from the element according to the provided template.
+ * Pad templates can be looked up using
+ * gst_element_factory_get_static_pad_templates().
*
* If the @caps are specified and the element implements thew new
* request_new_pad_full virtual method, the element will use them to select
@@ -1242,8 +1247,9 @@ gst_element_iterate_pad_list (GstElement * element, GList ** padlist)
* gst_element_iterate_pads:
* @element: a #GstElement to iterate pads of.
*
- * Retrieves an iterattor of @element's pads. The iterator should
- * be freed after usage.
+ * Retrieves an iterator of @element's pads. The iterator should
+ * be freed after usage. Also more specialized iterators exists such as
+ * gst_element_iterate_src_pads() or gst_element_iterate_sink_pads().
*
* Returns: (transfer full): the #GstIterator of #GstPad. Unref each pad
* after use.