Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3194>
*
* 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.
*/
gchar *
* The returned @ext must be configured with the correct @ext_id and with the
* 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
*/
/**
* gst_rtp_base_depayload_push:
* @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
* @out_buf.
/**
* gst_rtp_base_depayload_push_list:
* @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
* @out_list.
* The returned @ext must be configured with the correct @ext_id and with the
* 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
*/
* respectively. @data will be freed when the buffer is unreffed, so this
* 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 *
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
* 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 *
gst_rtp_buffer_new_copy_data (gconstpointer data, gsize 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.
*
- * 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.
*/
GstBuffer *
* @csrc_count and can be calculated with gst_rtp_buffer_calc_payload_len().
* 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 *
gst_rtp_buffer_new_allocate_len (guint packet_len, guint8 pad_len,
* @bits unchanged. If there is an extension header but no extension data then
* 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.
*
* Since: 1.2
* 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.
*
- * 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 *
gst_rtp_buffer_get_payload_subbuffer (GstRTPBuffer * rtp, guint offset,
* will internally create a subbuffer of @buffer so that a memcpy can be
* avoided.
*
- * Returns: A new buffer with the data of the payload.
+ * Returns: (transfer full): A new buffer with the data of the payload.
*/
GstBuffer *
gst_rtp_buffer_get_payload_buffer (GstRTPBuffer * rtp)
* Get a pointer to the payload data in @buffer. This pointer is valid as long
* 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.
*/
gpointer
* bindings usage. The return value is a pointer to a #GBytes structure
* 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
*/
* gst_rtp_header_extension_get_uri:
* @ext: a #GstRTPHeaderExtension
*
- * Returns: the RTP extension URI for this object
+ * Returns: (nullable): the RTP extension URI for this object
*
* Since: 1.20
*/
/**
* gst_buffer_add_rtp_source_meta:
* @buffer: a #GstBuffer
- * @ssrc: (allow-none) (transfer none): pointer to the SSRC
- * @csrc: (allow-none) (transfer none): pointer to the CSRCs
+ * @ssrc: (nullable) (transfer none): pointer to the SSRC
+ * @csrc: (nullable) (transfer none) (array length=csrc_count): pointer to the CSRCs
* @csrc_count: number of elements in @csrc
*
* Attaches RTP source information to @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.
*
* Since: 1.16
/**
* gst_rtp_source_meta_set_ssrc:
* @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.
*
/**
* gst_rtp_source_meta_append_csrc:
* @meta: a #GstRTPSourceMeta
- * @csrc: the csrcs to append
+ * @csrc: (array length=csrc_count): the csrcs to append
* @csrc_count: number of elements in @csrc
*
* Appends @csrc to the list of contributing sources in @meta.
* mostly used to get the default clock-rate and bandwidth for static payload
* 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 *
gst_rtp_payload_info_for_pt (guint8 payload_type)
*
* 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 *
gst_rtp_payload_info_for_name (const gchar * media, const gchar * encoding_name)
projects / platform / upstream / gstreamer.git / commitdiff