From 71d77fbecc695e30105a7f51ba9a14f78771addd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim-Philipp=20M=C3=BCller?= Date: Sat, 21 Apr 2007 15:10:25 +0000 Subject: [PATCH] Some minor docs fixes and additions; also add missing 'Since' bits. Original commit message from CVS: * docs/libs/gst-plugins-base-libs.types: * gst-libs/gst/rtp/gstbasertpaudiopayload.c: (gst_base_rtp_audio_payload_class_init): * gst-libs/gst/rtp/gstbasertpdepayload.c: * gst-libs/gst/rtp/gstbasertppayload.c: Some minor docs fixes and additions; also add missing 'Since' bits. --- ChangeLog | 9 +++++++++ docs/libs/gst-plugins-base-libs.types | 2 ++ gst-libs/gst/rtp/gstbasertpaudiopayload.c | 11 +++++++++++ gst-libs/gst/rtp/gstbasertpdepayload.c | 11 +++++++++++ gst-libs/gst/rtp/gstbasertppayload.c | 13 +++++++++++++ 5 files changed, 46 insertions(+) diff --git a/ChangeLog b/ChangeLog index d238178ff7..6b9d3dbe8f 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,12 @@ +2007-04-21 Tim-Philipp Müller + + * docs/libs/gst-plugins-base-libs.types: + * gst-libs/gst/rtp/gstbasertpaudiopayload.c: + (gst_base_rtp_audio_payload_class_init): + * gst-libs/gst/rtp/gstbasertpdepayload.c: + * gst-libs/gst/rtp/gstbasertppayload.c: + Some minor docs fixes and additions; also add missing 'Since' bits. + 2007-04-21 Tim-Philipp Müller Patch by: Zeeshan Ali diff --git a/docs/libs/gst-plugins-base-libs.types b/docs/libs/gst-plugins-base-libs.types index 3e670fced7..a2e5205a38 100644 --- a/docs/libs/gst-plugins-base-libs.types +++ b/docs/libs/gst-plugins-base-libs.types @@ -46,6 +46,8 @@ gst_x_overlay_get_type gst_base_rtp_depayload_get_type #include gst_basertppayload_get_type +#include +gst_base_rtp_audio_payload_get_type #include diff --git a/gst-libs/gst/rtp/gstbasertpaudiopayload.c b/gst-libs/gst/rtp/gstbasertpaudiopayload.c index f260502155..b2d002a4a7 100644 --- a/gst-libs/gst/rtp/gstbasertpaudiopayload.c +++ b/gst-libs/gst/rtp/gstbasertpaudiopayload.c @@ -161,6 +161,13 @@ gst_base_rtp_audio_payload_class_init (GstBaseRTPAudioPayloadClass * klass) gstelement_class->change_state = GST_DEBUG_FUNCPTR (gst_base_rtp_payload_audio_change_state); + /** + * GstBaseRTPAudioPayload:min-ptime: + * + * Minimum duration of the packet data in ns (can't go above MTU) + * + * Since: 0.10.13 + **/ g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_MIN_PTIME, g_param_spec_int64 ("min-ptime", "Min packet time", "Minimum duration of the packet data in ns (can't go above MTU)", @@ -612,6 +619,8 @@ gst_base_rtp_audio_payload_handle_sample_based_buffer (GstBaseRTPPayload * * the buffer downstream. * * Returns: a #GstFlowReturn + * + * Since: 0.10.13 */ GstFlowReturn gst_base_rtp_audio_payload_push (GstBaseRTPAudioPayload * baseaudiopayload, @@ -737,6 +746,8 @@ gst_base_rtp_payload_audio_handle_event (GstPad * pad, GstEvent * event, * Gets the internal adapter used by the depayloader. * * Returns: a #GstAdapter. + * + * Since: 0.10.13 */ GstAdapter * gst_base_rtp_audio_payload_get_adapter (GstBaseRTPAudioPayload diff --git a/gst-libs/gst/rtp/gstbasertpdepayload.c b/gst-libs/gst/rtp/gstbasertpdepayload.c index 871eb7ae18..66b72e34ad 100644 --- a/gst-libs/gst/rtp/gstbasertpdepayload.c +++ b/gst-libs/gst/rtp/gstbasertpdepayload.c @@ -18,6 +18,17 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:gstbasertpdepayload + * @short_description: Base class for RTP depayloader + * + * + * + * Provides a base class for RTP depayloaders + * + * + */ + #include "gstbasertpdepayload.h" GST_DEBUG_CATEGORY_STATIC (basertpdepayload_debug); diff --git a/gst-libs/gst/rtp/gstbasertppayload.c b/gst-libs/gst/rtp/gstbasertppayload.c index 7a53d919bd..237daaf431 100644 --- a/gst-libs/gst/rtp/gstbasertppayload.c +++ b/gst-libs/gst/rtp/gstbasertppayload.c @@ -12,6 +12,17 @@ * Library General Public License for more */ +/** + * SECTION:gstbasertppayload + * @short_description: Base class for RTP payloader + * + * + * + * Provides a base class for RTP payloaders + * + * + */ + #ifdef HAVE_CONFIG_H # include "config.h" #endif @@ -79,6 +90,8 @@ static GstStateChangeReturn gst_basertppayload_change_state (GstElement * static GstElementClass *parent_class = NULL; +/* FIXME 0.11: API should be changed to gst_base_typ_payload_xyz */ + GType gst_basertppayload_get_type (void) {