rtpsource: fix documentation of rtp_source_send_rtp parameters
authorAntonio Ospite <antonio.ospite@collabora.com>
Thu, 28 Feb 2019 11:32:51 +0000 (12:32 +0100)
committerAntonio Ospite <antonio.ospite@collabora.com>
Thu, 7 Mar 2019 11:41:40 +0000 (12:41 +0100)
In commit 28e5f9098 (rtpbin: use PacketInfo for the sender, 2013-09-13)
the rtp_source_send_rtp signature changed but the documentation was not
adjusted to match the new one.

Update the documentation to match the function signature.

gst/rtpmanager/rtpsource.c

index e4c3b2b..ff6b5d6 100644 (file)
@@ -1271,12 +1271,10 @@ rtp_source_mark_bye (RTPSource * src, const gchar * reason)
 /**
  * rtp_source_send_rtp:
  * @src: an #RTPSource
- * @data: an RTP buffer or a list of RTP buffers
- * @is_list: if @data is a buffer or list
- * @running_time: the running time of @data
+ * @pinfo: an #RTPPacketInfo
  *
- * Send @data (an RTP buffer or list of buffers) originating from @src.
- * This will make @src a sender. This function takes ownership of @data and
+ * Send data (an RTP buffer or buffer list from @pinfo) originating from @src.
+ * This will make @src a sender. This function takes ownership of the data and
  * modifies the SSRC in the RTP packet to that of @src when needed.
  *
  * Returns: a #GstFlowReturn.