rtp/hdrext: correct gst_rtp_get_header_extension_list() docs
authorMatthew Waters <matthew@centricular.com>
Tue, 4 May 2021 05:38:18 +0000 (15:38 +1000)
committerMatthew Waters <matthew@centricular.com>
Tue, 4 May 2021 05:40:30 +0000 (15:40 +1000)
The return value is a list of GstElementFactory's that when
gst_element_factory_create()ed will create a GstRTPHeaderExtension.

Fixes https://gitlab.freedesktop.org/gstreamer/gst-plugins-base/-/issues/897

Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-plugins-base/-/merge_requests/1136>

gst-libs/gst/rtp/gstrtphdrext.c

index e324359..292767a 100644 (file)
@@ -654,10 +654,12 @@ gst_rtp_ext_list_filter (GstPluginFeature * feature, gpointer user_data)
 /**
  * gst_rtp_get_header_extension_list:
  *
- * Retrieve all the currently registered RTP header extensions
+ * Retrieve all the factories of the currently registered RTP header
+ * extensions.  Call gst_element_factory_create() with each factory to create
+ * the associated #GstRTPHeaderExtension.
  *
- * Returns: (transfer full) (element-type GstRTPHeaderExtension): a #GList of
- *     #GstRTPHeaderExtension. Use gst_plugin_feature_list_free() after use
+ * Returns: (transfer full) (element-type GstElementFactory): a #GList of
+ *     #GstElementFactory's. Use gst_plugin_feature_list_free() after use
  *
  * Since: 1.20
  */