From c2e620769806f48a73dc86ae67adb2cc4d501c44 Mon Sep 17 00:00:00 2001 From: Aaro Altonen Date: Tue, 23 Feb 2021 14:43:09 +0200 Subject: [PATCH] Document set_ts_info() --- docs/html/classuvgrtp_1_1media__stream.html | 11 +- docs/html/classuvgrtp_1_1rtcp-members.html | 2 +- docs/html/classuvgrtp_1_1rtcp.html | 51 +++- docs/html/functions.html | 3 + docs/html/functions_func.html | 3 + docs/html/media__stream_8hh_source.html | 190 ++++++------- docs/html/rtcp_8hh_source.html | 293 ++++++++++---------- docs/html/search/all_8.js | 3 +- docs/html/search/all_9.js | 4 +- docs/html/search/all_a.js | 2 +- docs/html/search/classes_0.js | 2 +- docs/html/search/classes_1.js | 2 +- docs/html/search/classes_2.js | 2 +- docs/html/search/classes_3.js | 2 +- docs/html/search/enums_0.js | 10 +- docs/html/search/enumvalues_0.js | 82 +++--- docs/html/search/files_0.js | 2 +- docs/html/search/functions_0.js | 2 +- docs/html/search/functions_1.js | 8 +- docs/html/search/functions_2.js | 4 +- docs/html/search/functions_3.js | 2 +- docs/html/search/functions_4.js | 2 +- docs/html/search/functions_5.js | 4 +- docs/html/search/functions_6.js | 2 +- docs/html/search/functions_7.html | 37 +++ docs/html/search/functions_7.js | 4 + docs/html/search/pages_0.js | 2 +- docs/html/search/searchdata.js | 2 +- include/rtcp.hh | 16 +- 29 files changed, 431 insertions(+), 318 deletions(-) create mode 100644 docs/html/search/functions_7.html create mode 100644 docs/html/search/functions_7.js diff --git a/docs/html/classuvgrtp_1_1media__stream.html b/docs/html/classuvgrtp_1_1media__stream.html index 68c90ee..598ac1c 100644 --- a/docs/html/classuvgrtp_1_1media__stream.html +++ b/docs/html/classuvgrtp_1_1media__stream.html @@ -138,6 +138,13 @@ Public Member Functions

Currently uvgRTP only supports key length of 16 bytes (128 bits) and salt length of 14 bytes (112 bits).

If the key or salt is longer, it is implicitly truncated to correct length and if the key or salt is shorter, a memory violation may occur

Notice that if user-managed SRTP has been enabled during media stream creation, this function must be called before anything else. All calls to other functions will fail with RTP_NOT_INITIALIZED until the SRTP context has been specified

+
Parameters
+ + + +
key128-bit long key
salt112-bit long salt
+
+
Returns
RTP error code
Return values
@@ -420,7 +427,7 @@ Public Member Functions

Send data to remote participant with a custom timestamp.

If so specified either by the selected media format and/or given RTP_CTX_ENABLE_FLAGS, uvgRTP fragments the input data into RTP packets of 1500 bytes, or to any other size defined by the application using RCC_MTU_SIZE

The frame is automatically reconstructed by the receiver if all fragments have been received successfully.

-

If application so wishes, it may override uvgRTP's own timestamp calculations and provide timestamping information for the stream itself. This requires that the application provides a sensible value for the ts parameter. If RTCP has been enabled, uvgrtp::rtcp::set_ts_info() should have been called.

+

If application so wishes, it may override uvgRTP's own timestamp calculations and provide timestamping information for the stream itself. This requires that the application provides a sensible value for the ts parameter. If RTCP has been enabled, uvgrtp::rtcp::set_ts_info() should have been called.

Parameters
@@ -543,7 +550,7 @@ Public Member Functions

Send data to remote participant with a custom timestamp.

If so specified either by the selected media format and/or given RTP_CTX_ENABLE_FLAGS, uvgRTP fragments the input data into RTP packets of 1500 bytes, or to any other size defined by the application using RCC_MTU_SIZE

The frame is automatically reconstructed by the receiver if all fragments have been received successfully.

-

If application so wishes, it may override uvgRTP's own timestamp calculations and provide timestamping information for the stream itself. This requires that the application provides a sensible value for the ts parameter. If RTCP has been enabled, uvgrtp::rtcp::set_ts_info() should have been called.

+

If application so wishes, it may override uvgRTP's own timestamp calculations and provide timestamping information for the stream itself. This requires that the application provides a sensible value for the ts parameter. If RTCP has been enabled, uvgrtp::rtcp::set_ts_info() should have been called.

Parameters
dataSmart pointer to data the that should be sent
diff --git a/docs/html/classuvgrtp_1_1rtcp-members.html b/docs/html/classuvgrtp_1_1rtcp-members.html index 033b429..6a61393 100644 --- a/docs/html/classuvgrtp_1_1rtcp-members.html +++ b/docs/html/classuvgrtp_1_1rtcp-members.html @@ -79,7 +79,7 @@ $(function() { - +
dataPointer to data the that should be sent
send_app_packet(char *name, uint8_t subtype, size_t payload_len, uint8_t *payload) (defined in uvgrtp::rtcp)uvgrtp::rtcp
send_bye_packet(std::vector< uint32_t > ssrcs) (defined in uvgrtp::rtcp)uvgrtp::rtcp
send_sdes_packet(std::vector< uvgrtp::frame::rtcp_sdes_item > &items) (defined in uvgrtp::rtcp)uvgrtp::rtcp
set_ts_info(uint64_t clock_start, uint32_t clock_rate, uint32_t rtp_ts_start) (defined in uvgrtp::rtcp)uvgrtp::rtcp
set_ts_info(uint64_t clock_start, uint32_t clock_rate, uint32_t rtp_ts_start)uvgrtp::rtcp