docs: rtp library docs update
This commit is contained in:
parent
6bee2cb4ee
commit
269205b1ad
@ -21,12 +21,9 @@
|
|||||||
* SECTION:gstbasertpaudiopayload
|
* SECTION:gstbasertpaudiopayload
|
||||||
* @short_description: Base class for audio RTP payloader
|
* @short_description: Base class for audio RTP payloader
|
||||||
*
|
*
|
||||||
* <refsect2>
|
|
||||||
* <para>
|
|
||||||
* Provides a base class for audio RTP payloaders for frame or sample based
|
* Provides a base class for audio RTP payloaders for frame or sample based
|
||||||
* audio codecs (constant bitrate)
|
* audio codecs (constant bitrate)
|
||||||
* </para>
|
*
|
||||||
* <para>
|
|
||||||
* This class derives from GstBaseRTPPayload. It can be used for payloading
|
* This class derives from GstBaseRTPPayload. It can be used for payloading
|
||||||
* audio codecs. It will only work with constant bitrate codecs. It supports
|
* audio codecs. It will only work with constant bitrate codecs. It supports
|
||||||
* both frame based and sample based codecs. It takes care of packing up the
|
* both frame based and sample based codecs. It takes care of packing up the
|
||||||
@ -38,7 +35,8 @@
|
|||||||
* equal to min-ptime (if set). If min-ptime is not set, any residual data is
|
* equal to min-ptime (if set). If min-ptime is not set, any residual data is
|
||||||
* sent in a last RTP packet. In the case of frame based codecs, the resulting
|
* sent in a last RTP packet. In the case of frame based codecs, the resulting
|
||||||
* RTP packets always contain full frames.
|
* RTP packets always contain full frames.
|
||||||
* </para>
|
*
|
||||||
|
* <refsect2>
|
||||||
* <title>Usage</title>
|
* <title>Usage</title>
|
||||||
* <para>
|
* <para>
|
||||||
* To use this base class, your child element needs to call either
|
* To use this base class, your child element needs to call either
|
||||||
|
@ -61,10 +61,17 @@ struct _GstBaseRTPAudioPayload
|
|||||||
gpointer _gst_reserved[GST_PADDING];
|
gpointer _gst_reserved[GST_PADDING];
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* GstBaseRTPAudioPayloadClass:
|
||||||
|
* @parent_class: the parent class
|
||||||
|
*
|
||||||
|
* Base class for audio RTP payloader.
|
||||||
|
*/
|
||||||
struct _GstBaseRTPAudioPayloadClass
|
struct _GstBaseRTPAudioPayloadClass
|
||||||
{
|
{
|
||||||
GstBaseRTPPayloadClass parent_class;
|
GstBaseRTPPayloadClass parent_class;
|
||||||
|
|
||||||
|
/*< private >*/
|
||||||
gpointer _gst_reserved[GST_PADDING];
|
gpointer _gst_reserved[GST_PADDING];
|
||||||
};
|
};
|
||||||
|
|
||||||
|
@ -22,11 +22,7 @@
|
|||||||
* SECTION:gstbasertpdepayload
|
* SECTION:gstbasertpdepayload
|
||||||
* @short_description: Base class for RTP depayloader
|
* @short_description: Base class for RTP depayloader
|
||||||
*
|
*
|
||||||
* <refsect2>
|
|
||||||
* <para>
|
|
||||||
* Provides a base class for RTP depayloaders
|
* Provides a base class for RTP depayloaders
|
||||||
* </para>
|
|
||||||
* </refsect2>
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include "gstbasertpdepayload.h"
|
#include "gstbasertpdepayload.h"
|
||||||
|
@ -92,6 +92,18 @@ struct _GstBaseRTPDepayload
|
|||||||
gpointer _gst_reserved[GST_PADDING-1];
|
gpointer _gst_reserved[GST_PADDING-1];
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* GstBaseRTPDepayloadClass:
|
||||||
|
* @parent_class: the parent class
|
||||||
|
* @set_caps: configure the depayloader
|
||||||
|
* @add_to_queue: (deprecated)
|
||||||
|
* @process: process incoming rtp packets
|
||||||
|
* @set_gst_timestamp: convert from RTP timestamp to GST timestamp
|
||||||
|
* @packet_lost: signal the depayloader about packet loss
|
||||||
|
* @handle_event: custom event handling
|
||||||
|
*
|
||||||
|
* Base class for audio RTP payloader.
|
||||||
|
*/
|
||||||
struct _GstBaseRTPDepayloadClass
|
struct _GstBaseRTPDepayloadClass
|
||||||
{
|
{
|
||||||
GstElementClass parent_class;
|
GstElementClass parent_class;
|
||||||
|
@ -16,11 +16,7 @@
|
|||||||
* SECTION:gstbasertppayload
|
* SECTION:gstbasertppayload
|
||||||
* @short_description: Base class for RTP payloader
|
* @short_description: Base class for RTP payloader
|
||||||
*
|
*
|
||||||
* <refsect2>
|
|
||||||
* <para>
|
|
||||||
* Provides a base class for RTP payloaders
|
* Provides a base class for RTP payloaders
|
||||||
* </para>
|
|
||||||
* </refsect2>
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifdef HAVE_CONFIG_H
|
#ifdef HAVE_CONFIG_H
|
||||||
|
@ -120,6 +120,16 @@ struct _GstBaseRTPPayload
|
|||||||
} abidata;
|
} abidata;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* GstBaseRTPPayloadClass:
|
||||||
|
* @parent_class: the parent class
|
||||||
|
* @set_caps: configure the payloader
|
||||||
|
* @handle_buffer: process data
|
||||||
|
* @handle_event: custom event handling
|
||||||
|
* @get_caps: get desired caps
|
||||||
|
*
|
||||||
|
* Base class for audio RTP payloader.
|
||||||
|
*/
|
||||||
struct _GstBaseRTPPayloadClass
|
struct _GstBaseRTPPayloadClass
|
||||||
{
|
{
|
||||||
GstElementClass parent_class;
|
GstElementClass parent_class;
|
||||||
|
Loading…
x
Reference in New Issue
Block a user