mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-03-28 11:55:39 +00:00
Code Issues 1 Projects Releases Wiki Activity

pads: update docs for request pads

Browse source 
We would like to encourage the use of gst_element_request_pad()
This commit is contained in:
Wim Taymans 2014-05-02 17:42:58 +02:00
parent a10ca2ee13
commit 35a1822d7a
3 changed files with 6 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
gst/gstelement.c
View file

@ -43,8 +43,7 @@
*
* 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_\%u".
* gst_element_request_pad() with a #GstPadTemplate.
* An iterator of all pads can be retrieved with gst_element_iterate_pads().
*
* Elements can be linked through their pads.
@ -306,10 +305,10 @@ gst_element_init (GstElement * element)
* @pad: the #GstPad to release.
*
* Makes the element free the previously requested pad as obtained
* with gst_element_get_request_pad().
* with gst_element_request_pad().
*
* This does not unref the pad. If the pad was created by using
* gst_element_get_request_pad(), gst_element_release_request_pad() needs to be
* gst_element_request_pad(), gst_element_release_request_pad() needs to be
* followed by gst_object_unref() to free the @pad.
*
* MT safe.
@ -733,7 +732,7 @@ no_direction:
*
* This function is used by plugin developers and should not be used
* by applications. Pads that were dynamically requested from elements
* with gst_element_get_request_pad() should be released with the
* with gst_element_request_pad() should be released with the
* gst_element_release_request_pad() function instead.
*
* Pads are not automatically deactivated so elements should perform the needed

2
gst/gstpadtemplate.h
View file

@ -52,7 +52,7 @@ G_BEGIN_DECLS
* @GST_PAD_ALWAYS: the pad is always available
* @GST_PAD_SOMETIMES: the pad will become available depending on the media stream
* @GST_PAD_REQUEST: the pad is only available on request with
* gst_element_get_request_pad().
* gst_element_request_pad().
*
* Indicates when this pad will become available.
*/

2
plugins/elements/gstmultiqueue.c
View file

@ -38,7 +38,7 @@
* achieve such a feature it has request sink pads (sink%u) and
* 'sometimes' src pads (src%u).
* </para><para>
* When requesting a given sinkpad with gst_element_get_request_pad(),
* When requesting a given sinkpad with gst_element_request_pad(),
* the associated srcpad for that stream will be created.
* Example: requesting sink1 will generate src1.
* </para></listitem>