TVOIceCandidateStats

Objective-C

@interface TVOIceCandidateStats : NSObject

Swift

class TVOIceCandidateStats : NSObject

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

  • @brief Ice candidate type.

    Declaration

    Objective-C

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

    Swift

    var candidateType: String? { get }

  • @brief Determines if the ice candidate is deleted or not.

    @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.

    Declaration

    Objective-C

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

    Swift

    var isDeleted: Bool { get }
  • ip

    @brief 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.

    Declaration

    Objective-C

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

    Swift

    var ip: String? { get }

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

    Declaration

    Objective-C

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

    Swift

    var isRemote: Bool { get }

  • @brief The port number of the candidate.

    Declaration

    Objective-C

    @property (nonatomic, readonly) long port;

    Swift

    var port: Int { get }

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

    Declaration

    Objective-C

    @property (nonatomic, readonly) long priority;

    Swift

    var priority: Int { get }

  • @brief 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.

    Declaration

    Objective-C

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

    Swift

    var `protocol`: String? { get }
  • url

    @brief 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.

    Declaration

    Objective-C

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

    Swift

    var url: String? { get }

  • @brief The unique identifier used for TVOIceCandidateStats associated with this candidate.

    Declaration

    Objective-C

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

    Swift

    var transportId: String? { get }

  • Unavailable

    TVOIceCandidateStats cannot be created explicitly.

    @brief Developers shouldn’t initialize this class directly.

    @discussion Ice candidate stats cannot be created explicitly.

    Declaration

    Objective-C

    - (null_unspecified instancetype)init;