blob: e28f8b0f5788f7e3576e548708fdd11da59ef500 [file] [log] [blame]
henrike@webrtc.org28e20752013-07-10 00:45:361/*
kjellanderb24317b2016-02-10 15:54:432 * Copyright 2012 The WebRTC project authors. All Rights Reserved.
henrike@webrtc.org28e20752013-07-10 00:45:363 *
kjellanderb24317b2016-02-10 15:54:434 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
henrike@webrtc.org28e20752013-07-10 00:45:369 */
10
deadbeefb10f32f2017-02-08 09:38:2111// TODO(deadbeef): Move this out of api/; it's an implementation detail and
12// shouldn't be used externally.
henrike@webrtc.org28e20752013-07-10 00:45:3613
Steve Anton10542f22019-01-11 17:11:0014#ifndef API_JSEP_SESSION_DESCRIPTION_H_
15#define API_JSEP_SESSION_DESCRIPTION_H_
henrike@webrtc.org28e20752013-07-10 00:45:3616
Dor Hen28ce65c2024-09-04 11:55:2217#include <cstddef>
kwibergd1fe2812016-04-27 13:47:2918#include <memory>
henrike@webrtc.org28e20752013-07-10 00:45:3619#include <string>
20#include <vector>
21
Steve Anton6fe1fba2018-12-11 18:15:2322#include "absl/strings/string_view.h"
Patrik Höglunde2d6a062017-10-05 12:53:3323#include "api/candidate.h"
Mirko Bonadei92ea95e2017-09-15 04:47:3124#include "api/jsep.h"
Steve Anton10542f22019-01-11 17:11:0025#include "api/jsep_ice_candidate.h"
henrike@webrtc.org28e20752013-07-10 00:45:3626
27namespace cricket {
28class SessionDescription;
29}
30
31namespace webrtc {
32
deadbeefb10f32f2017-02-08 09:38:2133// Implementation of SessionDescriptionInterface.
henrike@webrtc.org28e20752013-07-10 00:45:3634class JsepSessionDescription : public SessionDescriptionInterface {
35 public:
Steve Anton88f2cb92017-12-05 20:47:3236 explicit JsepSessionDescription(SdpType type);
37 // TODO(steveanton): Remove this once callers have switched to SdpType.
henrike@webrtc.org28e20752013-07-10 00:45:3638 explicit JsepSessionDescription(const std::string& type);
Steve Anton6fe1fba2018-12-11 18:15:2339 JsepSessionDescription(
40 SdpType type,
41 std::unique_ptr<cricket::SessionDescription> description,
42 absl::string_view session_id,
43 absl::string_view session_version);
henrike@webrtc.org28e20752013-07-10 00:45:3644 virtual ~JsepSessionDescription();
45
Byoungchan Leec065e732022-01-18 00:35:4846 JsepSessionDescription(const JsepSessionDescription&) = delete;
47 JsepSessionDescription& operator=(const JsepSessionDescription&) = delete;
48
Artem Titov0e61fdd2021-07-25 19:50:1449 // Takes ownership of `description`.
Harald Alvestrand4d7160e2019-04-12 05:01:2950 bool Initialize(std::unique_ptr<cricket::SessionDescription> description,
51 const std::string& session_id,
52 const std::string& session_version);
henrike@webrtc.org28e20752013-07-10 00:45:3653
Harald Alvestrandc908f1c2020-12-17 19:28:2954 virtual std::unique_ptr<SessionDescriptionInterface> Clone() const;
Harald Alvestrand0e7b3a92020-12-15 15:18:2855
henrike@webrtc.org28e20752013-07-10 00:45:3656 virtual cricket::SessionDescription* description() {
57 return description_.get();
58 }
59 virtual const cricket::SessionDescription* description() const {
60 return description_.get();
61 }
Yves Gerey665174f2018-06-19 13:03:0562 virtual std::string session_id() const { return session_id_; }
63 virtual std::string session_version() const { return session_version_; }
Steve Anton88f2cb92017-12-05 20:47:3264 virtual SdpType GetType() const { return type_; }
65 virtual std::string type() const { return SdpTypeToString(type_); }
deadbeefb10f32f2017-02-08 09:38:2166 // Allows changing the type. Used for testing.
henrike@webrtc.org28e20752013-07-10 00:45:3667 virtual bool AddCandidate(const IceCandidateInterface* candidate);
Honghai Zhang7fb69db2016-03-14 18:59:1868 virtual size_t RemoveCandidates(
69 const std::vector<cricket::Candidate>& candidates);
henrike@webrtc.org28e20752013-07-10 00:45:3670 virtual size_t number_of_mediasections() const;
71 virtual const IceCandidateCollection* candidates(
72 size_t mediasection_index) const;
73 virtual bool ToString(std::string* out) const;
74
henrike@webrtc.org28e20752013-07-10 00:45:3675 private:
kwibergd1fe2812016-04-27 13:47:2976 std::unique_ptr<cricket::SessionDescription> description_;
henrike@webrtc.org28e20752013-07-10 00:45:3677 std::string session_id_;
78 std::string session_version_;
Steve Anton88f2cb92017-12-05 20:47:3279 SdpType type_;
henrike@webrtc.org28e20752013-07-10 00:45:3680 std::vector<JsepCandidateCollection> candidate_collection_;
81
82 bool GetMediasectionIndex(const IceCandidateInterface* candidate,
83 size_t* index);
Honghai Zhang7fb69db2016-03-14 18:59:1884 int GetMediasectionIndex(const cricket::Candidate& candidate);
henrike@webrtc.org28e20752013-07-10 00:45:3685};
86
87} // namespace webrtc
88
Steve Anton10542f22019-01-11 17:11:0089#endif // API_JSEP_SESSION_DESCRIPTION_H_