1 /*
2  * libjingle
3  * Copyright 2013 Google Inc.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  *  1. Redistributions of source code must retain the above copyright notice,
9  *     this list of conditions and the following disclaimer.
10  *  2. Redistributions in binary form must reproduce the above copyright notice,
11  *     this list of conditions and the following disclaimer in the documentation
12  *     and/or other materials provided with the distribution.
13  *  3. The name of the author may not be used to endorse or promote products
14  *     derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
19  * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #import <Foundation/Foundation.h>
29 
30 // RTCICECandidate contains an instance of ICECandidateInterface.
31 @interface RTCICECandidate : NSObject
32 
33 // If present, this contains the identifier of the "media stream
34 // identification" as defined in [RFC 3388] for m-line this candidate is
35 // associated with.
36 @property(nonatomic, copy, readonly) NSString* sdpMid;
37 
38 // This indicates the index (starting at zero) of m-line in the SDP this
39 // candidate is associated with.
40 @property(nonatomic, assign, readonly) NSInteger sdpMLineIndex;
41 
42 // Creates an SDP-ized form of this candidate.
43 @property(nonatomic, copy, readonly) NSString* sdp;
44 
45 // Creates an ICECandidateInterface based on SDP string.
46 - (id)initWithMid:(NSString*)sdpMid
47             index:(NSInteger)sdpMLineIndex
48               sdp:(NSString*)sdp;
49 
50 #ifndef DOXYGEN_SHOULD_SKIP_THIS
51 // Disallow init and don't add to documentation
52 - (id)init __attribute__((
53     unavailable("init is not a supported initializer for this class.")));
54 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
55 
56 @end
57