Commit f6827728 authored by Stian Selnes's avatar Stian Selnes Committed by Tim-Philipp Müller

rtph261pay: rtph261depay: Add documentation

https://bugzilla.gnome.org/show_bug.cgi?id=751982
parent 83ccc4c1
......@@ -134,6 +134,8 @@
<xi:include href="xml/element-rtpamrpay.xml" />
<xi:include href="xml/element-rtpbvdepay.xml" />
<xi:include href="xml/element-rtpbvpay.xml" />
<xi:include href="xml/element-rtph261depay.xml" />
<xi:include href="xml/element-rtph261pay.xml" />
<xi:include href="xml/element-rtpL16depay.xml" />
<xi:include href="xml/element-rtpL16pay.xml" />
<xi:include href="xml/element-rtpj2kpay.xml" />
......
......@@ -1744,6 +1744,36 @@ gst_rtp_bv_pay_plugin_init
gst_rtp_bv_pay_get_type
</SECTION>
<SECTION>
<FILE>element-rtph261depay</FILE>
<TITLE>rtph261depay</TITLE>
GstRtpH261Depay
<SUBSECTION Standard>
GstRtpH261DepayClass
GST_RTP_H261_DEPAY
GST_IS_RTP_H261_DEPAY
GST_TYPE_RTP_H261_DEPAY
GST_RTP_H261_DEPAY_CLASS
GST_IS_RTP_H261_DEPAY_CLASS
gst_rtp_h261_depay_plugin_init
gst_rtp_h261_depay_get_type
</SECTION>
<SECTION>
<FILE>element-rtph261pay</FILE>
<TITLE>rtph261pay</TITLE>
GstRtpH261Pay
<SUBSECTION Standard>
GstRtpH261PayClass
GST_RTP_H261_PAY
GST_IS_RTP_H261_PAY
GST_TYPE_RTP_H261_PAY
GST_RTP_H261_PAY_CLASS
GST_IS_RTP_H261_PAY_CLASS
gst_rtp_h261_pay_plugin_init
gst_rtp_h261_pay_get_type
</SECTION>
<SECTION>
<FILE>element-rtpL16depay</FILE>
<TITLE>rtpL16depay</TITLE>
......
......@@ -18,6 +18,26 @@
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION:element-rtph261depay
* @see_also: rtph261pay
*
* Extract encoded H.261 video frames from RTP packets according to RFC 4587.
* For detailed information see: https://www.rfc-editor.org/rfc/rfc4587.txt
*
* The depayloader takes an RTP packet and extracts its H.261 stream. It
* aggregates the extracted stream until a complete frame is received before
* it pushes it downstream.
*
* <refsect2>
* <title>Example pipeline</title>
* |[
* gst-launch-1.0 udpsrc caps='application/x-rtp, payload=31' ! rtph261depay ! avdec_h261 ! autovideosink
* ]| This example pipeline will depayload and decode an RTP H.261 video stream.
* Refer to the rtph261pay example to create the RTP stream.
* </refsect2>
*/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
......
......@@ -18,6 +18,32 @@
*
*/
/**
* SECTION:element-rtph261pay
* @see_also: rtph261depay
*
* Payload encoded H.261 video frames into RTP packets according to RFC 4587.
* For detailed information see: https://www.rfc-editor.org/rfc/rfc4587.txt
*
* The payloader takes a H.261 frame, parses it and splits it into fragments
* on MB boundaries in order to match configured MTU size. For each fragment
* an RTP packet is constructed with an RTP packet header followed by the
* fragment. In addition the payloader will make sure the packetized H.261
* stream appears as a continuous bit-stream after depacketization by shifting
* the encoded bit-stream of a frame to align with the last significant bit of
* the previous frame. This helps interoperability in the case where the
* encoder does not produce a continuous bit-stream but the decoder requires
* it.
*
* <refsect2>
* <title>Example launch line</title>
* |[
* gst-launch-1.0 videotestsrc ! avenc_h261 ! rtph261pay ! udpsink
* ]| This will encode a test video and payload it. Refer to the rtph261depay
* example to depayload and play the RTP stream.
* </refsect2>
*/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment