diff --git a/docs/html/classuvgrtp_1_1media__stream-members.html b/docs/html/classuvgrtp_1_1media__stream-members.html index bdba6f3..3a9c593 100644 --- a/docs/html/classuvgrtp_1_1media__stream-members.html +++ b/docs/html/classuvgrtp_1_1media__stream-members.html @@ -72,7 +72,7 @@ $(function() {

This is the complete list of members for uvgrtp::media_stream, including all inherited members.

- + diff --git a/docs/html/classuvgrtp_1_1media__stream.html b/docs/html/classuvgrtp_1_1media__stream.html index c7ca5f7..68c90ee 100644 --- a/docs/html/classuvgrtp_1_1media__stream.html +++ b/docs/html/classuvgrtp_1_1media__stream.html @@ -75,8 +75,8 @@ $(function() {
add_srtp_ctx(uint8_t *key, uint8_t *salt) (defined in uvgrtp::media_stream)uvgrtp::media_stream
add_srtp_ctx(uint8_t *key, uint8_t *salt)uvgrtp::media_stream
configure_ctx(int flag, ssize_t value)uvgrtp::media_stream
get_rtcp()uvgrtp::media_stream
install_receive_hook(void *arg, void(*hook)(void *, uvgrtp::frame::rtp_frame *))uvgrtp::media_stream
- + + @@ -107,6 +107,49 @@ rtp_error_t 

Public Member Functions

-rtp_error_t add_srtp_ctx (uint8_t *key, uint8_t *salt)
rtp_error_t add_srtp_ctx (uint8_t *key, uint8_t *salt)
 Add keying information for user-managed SRTP session. More...
 
rtp_error_t push_frame (uint8_t *data, size_t data_len, int flags)
 Send data to remote participant with a custom timestamp. More...
add_srtp_ctx 

Member Function Documentation

+ +

◆ add_srtp_ctx()

+ +
+
+ + + + + + + + + + + + + + + + + + +
rtp_error_t uvgrtp::media_stream::add_srtp_ctx (uint8_t * key,
uint8_t * salt 
)
+
+ +

Add keying information for user-managed SRTP session.

+

For user-managed SRTP session, the media stream is not started until SRTP key has been added and all calls to push_frame() will fail

+

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

+
Returns
RTP error code
+
Return values
+ + + + +
RTP_OKOn success
RTP_INVALID_VALUEIf key or salt is invalid
RTP_NOT_SUPPORTEDIf user-managed SRTP was not specified in create_stream()
+
+
+ +
+

◆ configure_ctx()

diff --git a/docs/html/functions.html b/docs/html/functions.html index 43437d2..36de06f 100644 --- a/docs/html/functions.html +++ b/docs/html/functions.html @@ -62,6 +62,9 @@ $(function() {
Here is a list of all documented class members with links to the class documentation for each member: