rtp: fix some GIR annotations
authorMark Nauwelaerts <mnauw@users.sourceforge.net>
Fri, 20 Apr 2018 19:53:10 +0000 (21:53 +0200)
committerMark Nauwelaerts <mnauw@users.sourceforge.net>
Mon, 23 Apr 2018 17:33:12 +0000 (19:33 +0200)
Mostly related to out and array parameters.

gst-libs/gst/rtp/gstrtcpbuffer.c
gst-libs/gst/rtp/gstrtpbaseaudiopayload.c
gst-libs/gst/rtp/gstrtpbuffer.c
gst-libs/gst/rtp/gstrtphdrext.c

index a6b38c1..5a858c7 100644 (file)
@@ -694,11 +694,11 @@ gst_rtcp_packet_get_length (GstRTCPPacket * packet)
 /**
  * gst_rtcp_packet_sr_get_sender_info:
  * @packet: a valid SR #GstRTCPPacket
- * @ssrc: result SSRC
- * @ntptime: result NTP time
- * @rtptime: result RTP time
- * @packet_count: result packet count
- * @octet_count: result octet count
+ * @ssrc: (out): result SSRC
+ * @ntptime: (out): result NTP time
+ * @rtptime: (out): result RTP time
+ * @packet_count: (out): result packet count
+ * @octet_count: (out): result octet count
  *
  * Parse the SR sender info and store the values.
  */
@@ -847,13 +847,13 @@ gst_rtcp_packet_get_rb_count (GstRTCPPacket * packet)
  * gst_rtcp_packet_get_rb:
  * @packet: a valid SR or RR #GstRTCPPacket
  * @nth: the nth report block in @packet
- * @ssrc: result for data source being reported
- * @fractionlost: result for fraction lost since last SR/RR
- * @packetslost: result for the cumululative number of packets lost
- * @exthighestseq: result for the extended last sequence number received
- * @jitter: result for the interarrival jitter
- * @lsr: result for the last SR packet from this source
- * @dlsr: result for the delay since last SR packet
+ * @ssrc: (out): result for data source being reported
+ * @fractionlost: (out): result for fraction lost since last SR/RR
+ * @packetslost: (out): result for the cumululative number of packets lost
+ * @exthighestseq: (out): result for the extended last sequence number received
+ * @jitter: (out): result for the interarrival jitter
+ * @lsr: (out): result for the last SR packet from this source
+ * @dlsr: (out): result for the delay since last SR packet
  *
  * Parse the values of the @nth report block in @packet and store the result in
  * the values.
@@ -1044,7 +1044,7 @@ gst_rtcp_packet_set_rb (GstRTCPPacket * packet, guint nth, guint32 ssrc,
 
 
 /**
- * gst_rtcp_packet_set_profile_specific_ext:
+ * gst_rtcp_packet_add_profile_specific_ext:
  * @packet: a valid SR or RR #GstRTCPPacket
  * @data: (array length=len) (transfer none): profile-specific data
  * @len: length of the profile-specific data in bytes
@@ -1747,7 +1747,7 @@ no_space:
 /**
  * gst_rtcp_packet_bye_add_ssrcs:
  * @packet: a valid BYE #GstRTCPPacket
- * @ssrc: an array of SSRCs to add
+ * @ssrc: (array length=len) (transfer none): an array of SSRCs to add
  * @len: number of elements in @ssrc
  *
  * Adds @len SSRCs in @ssrc to BYE @packet.
index dd6789a..ca48d66 100644 (file)
@@ -434,7 +434,7 @@ gst_rtp_base_audio_payload_set_meta (GstRTPBaseAudioPayload * payload,
 /**
  * gst_rtp_base_audio_payload_push:
  * @baseaudiopayload: a #GstRTPBasePayload
- * @data: data to set as payload
+ * @data: (array length=payload_len): data to set as payload
  * @payload_len: length of payload
  * @timestamp: a #GstClockTime
  *
index 916b647..1768392 100644 (file)
@@ -1249,7 +1249,7 @@ gst_rtp_buffer_compare_seqnum (guint16 seqnum1, guint16 seqnum2)
 
 /**
  * gst_rtp_buffer_ext_timestamp:
- * @exttimestamp: a previous extended timestamp
+ * @exttimestamp: (inout): a previous extended timestamp
  * @timestamp: a new timestamp
  *
  * Update the @exttimestamp field with the extended timestamp of @timestamp
index 290805b..5d483c1 100644 (file)
@@ -54,9 +54,9 @@ gst_rtp_hdrext_set_ntp_64 (gpointer data, guint size, guint64 ntptime)
 
 /**
  * gst_rtp_hdrext_get_ntp_64:
- * @data: the data to read from
+ * @data: (array length=size) (element-type guint8): the data to read from
  * @size: the size of @data
- * @ntptime: the result NTP time
+ * @ntptime: (out): the result NTP time
  *
  * Reads the NTP time from the @size NTP-64 extension bytes in @data and store the
  * result in @ntptime.
@@ -104,9 +104,9 @@ gst_rtp_hdrext_set_ntp_56 (gpointer data, guint size, guint64 ntptime)
 
 /**
  * gst_rtp_hdrext_get_ntp_56:
- * @data: the data to read from
+ * @data: (array length=size) (element-type guint8): the data to read from
  * @size: the size of @data
- * @ntptime: the result NTP time
+ * @ntptime: (out): the result NTP time
  *
  * Reads the NTP time from the @size NTP-56 extension bytes in @data and store the
  * result in @ntptime.