rtpsession: fix typos and update parameters names in comments

Some functions now accept a generic 'gpointer data' parameter because
they can work either on a single buffer or a buffer list.

However the comments were still referring to the old 'GstBuffer *buffer'
parameter, so update the comments to match the actual functions
signature.
This commit is contained in:
Antonio Ospite 2019-02-27 16:45:54 +01:00
parent b2b60c4d8f
commit 43e4226844
3 changed files with 7 additions and 7 deletions

View file

@ -2266,7 +2266,7 @@ gst_rtp_session_setcaps_send_rtp (GstPad * pad, GstRtpSession * rtpsession,
return TRUE;
}
/* Recieve an RTP packet or a list of packets to be send to the receivers,
/* Receive an RTP packet or a list of packets to be sent to the receivers,
* send to RTP session manager and forward to send_rtp_src.
*/
static GstFlowReturn
@ -2286,7 +2286,7 @@ gst_rtp_session_chain_send_rtp_common (GstRtpSession * rtpsession,
if (is_list) {
GstBuffer *buffer = NULL;
/* All groups in an list have the same timestamp.
/* All groups in a list have the same timestamp.
* So, just take it from the first group. */
buffer = gst_buffer_list_get (GST_BUFFER_LIST_CAST (data), 0);
if (buffer)

View file

@ -3053,8 +3053,8 @@ rtp_session_update_send_caps (RTPSession * sess, GstCaps * caps)
* @current_time: the current system time
* @running_time: the running time of @data
*
* Send the RTP buffer in the session manager. This function takes ownership of
* @buffer.
* Send the RTP data (a buffer or buffer list) in the session manager. This
* function takes ownership of @data.
*
* Returns: a #GstFlowReturn.
*/

View file

@ -56,11 +56,11 @@ typedef GstFlowReturn (*RTPSessionProcessRTP) (RTPSession *sess, RTPSource *src,
* RTPSessionSendRTP:
* @sess: an #RTPSession
* @src: the #RTPSource
* @buffer: the RTP buffer ready for sending
* @data: the RTP buffer or buffer list ready for sending
* @user_data: user data specified when registering
*
* This callback will be called when @sess has @buffer ready for sending to
* all listening participants in this session.
* This callback will be called when @sess has @data (a buffer or buffer list)
* ready for sending to all listening participants in this session.
*
* Returns: a #GstFlowReturn.
*/