OLD | NEW |
| (Empty) |
1 /* | |
2 * Copyright 2011 The WebRTC project authors. All Rights Reserved. | |
3 * | |
4 * 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. | |
9 */ | |
10 | |
11 // This file contain functions for parsing and serializing SDP messages. | |
12 // Related RFC/draft including: | |
13 // * RFC 4566 - SDP | |
14 // * RFC 5245 - ICE | |
15 // * RFC 3388 - Grouping of Media Lines in SDP | |
16 // * RFC 4568 - SDP Security Descriptions for Media Streams | |
17 // * draft-lennox-mmusic-sdp-source-selection-02 - | |
18 // Mechanisms for Media Source Selection in SDP | |
19 | |
20 #ifndef WEBRTC_API_WEBRTCSDP_H_ | |
21 #define WEBRTC_API_WEBRTCSDP_H_ | |
22 | |
23 #include <string> | |
24 | |
25 namespace cricket { | |
26 class Candidate; | |
27 } // namespace cricket | |
28 | |
29 namespace webrtc { | |
30 class IceCandidateInterface; | |
31 class JsepIceCandidate; | |
32 class JsepSessionDescription; | |
33 struct SdpParseError; | |
34 | |
35 // Serializes the passed in JsepSessionDescription. | |
36 // Serialize SessionDescription including candidates if | |
37 // JsepSessionDescription has candidates. | |
38 // jdesc - The JsepSessionDescription object to be serialized. | |
39 // unified_plan_sdp - If set to true, include "a=msid" lines where appropriate. | |
40 // return - SDP string serialized from the arguments. | |
41 std::string SdpSerialize(const JsepSessionDescription& jdesc, | |
42 bool unified_plan_sdp); | |
43 | |
44 // Serializes the passed in IceCandidateInterface to a SDP string. | |
45 // candidate - The candidate to be serialized. | |
46 std::string SdpSerializeCandidate(const IceCandidateInterface& candidate); | |
47 | |
48 // Serializes a cricket Candidate. | |
49 // candidate - The candidate to be serialized. | |
50 std::string SdpSerializeCandidate(const cricket::Candidate& candidate); | |
51 | |
52 // Deserializes the passed in SDP string to a JsepSessionDescription. | |
53 // message - SDP string to be Deserialized. | |
54 // jdesc - The JsepSessionDescription deserialized from the SDP string. | |
55 // error - The detail error information when parsing fails. | |
56 // return - true on success, false on failure. | |
57 bool SdpDeserialize(const std::string& message, | |
58 JsepSessionDescription* jdesc, | |
59 SdpParseError* error); | |
60 | |
61 // Deserializes the passed in SDP string to one JsepIceCandidate. | |
62 // The first line must be a=candidate line and only the first line will be | |
63 // parsed. | |
64 // message - The SDP string to be Deserialized. | |
65 // candidates - The JsepIceCandidate from the SDP string. | |
66 // error - The detail error information when parsing fails. | |
67 // return - true on success, false on failure. | |
68 bool SdpDeserializeCandidate(const std::string& message, | |
69 JsepIceCandidate* candidate, | |
70 SdpParseError* error); | |
71 | |
72 // Deserializes the passed in SDP string to a cricket Candidate. | |
73 // The first line must be a=candidate line and only the first line will be | |
74 // parsed. | |
75 // transport_name - The transport name (MID) of the candidate. | |
76 // message - The SDP string to be deserialized. | |
77 // candidate - The cricket Candidate from the SDP string. | |
78 // error - The detail error information when parsing fails. | |
79 // return - true on success, false on failure. | |
80 bool SdpDeserializeCandidate(const std::string& transport_name, | |
81 const std::string& message, | |
82 cricket::Candidate* candidate, | |
83 SdpParseError* error); | |
84 | |
85 } // namespace webrtc | |
86 | |
87 #endif // WEBRTC_API_WEBRTCSDP_H_ | |
OLD | NEW |