qiurui
/
uvgrtp-base
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

ipv6: updated documentation

This commit is contained in:
Heikki Tampio 2023-03-20 15:15:08 +02:00
parent 0d9e3beed6
commit 2b4fd4418f
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/README.md
View File

@ -155,7 +155,7 @@ The second way of handling key-management of SRTP is to do it outside uvgRTP. To
## MTU size
The default MTU size of uvgRTP has been set to 1492 to account for 8 bytes of unknown overhead. uvgRTP assumes the presence of an UDP header and IP header in addition an RTP header which are taken into account when fragmenting frames. If your application is expected to work through tunneling such as VPN which adds additional headers on top of packets, you may need to lower the MTU size to avoid IP level fragmentation. Some networks also allow for a higher MTU size in which case you can increase this.
The default MTU size of uvgRTP has been set to 1492 to account for 8 bytes of unknown overhead. uvgRTP assumes the presence of an UDP header and IP header in addition an RTP header which are taken into account when fragmenting frames. If your application is expected to work through tunneling such as VPN or IP tunneling which adds additional headers on top of packets, you may need to lower the MTU size to avoid IP level fragmentation. Some networks also allow for a higher MTU size in which case you can increase this.
## uvgRTP video reception behavior with packet loss

6
include/uvgrtp/context.hh
View File

@ -34,7 +34,7 @@ namespace uvgrtp {
/**
* \brief Create a new RTP session
*
* \param address IPv4 address of the remote participant
* \param address IP address of the remote participant
*
* \return RTP session object
*
@ -51,8 +51,8 @@ namespace uvgrtp {
* should bind itself to. If you are using uvgRTP for unidirectional streaming,
* please take a look at @ref RCE_HOLEPUNCH_KEEPALIVE
*
* \param remote_addr IPv4 address of the remote participant
* \param local_addr IPv4 address of a local interface
* \param remote_addr IP address of the remote participant
* \param local_addr IP address of a local interface
*
* \return RTP session object
*

2
include/uvgrtp/util.hh
View File

@ -334,7 +334,7 @@ enum RTP_CTX_CONFIGURATION_FLAGS {
/** Set a maximum value for the Ethernet frame size assumed by uvgRTP.
*
* Default is 1492, from this IPv4 and UDP, and RTP headers
* Default is 1492, from this IP and UDP, and RTP headers
* are removed, giving a payload size of 1452 bytes.
*
* If application wishes to use small UDP datagram,