From d3e426d9992d7c8383d2a0afdce3e1740e36d8c3 Mon Sep 17 00:00:00 2001 From: Divya Sampath Kumar Date: Wed, 12 Jun 2024 17:12:31 -0700 Subject: [PATCH] fix unused var --- README.md | 26 +++++++++++------------ tst/RtpRollingBufferFunctionalityTest.cpp | 1 - 2 files changed, 13 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 1d2772f660..72dc2a54c4 100644 --- a/README.md +++ b/README.md @@ -423,6 +423,19 @@ The samples provided with this SDK have been tested with a lowest stack size of If your SOC/platform has a high default stack size, it is recommended to tweak these values to ensure reducing your application's memory footprint. +### Disable ICE agent stats + +The SDK calculates 4 different stats: +1. ICE server stats - stats for ICE servers the SDK is using +2. [Local candidate stats](https://www.w3.org/TR/webrtc-stats/#dom-rtcstatstype-local-candidate) - stats for the selected local candidate +3. [Remote candidate stats](https://www.w3.org/TR/webrtc-stats/#dom-rtcstatstype-remote-candidate) - stats for the selected remote candidate +4. [Candidate pair stats](https://www.w3.org/TR/webrtc-stats/#dom-rtcstatstype-candidate-pair) - stats for the selected candidate pair + +For more information on these stats, refer to [AWS Docs](https://docs.aws.amazon.com/kinesisvideostreams-webrtc-dg/latest/devguide/kvswebrtc-reference.html) + +The SDK disables generating these stats by default. In order to be enable the SDK to calculate these stats, the application needs to set the following field: +`configuration.kvsRtcConfiguration.enableIceStats = TRUE`. Note that this increases the memory usage by about 200KB per peer connection. + ## Setup IoT * To use IoT certificate to authenticate with KVS signaling, please refer to [Controlling Access to Kinesis Video Streams Resources Using AWS IoT](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/how-iot.html) for provisioning details. * A sample IAM policy for the IoT role looks like below, policy can be modified based on your permission requirement. @@ -632,19 +645,6 @@ Let us look into when each of these could be changed: 3. `iceConnectionCheckTimeout`: It is useful to increase this timeout in unstable/slow network where the packet exchange takes time and hence the binding request/response. Essentially, increasing it will allow atleast one candidate pair to be tried for nomination by the other peer. 4. `iceConnectionCheckPollingInterval`: This value is set to a default of 50 ms per [spec](https://datatracker.ietf.org/doc/html/rfc8445#section-14.2). Changing this would change the frequency of connectivity checks and essentially, the ICE state machine transitions. Decreasing the value could help in faster connection establishment in a reliable high performant network setting with good system resources. Increasing the value could help in reducing the network load, however, the connection establishment could slow down. Unless there is a strong reasoning, it is **NOT** recommended to deviate from spec/default. -### Enable ICE agent stats - -The SDK calculates 4 different stats: -1. ICE server stats - stats for ICE servers the SDK is using -2. [Local candidate stats](https://www.w3.org/TR/webrtc-stats/#dom-rtcstatstype-local-candidate) - stats for the selected local candidate -3. [Remote candidate stats](https://www.w3.org/TR/webrtc-stats/#dom-rtcstatstype-remote-candidate) - stats for the selected remote candidate -4. [Candidate pair stats](https://www.w3.org/TR/webrtc-stats/#dom-rtcstatstype-candidate-pair) - stats for the selected candidate pair - -For more information on these stats, refer to [AWS Docs](https://docs.aws.amazon.com/kinesisvideostreams-webrtc-dg/latest/devguide/kvswebrtc-reference.html) - -The SDK disables generating these stats by default. In order to be enable the SDK to calculate these stats, the application needs to set the following field: -`configuration.kvsRtcConfiguration.enableIceStats = TRUE`. - ## Documentation All Public APIs are documented in our [Include.h](https://github.com/awslabs/amazon-kinesis-video-streams-webrtc-sdk-c/blob/master/src/include/com/amazonaws/kinesis/video/webrtcclient/Include.h), we also generate a [Doxygen](https://awslabs.github.io/amazon-kinesis-video-streams-webrtc-sdk-c/) each commit for easier navigation. diff --git a/tst/RtpRollingBufferFunctionalityTest.cpp b/tst/RtpRollingBufferFunctionalityTest.cpp index 94ad1baaea..7714f02538 100644 --- a/tst/RtpRollingBufferFunctionalityTest.cpp +++ b/tst/RtpRollingBufferFunctionalityTest.cpp @@ -159,7 +159,6 @@ TEST_F(RtpRollingBufferFunctionalityTest, testRollingBufferParams) { RtcConfiguration config{}; PKvsRtpTransceiver pKvsRtpTransceiver = nullptr; - PKvsPeerConnection pKvsPeerConnection = nullptr; PRtcPeerConnection pRtcPeerConnection = nullptr; PRtcRtpTransceiver pRtcRtpTransceiver = nullptr; RtcMediaStreamTrack videoTrack{};