Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rtp: extra dox for rtcp_encode #672

Merged
merged 1 commit into from
Jan 31, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions src/rtp/pkt.c
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,50 @@ int rtcp_vencode(struct mbuf *mb, enum rtcp_type type, uint32_t count,
* @param count Packet-specific count
* @param ... Variable arguments, type specific
*
* Variable arguments for each RTCP type:
*
* \verbatim
SR SSRC of sender
NTP Timestamp (MSW)
NTP Timestamp (LSW)
RTP Timestamp
Sender packet count
Sender octet count
Encode handler for report block
Handler argument

RR SSRC of sender
Encode handler for report block
Handler argument

SDES Encode handler for SDES chunk
Handler argument

BYE SSRCs (vector)
Reason string (optional)

APP SSRC/CSRC
name (ASCII)
Data
Data length

FIR SSRC

NACK SSRC
FSN
BLP

RTPFB SSRC packet
SSRC media
Encode handler
Handler argument

PSFB SSRC packet
SSRC media
Encode handler
Handler argument
\endverbatim
*
* @return 0 for success, otherwise errorcode
*/
int rtcp_encode(struct mbuf *mb, enum rtcp_type type, uint32_t count, ...)
Expand Down