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 <deadbeef@webrtc.org>
Reviewed-by: Harald Alvestrand <hta@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#33096}
This commit is contained in:
Taylor Brandstetter 2021-01-26 14:55:38 -08:00 committed by Commit Bot
parent 8bd0f97fe6
commit 9e9bf75dc1

View File

@ -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<cricket::Candidate>& candidates) = 0;