gstreamer/gst-libs/gst/rtp
Matthew Waters a77c316590 rtp/hdrext: correct gst_rtp_get_header_extension_list() docs
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>
2021-05-04 15:40:30 +10:00
..
gstrtcpbuffer.c rtcpbuffer: Notify error in case packet can not be added to an RTCP compound packet 2020-07-10 14:16:10 +00:00
gstrtcpbuffer.h rtcpbuffer: add RTPFB_TYPE_TWCC for Transport-Wide Congestion Control 2019-11-05 12:42:52 +00:00
gstrtpbaseaudiopayload.c audio: video: Optimize by using cached quark for meta tag 2020-06-27 09:23:10 +00:00
gstrtpbaseaudiopayload.h Use G_DEFINE_AUTOPTR_CLEANUP_FUNC unconditionally 2019-06-04 20:31:09 -04:00
gstrtpbasedepayload.c rtp: Fix request-extension signal call 2021-04-28 22:50:53 -04:00
gstrtpbasedepayload.h Use G_DEFINE_AUTOPTR_CLEANUP_FUNC unconditionally 2019-06-04 20:31:09 -04:00
gstrtpbasepayload.c rtp: Fix request-extension signal call 2021-04-28 22:50:53 -04:00
gstrtpbasepayload.h rtpbasepayload: pass optional caps fields in a GstStructure 2020-12-05 08:29:31 +00:00
gstrtpbuffer.c rtpbuffer: make sure header extension buffer is initialized 2021-04-03 09:39:02 +00:00
gstrtpbuffer.h rtpbuffer: add gst_rtp_buffer_get_extension_onebyte_header_from_bytes 2020-02-04 08:44:43 +00:00
gstrtpdefs.h libs: Documentation cleanup 2018-04-02 08:53:28 +02:00
gstrtphdrext.c rtp/hdrext: correct gst_rtp_get_header_extension_list() docs 2021-05-04 15:40:30 +10:00
gstrtphdrext.h rtphdrext: allow updating depayloader src caps 2021-03-12 18:45:04 +01:00
gstrtpmeta.c gst: don't use volatile to mean atomic 2021-03-19 04:20:19 +00:00
gstrtpmeta.h rtp: fix g-i warnings 2018-12-16 23:15:57 +00:00
gstrtppayloads.c Pass the code through codespell 2019-08-30 13:05:36 +00:00
gstrtppayloads.h rtp: GST_EXPORT -> GST_RTP_API 2018-03-13 12:16:42 +00:00
meson.build Meson: Use pkg-config generator 2020-10-23 11:19:11 -04:00
README Pass the code through codespell 2019-08-30 13:05:36 +00:00
rtp-prelude.h libs: fix API export/import and 'inconsistent linkage' on MSVC 2018-09-24 08:45:34 +01:00
rtp.h rtpbasepayload: rtpbasedepayload: Add source-info property 2018-10-10 14:38:01 -04:00

The RTP libraries
---------------------

  RTP Buffers
  -----------
  The real time protocol as described in RFC 3550 requires the use of special
  packets containing an additional RTP header of at least 12 bytes. GStreamer
  provides some helper functions for creating and parsing these RTP headers.
  The result is a normal #GstBuffer with an additional RTP header.
 
  RTP buffers are usually created with gst_rtp_buffer_new_allocate() or
  gst_rtp_buffer_new_allocate_len(). These functions create buffers with a
  preallocated space of memory. It will also ensure that enough memory
  is allocated for the RTP header. The first function is used when the payload
  size is known. gst_rtp_buffer_new_allocate_len() should be used when the size
  of the whole RTP buffer (RTP header + payload) is known.
 
  When receiving RTP buffers from a network, gst_rtp_buffer_new_take_data()
  should be used when the user would like to parse that RTP packet. (TODO Ask
  Wim what the real purpose of this function is as it seems to simply create a
  duplicate GstBuffer with the same data as the previous one). The
  function will create a new RTP buffer with the given data as the whole RTP
  packet. Alternatively, gst_rtp_buffer_new_copy_data() can be used if the user
  wishes to make a copy of the data before using it in the new RTP buffer.
 
  It is now possible to use all the gst_rtp_buffer_get_*() or
  gst_rtp_buffer_set_*() functions to read or write the different parts of the
  RTP header such as the payload type, the sequence number or the RTP
  timestamp. The use can also retrieve a pointer to the actual RTP payload data
  using the gst_rtp_buffer_get_payload() function.

  RTP Base Payloader Class (GstBaseRTPPayload)
  --------------------------------------------

  All RTP payloader elements (audio or video) should derive from this class.

  RTP Base Audio Payloader Class (GstBaseRTPAudioPayload)
  -------------------------------------------------------

  This base class can be tested through it's children classes. Here is an
  example using the iLBC payloader (frame based).

  For 20ms mode :

  GST_DEBUG="basertpaudiopayload:5" gst-launch-1.0 fakesrc sizetype=2
  sizemax=114 datarate=1900 ! audio/x-iLBC, mode=20 !  rtpilbcpay
  max-ptime="40000000" ! fakesink

  For 30ms mode :

  GST_DEBUG="basertpaudiopayload:5" gst-launch-1.0 fakesrc sizetype=2
  sizemax=150 datarate=1662 ! audio/x-iLBC, mode=30 !  rtpilbcpay
  max-ptime="60000000" ! fakesink

  Here is an example using the uLaw payloader (sample based).

  GST_DEBUG="basertpaudiopayload:5" gst-launch-1.0 fakesrc sizetype=2
  sizemax=150 datarate=8000 ! audio/x-mulaw ! rtppcmupay max-ptime="6000000" !
  fakesink

  RTP Base Depayloader Class (GstBaseRTPDepayload)
  ------------------------------------------------

  All RTP depayloader elements (audio or video) should derive from this class.