diff --git a/cmake/ProjectDetails.cmake b/cmake/ProjectDetails.cmake index 70b03761..941263bc 100644 --- a/cmake/ProjectDetails.cmake +++ b/cmake/ProjectDetails.cmake @@ -1,3 +1,3 @@ -set(uvgrtp_VER 2.2.0) +set(uvgrtp_VER 2.3.0) set(uvgrtp_DESCR "uvgRTP is an Real-Time Transport Protocol (RTP) library written in C++ with a focus on simple to use and high-efficiency media delivery over the internet") set(uvgrtp_URL "https://github.com/ultravideo/uvgRTP") \ No newline at end of file diff --git a/docs/Doxyfile b/docs/Doxyfile index 763da42d..0fdc4c48 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -48,7 +48,7 @@ PROJECT_NAME = uvgRTP # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 2.2.0 +PROJECT_NUMBER = 2.3.0 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/docs/README.md b/docs/README.md index 8b8270f4..a3383936 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 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. +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 IPv6 to IPv4 which add 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 diff --git a/docs/html/annotated.html b/docs/html/annotated.html index 64d1c913..ebd4fcfa 100644 --- a/docs/html/annotated.html +++ b/docs/html/annotated.html @@ -21,7 +21,7 @@
address | IPv4 address of the remote participant |
address | IP address of the remote participant |
remote_addr | IPv4 address of the remote participant |
local_addr | IPv4 address of a local interface |
remote_addr | IP address of the remote participant |
local_addr | IP address of a local interface |
add_srtp_ctx(uint8_t *key, uint8_t *salt) | uvgrtp::media_stream | |
configure_ctx(int rcc_flag, ssize_t value) | uvgrtp::media_stream | |
get_rtcp() | uvgrtp::media_stream | |
get_ssrc() const | uvgrtp::media_stream | |
install_receive_hook(void *arg, void(*hook)(void *, uvgrtp::frame::rtp_frame *)) | uvgrtp::media_stream | |
pull_frame() | uvgrtp::media_stream | |
pull_frame(size_t timeout_ms) | uvgrtp::media_stream | |
push_frame(uint8_t *data, size_t data_len, int rtp_flags) | uvgrtp::media_stream | |
push_frame(std::unique_ptr< uint8_t[]> data, size_t data_len, int rtp_flags) | uvgrtp::media_stream | |
push_frame(uint8_t *data, size_t data_len, uint32_t ts, int rtp_flags) | uvgrtp::media_stream | |
push_frame(uint8_t *data, size_t data_len, uint32_t ts, uint64_t ntp_ts, int rtp_flags) | uvgrtp::media_stream | |
push_frame(std::unique_ptr< uint8_t[]> data, size_t data_len, uint32_t ts, int rtp_flags) | uvgrtp::media_stream | |
push_frame(std::unique_ptr< uint8_t[]> data, size_t data_len, uint32_t ts, uint64_t ntp_ts, int rtp_flags) | uvgrtp::media_stream | |
get_ipv6() const (defined in uvgrtp::media_stream) | uvgrtp::media_stream | |
get_rtcp() | uvgrtp::media_stream | |
get_ssrc() const | uvgrtp::media_stream | |
install_receive_hook(void *arg, void(*hook)(void *, uvgrtp::frame::rtp_frame *)) | uvgrtp::media_stream | |
pull_frame() | uvgrtp::media_stream | |
pull_frame(size_t timeout_ms) | uvgrtp::media_stream | |
push_frame(uint8_t *data, size_t data_len, int rtp_flags) | uvgrtp::media_stream | |
push_frame(std::unique_ptr< uint8_t[]> data, size_t data_len, int rtp_flags) | uvgrtp::media_stream | |
push_frame(uint8_t *data, size_t data_len, uint32_t ts, int rtp_flags) | uvgrtp::media_stream | |
push_frame(uint8_t *data, size_t data_len, uint32_t ts, uint64_t ntp_ts, int rtp_flags) | uvgrtp::media_stream | |
push_frame(std::unique_ptr< uint8_t[]> data, size_t data_len, uint32_t ts, int rtp_flags) | uvgrtp::media_stream | |
push_frame(std::unique_ptr< uint8_t[]> data, size_t data_len, uint32_t ts, uint64_t ntp_ts, int rtp_flags) | uvgrtp::media_stream |
The media_stream is an entity which represents one RTP stream.
@@ -134,7 +137,7 @@If RCE_RTCP was given when creating media_stream, you can get the uvgrtp::rtcp object with get_rtcp()-function.
media_stream corresponds to one RTP session in RFC 3550.
-Definition at line 49 of file media_stream.hh.
+Definition at line 50 of file media_stream.hh.
You can use the APP packet to test new RTCP packet types using the send_app_packet()-function. The APP packets are added to these periodically sent compound packets.
See RFC 3550 section 6 for more details.
-Definition at line 111 of file rtcp.hh.
+Definition at line 118 of file rtcp.hh.
Change uvgRTP's clock rate in RTP header and RTP timestamp calculations
Set a maximum value for the Ethernet frame size assumed by uvgRTP.
-Default is 1492, from this IPv4 and UDP, and RTP headers are removed, giving a payload size of 1452 bytes.
+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, it can set MTU size to, for example, 500 bytes or if it wishes to use jumbo frames, it can set the MTU size to 9000 bytes
Set the numerator of frame rate used by uvgRTP.
diff --git a/docs/html/util_8hh_source.html b/docs/html/util_8hh_source.html index bd230d6f..9b4eb5c3 100644 --- a/docs/html/util_8hh_source.html +++ b/docs/html/util_8hh_source.html @@ -21,7 +21,7 @@