mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-27 12:11:13 +00:00
rtcpbuffer: Improve documentation of new functions a bit
Also actually add them to the documentation.
This commit is contained in:
parent
9931bef8ca
commit
bf5d3bf868
3 changed files with 13 additions and 6 deletions
|
@ -1197,6 +1197,8 @@ GstRTCPFBType
|
|||
gst_rtcp_buffer_new_take_data
|
||||
gst_rtcp_buffer_new_copy_data
|
||||
|
||||
gst_rtcp_buffer_validate_data_reduced
|
||||
gst_rtcp_buffer_validate_reduced
|
||||
gst_rtcp_buffer_validate_data
|
||||
gst_rtcp_buffer_validate
|
||||
|
||||
|
|
|
@ -178,15 +178,17 @@ wrong_padding:
|
|||
* @data: (array length=len): the data to validate
|
||||
* @len: the length of @data to validate
|
||||
*
|
||||
* Check if the @data and @size point to the data of a valid RTCP
|
||||
* packet.
|
||||
* Check if the @data and @size point to the data of a valid RTCP packet.
|
||||
* Use this function to validate a packet before using the other functions in
|
||||
* this module.
|
||||
*
|
||||
* This function is updated to support reduced size rtcp packets according to
|
||||
* RFC 5506
|
||||
* RFC 5506 and will validate full compound RTCP packets as well as reduced
|
||||
* size RTCP packets.
|
||||
*
|
||||
* Returns: TRUE if the data points to a valid RTCP packet.
|
||||
*
|
||||
* Since: 1.6
|
||||
*/
|
||||
gboolean
|
||||
gst_rtcp_buffer_validate_data_reduced (guint8 * data, guint len)
|
||||
|
@ -200,12 +202,11 @@ gst_rtcp_buffer_validate_data_reduced (guint8 * data, guint len)
|
|||
* @data: (array length=len): the data to validate
|
||||
* @len: the length of @data to validate
|
||||
*
|
||||
* Check if the @data and @size point to the data of a valid RTCP (compound)
|
||||
* packet.
|
||||
* Check if the @data and @size point to the data of a valid compound,
|
||||
* non-reduced size RTCP packet.
|
||||
* Use this function to validate a packet before using the other functions in
|
||||
* this module.
|
||||
*
|
||||
*
|
||||
* Returns: TRUE if the data points to a valid RTCP packet.
|
||||
*/
|
||||
gboolean
|
||||
|
@ -223,6 +224,8 @@ gst_rtcp_buffer_validate_data (guint8 * data, guint len)
|
|||
* gst_rtcp_buffer_validate_reduced().
|
||||
*
|
||||
* Returns: TRUE if @buffer is a valid RTCP packet.
|
||||
*
|
||||
* Since: 1.6
|
||||
*/
|
||||
gboolean
|
||||
gst_rtcp_buffer_validate_reduced (GstBuffer * buffer)
|
||||
|
|
|
@ -9,6 +9,8 @@ EXPORTS
|
|||
gst_rtcp_buffer_unmap
|
||||
gst_rtcp_buffer_validate
|
||||
gst_rtcp_buffer_validate_data
|
||||
gst_rtcp_buffer_validate_data_reduced
|
||||
gst_rtcp_buffer_validate_reduced
|
||||
gst_rtcp_ntp_to_unix
|
||||
gst_rtcp_packet_add_rb
|
||||
gst_rtcp_packet_bye_add_ssrc
|
||||
|
|
Loading…
Reference in a new issue