From 9e9bf75dc1fb65c90216125e94b14872123db040 Mon Sep 17 00:00:00 2001 From: Taylor Brandstetter Date: Tue, 26 Jan 2021 14:55:38 -0800 Subject: [PATCH] Add comment about setting transport_name field for RemoveIceCandidates. NOTRY=True Bug: webrtc:8395 Change-Id: If00bcebd35eaf833ae84ba1cd42e7ca93ab76536 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/203940 Commit-Queue: Taylor Reviewed-by: Harald Alvestrand Cr-Commit-Position: refs/heads/master@{#33096} --- api/peer_connection_interface.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/api/peer_connection_interface.h b/api/peer_connection_interface.h index d7f4e19f4b..cc655926f3 100644 --- a/api/peer_connection_interface.h +++ b/api/peer_connection_interface.h @@ -1056,7 +1056,10 @@ class RTC_EXPORT PeerConnectionInterface : public rtc::RefCountInterface { // Removes a group of remote candidates from the ICE agent. Needed mainly for // continual gathering, to avoid an ever-growing list of candidates as - // networks come and go. + // networks come and go. Note that the candidates' transport_name must be set + // to the MID of the m= section that generated the candidate. + // TODO(bugs.webrtc.org/8395): Use IceCandidateInterface instead of + // cricket::Candidate, which would avoid the transport_name oddity. virtual bool RemoveIceCandidates( const std::vector& candidates) = 0;