Skip to content

Commit

Permalink
fix unused var
Browse files Browse the repository at this point in the history
  • Loading branch information
disa6302 committed Jun 13, 2024
1 parent 6f170a6 commit d3e426d
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 14 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
1 change: 0 additions & 1 deletion tst/RtpRollingBufferFunctionalityTest.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,6 @@ TEST_F(RtpRollingBufferFunctionalityTest, testRollingBufferParams)
{
RtcConfiguration config{};
PKvsRtpTransceiver pKvsRtpTransceiver = nullptr;
PKvsPeerConnection pKvsPeerConnection = nullptr;
PRtcPeerConnection pRtcPeerConnection = nullptr;
PRtcRtpTransceiver pRtcRtpTransceiver = nullptr;
RtcMediaStreamTrack videoTrack{};
Expand Down

0 comments on commit d3e426d

Please sign in to comment.