TVIIceCandidateStats Class Reference

Inherits from NSObject
Declared in TVIIceCandidateStats.h

Overview

TVIIceCandidateStats reflects the properties of a candidate in Section 15.1 in [RFC5245].

  candidateType

Ice candidate type.

@property (nonatomic, copy, readonly, nullable) NSString *candidateType

Declared In

TVIIceCandidateStats.h

  deleted

Determines if the ice candidate is deleted or not.

@property (nonatomic, assign, readonly, getter=isDeleted) BOOL deleted

Discussion

For local candidates, YES indicates that the candidate has been deleted/freed as described by [RFC5245]. For host candidates, this means that any network resources (typically a socket) associated with the candidate have been released. For TURN candidates, this means the TURN allocation is no longer active.

Declared In

TVIIceCandidateStats.h

  ip

The IP address of the candidate, allowing for IPv4 addresses and IPv6 addresses, but fully qualified domain names (FQDNs) are not allowed. See [RFC5245] section 15.1 for details.

@property (nonatomic, copy, readonly, nullable) NSString *ip

Declared In

TVIIceCandidateStats.h

  remote

NO indicates that this represents a local candidate; YES indicates that this represents a remote candidate.

@property (nonatomic, assign, readonly, getter=isRemote) BOOL remote

Declared In

TVIIceCandidateStats.h

  port

The port number of the candidate.

@property (nonatomic, assign, readonly) long port

Declared In

TVIIceCandidateStats.h

  priority

The priority of the candidate. Priority is calculated as defined in [RFC5245] section 15.1.

@property (nonatomic, assign, readonly) long priority

Declared In

TVIIceCandidateStats.h

  protocol

The protocol used by the candidate. The valid values for transport is one of udp and tcp. Based on the “transport” defined in [RFC5245] section 15.1.

@property (nonatomic, copy, readonly, nullable) NSString *protocol

Declared In

TVIIceCandidateStats.h

  url

The URL of the TURN or STUN server indicated in the that translated this IP address. It is the URL address surfaced in an peer connection ice event.

@property (nonatomic, copy, readonly, nullable) NSString *url

Declared In

TVIIceCandidateStats.h

  transportId

The unique identifier used for TVIIceCandidateStats associated with this candidate.

@property (nonatomic, copy, readonly, nullable) NSString *transportId

Declared In

TVIIceCandidateStats.h

– init

Developers shouldn’t initialize this class directly.

- (null_unspecified instancetype)init

Discussion

Ice candidate stats cannot be created explicitly.

Declared In

TVIIceCandidateStats.h