summaryrefslogtreecommitdiff
path: root/Source/Platform/chromium/public/WebSessionDescriptionDescriptor.h
blob: 2bee45319f5aae82c499c4dc2a30e62440b0ef31 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
/*
 * Copyright (C) 2012 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef WebSessionDescriptionDescriptor_h
#define WebSessionDescriptionDescriptor_h

#include "WebCommon.h"
#include "WebNonCopyable.h"
#include "WebPrivatePtr.h"

namespace WebCore {
class SessionDescriptionDescriptor;
}

namespace WebKit {
class WebString;
class WebICECandidateDescriptor;

/*
 *  In order to establish the media plane, PeerConnection needs specific
 *  parameters to indicate what to transmit to the remote side, as well
 *  as how to handle the media that is received. These parameters are
 *  determined by the exchange of session descriptions in offers and
 *  answers, and there are certain details to this process that must be
 *  handled in the JSEP APIs.

 *  Whether a session description was sent or received affects the
 *  meaning of that description. For example, the list of codecs sent to
 *  a remote party indicates what the local side is willing to decode,
 *  and what the remote party should send.
 */
class WebSessionDescriptionDescriptor {
public:
    WebSessionDescriptionDescriptor() { }
    WebSessionDescriptionDescriptor(const WebSessionDescriptionDescriptor& other) { assign(other); }
    ~WebSessionDescriptionDescriptor() { reset(); }

    WebSessionDescriptionDescriptor& operator=(const WebSessionDescriptionDescriptor& other)
    {
        assign(other);
        return *this;
    }

    WEBKIT_EXPORT void assign(const WebSessionDescriptionDescriptor&);

    WEBKIT_EXPORT void initialize(const WebString& sdp);
    WEBKIT_EXPORT void reset();
    bool isNull() const { return m_private.isNull(); }

    WEBKIT_EXPORT size_t numberOfAddedCandidates() const;
    WEBKIT_EXPORT WebICECandidateDescriptor candidate(size_t index) const;
    WEBKIT_EXPORT WebString initialSDP() const;

#if WEBKIT_IMPLEMENTATION
    WebSessionDescriptionDescriptor(const WTF::PassRefPtr<WebCore::SessionDescriptionDescriptor>&);

    operator WTF::PassRefPtr<WebCore::SessionDescriptionDescriptor>();
#endif

private:
    WebPrivatePtr<WebCore::SessionDescriptionDescriptor> m_private;
};

} // namespace WebKit

#endif // WebSessionDescriptionDescriptor_h