From 35a1822d7aea497876618bbc685360f7837aada2 Mon Sep 17 00:00:00 2001 From: Wim Taymans Date: Fri, 2 May 2014 17:42:58 +0200 Subject: [PATCH] pads: update docs for request pads We would like to encourage the use of gst_element_request_pad() --- gst/gstelement.c | 9 ++++----- gst/gstpadtemplate.h | 2 +- plugins/elements/gstmultiqueue.c | 2 +- 3 files changed, 6 insertions(+), 7 deletions(-) diff --git a/gst/gstelement.c b/gst/gstelement.c index dc29053..cc96d25 100644 --- a/gst/gstelement.c +++ b/gst/gstelement.c @@ -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 diff --git a/gst/gstpadtemplate.h b/gst/gstpadtemplate.h index 2700e9b..636b143 100644 --- a/gst/gstpadtemplate.h +++ b/gst/gstpadtemplate.h @@ -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. */ diff --git a/plugins/elements/gstmultiqueue.c b/plugins/elements/gstmultiqueue.c index 51b4390..8f81f8f 100644 --- a/plugins/elements/gstmultiqueue.c +++ b/plugins/elements/gstmultiqueue.c @@ -38,7 +38,7 @@ * achieve such a feature it has request sink pads (sink%u) and * 'sometimes' src pads (src%u). * - * 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. * -- 2.7.4