mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-27 12:11:13 +00:00
Code Issues 1 Projects Releases Wiki Activity

rtcpbuffer: Improve documentation of new functions a bit

Browse source 
Also actually add them to the documentation.
This commit is contained in:
Sebastian Dröge 2015-06-05 10:16:56 +02:00
parent 9931bef8ca
commit bf5d3bf868
3 changed files with 13 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/libs/gst-plugins-base-libs-sections.txt
View file

@ -1197,6 +1197,8 @@ GstRTCPFBType
gst_rtcp_buffer_new_take_data gst_rtcp_buffer_new_take_data
gst_rtcp_buffer_new_copy_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_data
gst_rtcp_buffer_validate gst_rtcp_buffer_validate

15
gst-libs/gst/rtp/gstrtcpbuffer.c
View file

@ -178,15 +178,17 @@ wrong_padding:
* @data: (array length=len): the data to validate * @data: (array length=len): the data to validate
* @len: the length of @data to validate * @len: the length of @data to validate
* *
* Check if the @data and @size point to the data of a valid RTCP * Check if the @data and @size point to the data of a valid RTCP packet.
* packet.
* Use this function to validate a packet before using the other functions in * Use this function to validate a packet before using the other functions in
* this module. * this module.
* *
* This function is updated to support reduced size rtcp packets according to * 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. * Returns: TRUE if the data points to a valid RTCP packet.
*
* Since: 1.6
*/ */
gboolean gboolean
gst_rtcp_buffer_validate_data_reduced (guint8 * data, guint len) 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 * @data: (array length=len): the data to validate
* @len: the length of @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) * Check if the @data and @size point to the data of a valid compound,
* packet. * non-reduced size RTCP packet.
* Use this function to validate a packet before using the other functions in * Use this function to validate a packet before using the other functions in
* this module. * this module.
* *
*
* Returns: TRUE if the data points to a valid RTCP packet. * Returns: TRUE if the data points to a valid RTCP packet.
*/ */
gboolean gboolean
@ -223,6 +224,8 @@ gst_rtcp_buffer_validate_data (guint8 * data, guint len)
* gst_rtcp_buffer_validate_reduced(). * gst_rtcp_buffer_validate_reduced().
* *
* Returns: TRUE if @buffer is a valid RTCP packet. * Returns: TRUE if @buffer is a valid RTCP packet.
*
* Since: 1.6
*/ */
gboolean gboolean
gst_rtcp_buffer_validate_reduced (GstBuffer * buffer) gst_rtcp_buffer_validate_reduced (GstBuffer * buffer)

2
win32/common/libgstrtp.def
View file

@ -9,6 +9,8 @@ EXPORTS
gst_rtcp_buffer_unmap gst_rtcp_buffer_unmap
gst_rtcp_buffer_validate gst_rtcp_buffer_validate
gst_rtcp_buffer_validate_data gst_rtcp_buffer_validate_data
gst_rtcp_buffer_validate_data_reduced
gst_rtcp_buffer_validate_reduced
gst_rtcp_ntp_to_unix gst_rtcp_ntp_to_unix
gst_rtcp_packet_add_rb gst_rtcp_packet_add_rb
gst_rtcp_packet_bye_add_ssrc gst_rtcp_packet_bye_add_ssrc