zqz/platform-external-webrtc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve comments.

Browse Source 
Use the current parameter names in the comment for SetNackMode().

Add a warning comment about the lifetime of the return value of
GetNackList().

R=stefan@webrtc.org
BUG=none
TEST=none

Review URL: https://webrtc-codereview.appspot.com/52599004

Cr-Commit-Position: refs/heads/master@{#9321}
This commit is contained in:
Wan-Teh Chang
2015-05-28 14:10:14 -07:00
parent 7c4e7458b5
commit 603175a395
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
webrtc/modules/video_coding/main/source/jitter_buffer.h
View File

@ -155,12 +155,12 @@ class VCMJitterBuffer {
// Updates the round-trip time estimate. // Updates the round-trip time estimate.
void UpdateRtt(int64_t rtt_ms); void UpdateRtt(int64_t rtt_ms);
// Set the NACK mode. |highRttNackThreshold| is an RTT threshold in ms above // Set the NACK mode. |high_rtt_nack_threshold_ms| is an RTT threshold in ms
// which NACK will be disabled if the NACK mode is |kNackHybrid|, -1 meaning // above which NACK will be disabled if the NACK mode is |kNackHybrid|, -1
// that NACK is always enabled in the hybrid mode. // meaning that NACK is always enabled in the hybrid mode.
// |lowRttNackThreshold| is an RTT threshold in ms below which we expect to // |low_rtt_nack_threshold_ms| is an RTT threshold in ms below which we expect
// rely on NACK only, and therefore are using larger buffers to have time to // to rely on NACK only, and therefore are using larger buffers to have time
// wait for retransmissions. // to wait for retransmissions.
void SetNackMode(VCMNackMode mode, int64_t low_rtt_nack_threshold_ms, void SetNackMode(VCMNackMode mode, int64_t low_rtt_nack_threshold_ms,
int64_t high_rtt_nack_threshold_ms); int64_t high_rtt_nack_threshold_ms);
@ -172,6 +172,8 @@ class VCMJitterBuffer {
VCMNackMode nack_mode() const; VCMNackMode nack_mode() const;
// Returns a list of the sequence numbers currently missing. // Returns a list of the sequence numbers currently missing.
// WARNING: GetNackList() returns a pointer to an internal buffer that is only
// valid until the next GetNackList() call.
uint16_t* GetNackList(uint16_t* nack_list_size, bool* request_key_frame); uint16_t* GetNackList(uint16_t* nack_list_size, bool* request_key_frame);
// Set decode error mode - Should not be changed in the middle of the // Set decode error mode - Should not be changed in the middle of the