rtpbin: Improve RTPStorage action signal documentation

This is a tiny clarification as the storage was loosely named "storage".
This change clarify that the storage is specificaly used for received RTP
packets. This is unlike the storage found in rtprtxsend that stores a
backlog of sent RTP packets.
This commit is contained in:
Nicolas Dufresne 2019-02-19 12:15:19 -05:00
parent 1ae4814a74
commit 4e0bdca3f0

View file

@ -2030,7 +2030,9 @@ gst_rtp_bin_class_init (GstRtpBinClass * klass)
* @rtpbin: the object which received the signal
* @id: the session id
*
* Request the internal RTPStorage object as #GObject in session @id.
* Request the internal RTPStorage object as #GObject in session @id. This
* is the internal storage used by the RTPStorage element, which is used to
* keep a backlog of received RTP packets for the session @id.
*
* Since: 1.14
*/
@ -2045,7 +2047,8 @@ gst_rtp_bin_class_init (GstRtpBinClass * klass)
* @rtpbin: the object which received the signal
* @id: the session id
*
* Request the RTPStorage element as #GObject in session @id.
* Request the RTPStorage element as #GObject in session @id. This element
* is used to keep a backlog of received RTP packets for the session @id.
*
* Since: 1.16
*/