mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-01-25 16:48:11 +00:00
Code Issues 1 Projects Releases Wiki Activity

rtp: Add/fix various annotations

Browse source 
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3194>
This commit is contained in:
Sebastian Dröge 2022-10-15 00:00:03 +03:00 committed by GStreamer Marge Bot
parent 84ab8c9e12
commit 47e4110a1b
7 changed files with 22 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtcpbuffer.c
View file

@ -1863,7 +1863,7 @@ gst_rtcp_packet_bye_get_reason_len (GstRTCPPacket * packet)
* *
* Get the reason in @packet. * Get the reason in @packet.
* *
* Returns: The reason for the BYE @packet or NULL if the packet did not contain * Returns: (nullable): The reason for the BYE @packet or NULL if the packet did not contain
* a reason string. The string must be freed with g_free() after usage. * a reason string. The string must be freed with g_free() after usage.
*/ */
gchar * gchar *

6
subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtpbasedepayload.c
View file

@ -305,7 +305,7 @@ gst_rtp_base_depayload_class_init (GstRTPBaseDepayloadClass * klass)
* The returned @ext must be configured with the correct @ext_id and with the * The returned @ext must be configured with the correct @ext_id and with the
* necessary attributes as required by the extension implementation. * necessary attributes as required by the extension implementation.
* *
* Returns: (transfer full): the #GstRTPHeaderExtension for @ext_id, or %NULL * Returns: (transfer full) (nullable): the #GstRTPHeaderExtension for @ext_id, or %NULL
* *
* Since: 1.20 * Since: 1.20
*/ */
@ -1429,7 +1429,7 @@ gst_rtp_base_depayload_do_push (GstRTPBaseDepayload * filter, gboolean is_list,
/** /**
* gst_rtp_base_depayload_push: * gst_rtp_base_depayload_push:
* @filter: a #GstRTPBaseDepayload * @filter: a #GstRTPBaseDepayload
* @out_buf: a #GstBuffer * @out_buf: (transfer full): a #GstBuffer
* *
* Push @out_buf to the peer of @filter. This function takes ownership of * Push @out_buf to the peer of @filter. This function takes ownership of
* @out_buf. * @out_buf.
@ -1455,7 +1455,7 @@ gst_rtp_base_depayload_push (GstRTPBaseDepayload * filter, GstBuffer * out_buf)
/** /**
* gst_rtp_base_depayload_push_list: * gst_rtp_base_depayload_push_list:
* @filter: a #GstRTPBaseDepayload * @filter: a #GstRTPBaseDepayload
* @out_list: a #GstBufferList * @out_list: (transfer full): a #GstBufferList
* *
* Push @out_list to the peer of @filter. This function takes ownership of * Push @out_list to the peer of @filter. This function takes ownership of
* @out_list. * @out_list.

2
subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtpbasepayload.c
View file

@ -467,7 +467,7 @@ gst_rtp_base_payload_class_init (GstRTPBasePayloadClass * klass)
* The returned @ext must be configured with the correct @ext_id and with the * The returned @ext must be configured with the correct @ext_id and with the
* necessary attributes as required by the extension implementation. * necessary attributes as required by the extension implementation.
* *
* Returns: (transfer full): the #GstRTPHeaderExtension for @ext_id, or %NULL * Returns: (transfer full) (nullable): the #GstRTPHeaderExtension for @ext_id, or %NULL
* *
* Since: 1.20 * Since: 1.20
*/ */

18
subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtpbuffer.c
View file

@ -158,7 +158,7 @@ gst_rtp_buffer_allocate_data (GstBuffer * buffer, guint payload_len,
* respectively. @data will be freed when the buffer is unreffed, so this * respectively. @data will be freed when the buffer is unreffed, so this
* function transfers ownership of @data to the new buffer. * function transfers ownership of @data to the new buffer.
* *
* Returns: A newly allocated buffer with @data and of size @len. * Returns: (transfer full): A newly allocated buffer with @data and of size @len.
*/ */
GstBuffer * GstBuffer *
gst_rtp_buffer_new_take_data (gpointer data, gsize len) gst_rtp_buffer_new_take_data (gpointer data, gsize len)
@ -179,7 +179,7 @@ gst_rtp_buffer_new_take_data (gpointer data, gsize len)
* bytes of @data and the size to @len. The data will be freed when the buffer * bytes of @data and the size to @len. The data will be freed when the buffer
* is freed. * is freed.
* *
* Returns: A newly allocated buffer with a copy of @data and of size @len. * Returns: (transfer full): A newly allocated buffer with a copy of @data and of size @len.
*/ */
GstBuffer * GstBuffer *
gst_rtp_buffer_new_copy_data (gconstpointer data, gsize len) gst_rtp_buffer_new_copy_data (gconstpointer data, gsize len)
@ -197,7 +197,7 @@ gst_rtp_buffer_new_copy_data (gconstpointer data, gsize len)
* @csrc_count CSRCs, a payload length of @payload_len and padding of @pad_len. * @csrc_count CSRCs, a payload length of @payload_len and padding of @pad_len.
* All other RTP header fields will be set to 0/FALSE. * All other RTP header fields will be set to 0/FALSE.
* *
* Returns: A newly allocated buffer that can hold an RTP packet with given * Returns: (transfer full): A newly allocated buffer that can hold an RTP packet with given
* parameters. * parameters.
*/ */
GstBuffer * GstBuffer *
@ -225,7 +225,7 @@ gst_rtp_buffer_new_allocate (guint payload_len, guint8 pad_len,
* @csrc_count and can be calculated with gst_rtp_buffer_calc_payload_len(). * @csrc_count and can be calculated with gst_rtp_buffer_calc_payload_len().
* All RTP header fields will be set to 0/FALSE. * All RTP header fields will be set to 0/FALSE.
* *
* Returns: A newly allocated buffer that can hold an RTP packet of @packet_len. * Returns: (transfer full): A newly allocated buffer that can hold an RTP packet of @packet_len.
*/ */
GstBuffer * GstBuffer *
gst_rtp_buffer_new_allocate_len (guint packet_len, guint8 pad_len, gst_rtp_buffer_new_allocate_len (guint packet_len, guint8 pad_len,
@ -733,7 +733,7 @@ gst_rtp_buffer_get_extension_data (GstRTPBuffer * rtp, guint16 * bits,
* @bits unchanged. If there is an extension header but no extension data then * @bits unchanged. If there is an extension header but no extension data then
* an empty #GBytes will be returned. * an empty #GBytes will be returned.
* *
* Returns: (transfer full): A new #GBytes if an extension header was present * Returns: (transfer full) (nullable): A new #GBytes if an extension header was present
* and %NULL otherwise. * and %NULL otherwise.
* *
* Since: 1.2 * Since: 1.2
@ -1140,7 +1140,7 @@ gst_rtp_buffer_set_timestamp (GstRTPBuffer * rtp, guint32 timestamp)
* are skipped in the payload and the subbuffer will be of size @len. * are skipped in the payload and the subbuffer will be of size @len.
* If @len is -1 the total payload starting from @offset is subbuffered. * If @len is -1 the total payload starting from @offset is subbuffered.
* *
* Returns: A new buffer with the specified data of the payload. * Returns: (transfer full): A new buffer with the specified data of the payload.
*/ */
GstBuffer * GstBuffer *
gst_rtp_buffer_get_payload_subbuffer (GstRTPBuffer * rtp, guint offset, gst_rtp_buffer_get_payload_subbuffer (GstRTPBuffer * rtp, guint offset,
@ -1180,7 +1180,7 @@ wrong_offset:
* will internally create a subbuffer of @buffer so that a memcpy can be * will internally create a subbuffer of @buffer so that a memcpy can be
* avoided. * avoided.
* *
* Returns: A new buffer with the data of the payload. * Returns: (transfer full): A new buffer with the data of the payload.
*/ */
GstBuffer * GstBuffer *
gst_rtp_buffer_get_payload_buffer (GstRTPBuffer * rtp) gst_rtp_buffer_get_payload_buffer (GstRTPBuffer * rtp)
@ -1210,7 +1210,7 @@ gst_rtp_buffer_get_payload_len (GstRTPBuffer * rtp)
* Get a pointer to the payload data in @buffer. This pointer is valid as long * Get a pointer to the payload data in @buffer. This pointer is valid as long
* as a reference to @buffer is held. * as a reference to @buffer is held.
* *
* Returns: (array) (element-type guint8) (transfer none): A pointer * Returns: (array) (element-type guint8) (transfer none) (nullable): A pointer
* to the payload data in @buffer. * to the payload data in @buffer.
*/ */
gpointer gpointer
@ -1233,7 +1233,7 @@ gst_rtp_buffer_get_payload (GstRTPBuffer * rtp)
* bindings usage. The return value is a pointer to a #GBytes structure * bindings usage. The return value is a pointer to a #GBytes structure
* containing the payload data in @rtp. * containing the payload data in @rtp.
* *
* Returns: (transfer full): A new #GBytes containing the payload data in @rtp. * Returns: (transfer full) (nullable): A new #GBytes containing the payload data in @rtp.
* *
* Since: 1.2 * Since: 1.2
*/ */

2
subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtphdrext.c
View file

@ -205,7 +205,7 @@ gst_rtp_header_extension_init (GstRTPHeaderExtension * ext)
* gst_rtp_header_extension_get_uri: * gst_rtp_header_extension_get_uri:
* @ext: a #GstRTPHeaderExtension * @ext: a #GstRTPHeaderExtension
* *
* Returns: the RTP extension URI for this object * Returns: (nullable): the RTP extension URI for this object
* *
* Since: 1.20 * Since: 1.20
*/ */

10
subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtpmeta.c
View file

@ -34,8 +34,8 @@
/** /**
* gst_buffer_add_rtp_source_meta: * gst_buffer_add_rtp_source_meta:
* @buffer: a #GstBuffer * @buffer: a #GstBuffer
* @ssrc: (allow-none) (transfer none): pointer to the SSRC * @ssrc: (nullable) (transfer none): pointer to the SSRC
* @csrc: (allow-none) (transfer none): pointer to the CSRCs * @csrc: (nullable) (transfer none) (array length=csrc_count): pointer to the CSRCs
* @csrc_count: number of elements in @csrc * @csrc_count: number of elements in @csrc
* *
* Attaches RTP source information to @buffer. * Attaches RTP source information to @buffer.
@ -81,7 +81,7 @@ gst_buffer_add_rtp_source_meta (GstBuffer * buffer, const guint32 * ssrc,
* *
* Find the #GstRTPSourceMeta on @buffer. * Find the #GstRTPSourceMeta on @buffer.
* *
* Returns: (transfer none): the #GstRTPSourceMeta or %NULL when there * Returns: (transfer none) (nullable): the #GstRTPSourceMeta or %NULL when there
* is no such metadata on @buffer. * is no such metadata on @buffer.
* *
* Since: 1.16 * Since: 1.16
@ -137,7 +137,7 @@ gst_rtp_source_meta_get_source_count (const GstRTPSourceMeta * meta)
/** /**
* gst_rtp_source_meta_set_ssrc: * gst_rtp_source_meta_set_ssrc:
* @meta: a #GstRTPSourceMeta * @meta: a #GstRTPSourceMeta
* @ssrc: (allow-none) (transfer none): pointer to the SSRC * @ssrc: (nullable) (transfer none): pointer to the SSRC
* *
* Sets @ssrc in @meta. If @ssrc is %NULL the ssrc of @meta will be unset. * Sets @ssrc in @meta. If @ssrc is %NULL the ssrc of @meta will be unset.
* *
@ -161,7 +161,7 @@ gst_rtp_source_meta_set_ssrc (GstRTPSourceMeta * meta, guint32 * ssrc)
/** /**
* gst_rtp_source_meta_append_csrc: * gst_rtp_source_meta_append_csrc:
* @meta: a #GstRTPSourceMeta * @meta: a #GstRTPSourceMeta
* @csrc: the csrcs to append * @csrc: (array length=csrc_count): the csrcs to append
* @csrc_count: number of elements in @csrc * @csrc_count: number of elements in @csrc
* *
* Appends @csrc to the list of contributing sources in @meta. * Appends @csrc to the list of contributing sources in @meta.

4
subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtppayloads.c
View file

@ -185,7 +185,7 @@ static const GstRTPPayloadInfo info[] = {
* mostly used to get the default clock-rate and bandwidth for static payload * mostly used to get the default clock-rate and bandwidth for static payload
* types specified with @payload_type. * types specified with @payload_type.
* *
* Returns: a #GstRTPPayloadInfo or NULL when no info could be found. * Returns: (nullable): a #GstRTPPayloadInfo or NULL when no info could be found.
*/ */
const GstRTPPayloadInfo * const GstRTPPayloadInfo *
gst_rtp_payload_info_for_pt (guint8 payload_type) gst_rtp_payload_info_for_pt (guint8 payload_type)
@ -213,7 +213,7 @@ gst_rtp_payload_info_for_pt (guint8 payload_type)
* *
* The search for @encoding_name will be performed in a case insensitive way. * The search for @encoding_name will be performed in a case insensitive way.
* *
* Returns: a #GstRTPPayloadInfo or NULL when no info could be found. * Returns: (nullable): a #GstRTPPayloadInfo or NULL when no info could be found.
*/ */
const GstRTPPayloadInfo * const GstRTPPayloadInfo *
gst_rtp_payload_info_for_name (const gchar * media, const gchar * encoding_name) gst_rtp_payload_info_for_name (const gchar * media, const gchar * encoding_name)