b10f32f9b2
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}
93 lines
2.9 KiB
C++
93 lines
2.9 KiB
C++
/*
|
|
* Copyright 2012 The WebRTC project authors. All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by a BSD-style license
|
|
* that can be found in the LICENSE file in the root of the source
|
|
* tree. An additional intellectual property rights grant can be found
|
|
* in the file PATENTS. All contributing project authors may
|
|
* be found in the AUTHORS file in the root of the source tree.
|
|
*/
|
|
|
|
// TODO(deadbeef): Move this out of api/; it's an implementation detail and
|
|
// shouldn't be used externally.
|
|
|
|
#ifndef WEBRTC_API_JSEPSESSIONDESCRIPTION_H_
|
|
#define WEBRTC_API_JSEPSESSIONDESCRIPTION_H_
|
|
|
|
#include <memory>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include "webrtc/api/jsep.h"
|
|
#include "webrtc/api/jsepicecandidate.h"
|
|
#include "webrtc/base/constructormagic.h"
|
|
#include "webrtc/p2p/base/candidate.h"
|
|
|
|
namespace cricket {
|
|
class SessionDescription;
|
|
}
|
|
|
|
namespace webrtc {
|
|
|
|
// Implementation of SessionDescriptionInterface.
|
|
class JsepSessionDescription : public SessionDescriptionInterface {
|
|
public:
|
|
explicit JsepSessionDescription(const std::string& type);
|
|
virtual ~JsepSessionDescription();
|
|
|
|
// |error| may be NULL.
|
|
bool Initialize(const std::string& sdp, SdpParseError* error);
|
|
|
|
// Takes ownership of |description|.
|
|
// TODO(deadbeef): Make this use an std::unique_ptr<>, so ownership logic is
|
|
// more clear.
|
|
bool Initialize(cricket::SessionDescription* description,
|
|
const std::string& session_id,
|
|
const std::string& session_version);
|
|
|
|
virtual cricket::SessionDescription* description() {
|
|
return description_.get();
|
|
}
|
|
virtual const cricket::SessionDescription* description() const {
|
|
return description_.get();
|
|
}
|
|
virtual std::string session_id() const {
|
|
return session_id_;
|
|
}
|
|
virtual std::string session_version() const {
|
|
return session_version_;
|
|
}
|
|
virtual std::string type() const {
|
|
return type_;
|
|
}
|
|
// Allows changing the type. Used for testing.
|
|
void set_type(const std::string& type) { type_ = type; }
|
|
virtual bool AddCandidate(const IceCandidateInterface* candidate);
|
|
virtual size_t RemoveCandidates(
|
|
const std::vector<cricket::Candidate>& candidates);
|
|
virtual size_t number_of_mediasections() const;
|
|
virtual const IceCandidateCollection* candidates(
|
|
size_t mediasection_index) const;
|
|
virtual bool ToString(std::string* out) const;
|
|
|
|
static const int kDefaultVideoCodecId;
|
|
static const char kDefaultVideoCodecName[];
|
|
|
|
private:
|
|
std::unique_ptr<cricket::SessionDescription> description_;
|
|
std::string session_id_;
|
|
std::string session_version_;
|
|
std::string type_;
|
|
std::vector<JsepCandidateCollection> candidate_collection_;
|
|
|
|
bool GetMediasectionIndex(const IceCandidateInterface* candidate,
|
|
size_t* index);
|
|
int GetMediasectionIndex(const cricket::Candidate& candidate);
|
|
|
|
RTC_DISALLOW_COPY_AND_ASSIGN(JsepSessionDescription);
|
|
};
|
|
|
|
} // namespace webrtc
|
|
|
|
#endif // WEBRTC_API_JSEPSESSIONDESCRIPTION_H_
|