RTCIceCandidate Class Reference

#import <RTCIceCandidate.h>

Inheritance diagram for RTCIceCandidate:

Instance Methods
(instancetype)	- NS_UNAVAILABLE
(instancetype)	- initWithSdp:sdpMLineIndex:sdpMid:
(instancetype)	- NS_UNAVAILABLE
(instancetype)	- initWithSdp:sdpMLineIndex:sdpMid:
(instancetype)	- initWithNativeCandidate: [implementation]
(instancetype)	- initWithNativeCandidate: [implementation]
(NSData *)	- JSONData
(NSData *)	- JSONData

Class Methods
(RTCIceCandidate *)	+ candidateFromJSONDictionary:
(RTCIceCandidate *)	+ candidateFromJSONDictionary:
(NSArray< RTCIceCandidate * > *)	+ candidatesFromJSONDictionary:
(NSArray< RTCIceCandidate * > *)	+ candidatesFromJSONDictionary:
(NSData *)	+ JSONDataForIceCandidates:withType:
(NSData *)	+ JSONDataForIceCandidates:withType:

Public Attributes
readonly attribute DOMString	candidate
readonly attribute DOMString	sdpMid
readonly attribute unsigned short	sdpMLineIndex
	serializer = {candidate, sdpMid, sdpMLineIndex}

Properties
NSString *	sdpMid
int	sdpMLineIndex
NSString *	sdp
NSString *	serverUrl
std::unique_ptr< webrtc::IceCandidateInterface >	nativeCandidate [implementation]

Method Documentation

candidateFromJSONDictionary:() [1/2]

+ (RTCIceCandidate *) candidateFromJSONDictionary:

(NSDictionary *)

dictionary

Provided by category RTCIceCandidate(JSON).

candidateFromJSONDictionary:() [2/2]

+ (RTCIceCandidate *) candidateFromJSONDictionary:

(NSDictionary *)

dictionary

Provided by category RTCIceCandidate(JSON).

candidatesFromJSONDictionary:() [1/2]

+ (NSArray<RTCIceCandidate *> *) candidatesFromJSONDictionary:

(NSDictionary *)

dictionary

Provided by category RTCIceCandidate(JSON).

candidatesFromJSONDictionary:() [2/2]

+ (NSArray< RTCIceCandidate * > *) candidatesFromJSONDictionary:

(NSDictionary *)

dictionary

Provided by category RTCIceCandidate(JSON).

initWithNativeCandidate:() [1/2]

- (instancetype) initWithNativeCandidate: (const webrtc::IceCandidateInterface *)  candidate

implementation

Initialize an RTCIceCandidate from a native IceCandidateInterface. No ownership is taken of the native candidate.

initWithNativeCandidate:() [2/2]

- (instancetype) initWithNativeCandidate: (const webrtc::IceCandidateInterface *)  candidate

implementation

Initialize an RTCIceCandidate from a native IceCandidateInterface. No ownership is taken of the native candidate.

initWithSdp:sdpMLineIndex:sdpMid:() [1/2]

- (instancetype) initWithSdp:		(NSString *)	sdp
sdpMLineIndex:		(int)	sdpMLineIndex
sdpMid:		(nullable NSString *)	NS_DESIGNATED_INITIALIZER

Initialize an RTCIceCandidate from SDP.

initWithSdp:sdpMLineIndex:sdpMid:() [2/2]

- (instancetype) initWithSdp:		(NSString *)	sdp
sdpMLineIndex:		(int)	sdpMLineIndex
sdpMid:		(nullable NSString *)	NS_DESIGNATED_INITIALIZER

Initialize an RTCIceCandidate from SDP.

JSONData() [1/2]

- (NSData *) JSONData

Provided by category RTCIceCandidate(JSON).

JSONData() [2/2]

- (NSData *) JSONData

Provided by category RTCIceCandidate(JSON).

JSONDataForIceCandidates:withType:() [1/2]

+ (NSData *) JSONDataForIceCandidates:		(NSArray< RTCIceCandidate * > *)	candidates
withType:		(NSString *)	typeValue

Provided by category RTCIceCandidate(JSON).

JSONDataForIceCandidates:withType:() [2/2]

+ (NSData *) JSONDataForIceCandidates:		(NSArray<RTCIceCandidate *> *)	candidates
withType:		(NSString *)	typeValue

Provided by category RTCIceCandidate(JSON).

NS_UNAVAILABLE() [1/2]

- (instancetype) NS_UNAVAILABLE

NS_UNAVAILABLE() [2/2]

- (instancetype) NS_UNAVAILABLE

Member Data Documentation

candidate

- (readonly attribute DOMString) candidate

sdpMid

- (readonly attribute DOMString) sdpMid

sdpMLineIndex

- (readonly attribute unsigned short) sdpMLineIndex

serializer

- serializer = {candidate, sdpMid, sdpMLineIndex}

Property Documentation

nativeCandidate

- (unique_ptr<)webrtc:

readnonatomicassignimplementation

The native IceCandidateInterface representation of this RTCIceCandidate object. This is needed to pass to the underlying C++ APIs.

sdp

- (NSString *) sdp

readnonatomicassign

The SDP string for this candidate.

sdpMid

- (NSString *) sdpMid

readnonatomicassign

If present, the identifier of the "media stream identification" for the media component this candidate is associated with.

sdpMLineIndex

- (int) sdpMLineIndex

readnonatomicassign

The index (starting at zero) of the media description this candidate is associated with in the SDP.

serverUrl

- (NSString *) serverUrl

readnonatomicassign

The URL of the ICE server which this candidate is gathered from.

---

The documentation for this class was generated from the following files:

• DerivedData/WebKit/Build/Products/Debug/usr/local/include/webrtc/sdk/objc/Framework/Headers/WebRTC/RTCIceCandidate.h
• Source/WebCore/Modules/mediastream/RTCIceCandidate.idl