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

Adding more comments to every header file in api/ subdirectory.

Browse Source 
Many of these interfaces are not intuitive, or are the way they are for
complex historical reasons, so it would be nice to document these things
for future developers.

Also, many nonstandard things (such as RTCConfiguration options) were
not documented at all before this CL.

BUG=webrtc:7131
TBR=pthatcher@webrtc.org
NOTRY=True

Review-Url: https://codereview.webrtc.org/2680273002
Cr-Commit-Position: refs/heads/master@{#16485}
This commit is contained in:
deadbeef
2017-02-08 01:38:21 -08:00
committed by Commit bot
parent 76e02cd4d8
commit b10f32f9b2
18 changed files with 499 additions and 180 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
webrtc/api/rtpsenderinterface.h
View File

@ -47,9 +47,13 @@ class RtpSenderInterface : public rtc::RefCountInterface {
// to uniquely identify a receiver until we implement Unified Plan SDP.
virtual std::string id() const = 0;
// Returns a list of streams associated with this sender's track. Although we
// only support one track per stream, in theory the API allows for multiple.
virtual std::vector<std::string> stream_ids() const = 0;
virtual RtpParameters GetParameters() const = 0;
// Note that only a subset of the parameters can currently be changed. See
// rtpparameters.h
virtual bool SetParameters(const RtpParameters& parameters) = 0;
// Returns null for a video sender.
@ -60,6 +64,8 @@ class RtpSenderInterface : public rtc::RefCountInterface {
};
// Define proxy for RtpSenderInterface.
// TODO(deadbeef): Move this to .cc file and out of api/. What threads methods
// are called on is an implementation detail.
BEGIN_SIGNALING_PROXY_MAP(RtpSender)
PROXY_SIGNALING_THREAD_DESTRUCTOR()
PROXY_METHOD1(bool, SetTrack, MediaStreamTrackInterface*)