FMIceLinkSdpIceCandidateAttribute Class Reference

Inherits from FMIceLinkSdpAttribute : NSObject
Declared in FMIceLinkSdpIceCandidateAttribute.h
FMIceLinkSdpIceCandidateAttribute.m

Overview

The candidate attribute is a media-level attribute only. It contains a trans[port](#//api/name/port) address for a candidate that can be used for connectivity checks.

+ candidateAttributeWithFoundation:priority:connectionAddress:port:candidateType:componentId:

Initializes a new instance of the FMIceLinkSdpIceCandidateAttribute class.
+ (FMIceLinkSdpIceCandidateAttribute *)candidateAttributeWithFoundation:(NSString *)foundation priority:(long long)priority connectionAddress:(NSString *)connectionAddress port:(int)port candidateType:(NSString *)candidateType componentId:(int)componentId

Parameters

foundation

The candidate’s foundation.
priority

The priority of the candidate.
connectionAddress

The IP address of the candidate.
port

The port of the candidate.
candidateType

The type of the candidate. See FMIceLinkSdpIceCandidateAttribute#candidateType for possible values.
componentId

The component identifier.

Discussion

Initializes a new instance of the FMIceLinkSdpIceCandidateAttribute class.

Declared In

FMIceLinkSdpIceCandidateAttribute.h

+ candidateAttributeWithFoundation:priority:connectionAddress:port:candidateType:relatedAddress:relatedPort:protocol:componentId:

Initializes a new instance of the FMIceLinkSdpIceCandidateAttribute class.
+ (FMIceLinkSdpIceCandidateAttribute *)candidateAttributeWithFoundation:(NSString *)foundation priority:(long long)priority connectionAddress:(NSString *)connectionAddress port:(int)port candidateType:(NSString *)candidateType relatedAddress:(NSString *)relatedAddress relatedPort:(int)relatedPort protocol:(NSString *)protocol componentId:(int)componentId

Parameters

foundation

The candidate’s foundation.
priority

The priority of the candidate.
connectionAddress

The IP address of the candidate.
port

The port of the candidate.
candidateType

The type of the candidate. See FMIceLinkSdpIceCandidateAttribute#candidateType for possible values.
relatedAddress

The IP address related to the candidate.
relatedPort

The port related to the candidate.
protocol

The protocol.
componentId

The ID of the component for which this is a candidate.

Discussion

Initializes a new instance of the FMIceLinkSdpIceCandidateAttribute class.

Declared In

FMIceLinkSdpIceCandidateAttribute.h

– candidateType

Gets the type of the candidate. See FMIceLinkSdpIceCandidateAttribute#candidateType for possible values.
- (NSString *)candidateType

Discussion

Gets the type of the candidate. See FMIceLinkSdpIceCandidateAttribute#candidateType for possible values.

Declared In

FMIceLinkSdpIceCandidateAttribute.h

– componentId

Gets the ID of the component for which this is a candidate.
- (int)componentId

Discussion

Gets the ID of the component for which this is a candidate.

Declared In

FMIceLinkSdpIceCandidateAttribute.h

– connectionAddress

Gets the IP address of the candidate.
- (NSString *)connectionAddress

Discussion

Gets the IP address of the candidate.

Declared In

FMIceLinkSdpIceCandidateAttribute.h

– extensions

Gets the extensions.
- (NSMutableDictionary<NSString*,NSString*> *)extensions

Discussion

Gets the extensions.

Declared In

FMIceLinkSdpIceCandidateAttribute.h

– foundation

Gets the candidate's foundation.
- (NSString *)foundation

Discussion

Gets the candidate's foundation.

Declared In

FMIceLinkSdpIceCandidateAttribute.h

+ fromAttributeValue:

Initializes a new instance of the FMIceLinkSdpIceCandidateAttribute class.
+ (FMIceLinkSdpIceCandidateAttribute *)fromAttributeValue:(NSString *)value

Parameters

value

The attribute as a string.

Discussion

Initializes a new instance of the FMIceLinkSdpIceCandidateAttribute class.

Declared In

FMIceLinkSdpIceCandidateAttribute.h

– getAttributeValue

Gets the value of the attribute.
- (NSString *)getAttributeValue

Discussion

Gets the value of the attribute.

Declared In

FMIceLinkSdpIceCandidateAttribute.h

– initWithFoundation:priority:connectionAddress:port:candidateType:componentId:

Initializes a new instance of the FMIceLinkSdpIceCandidateAttribute class.
- (instancetype)initWithFoundation:(NSString *)foundation priority:(long long)priority connectionAddress:(NSString *)connectionAddress port:(int)port candidateType:(NSString *)candidateType componentId:(int)componentId

Parameters

foundation

The candidate’s foundation.
priority

The priority of the candidate.
connectionAddress

The IP address of the candidate.
port

The port of the candidate.
candidateType

The type of the candidate. See FMIceLinkSdpIceCandidateAttribute#candidateType for possible values.
componentId

The component identifier.

Discussion

Initializes a new instance of the FMIceLinkSdpIceCandidateAttribute class.

Declared In

FMIceLinkSdpIceCandidateAttribute.h

– initWithFoundation:priority:connectionAddress:port:candidateType:relatedAddress:relatedPort:protocol:componentId:

Initializes a new instance of the FMIceLinkSdpIceCandidateAttribute class.
- (instancetype)initWithFoundation:(NSString *)foundation priority:(long long)priority connectionAddress:(NSString *)connectionAddress port:(int)port candidateType:(NSString *)candidateType relatedAddress:(NSString *)relatedAddress relatedPort:(int)relatedPort protocol:(NSString *)protocol componentId:(int)componentId

Parameters

foundation

The candidate’s foundation.
priority

The priority of the candidate.
connectionAddress

The IP address of the candidate.
port

The port of the candidate.
candidateType

The type of the candidate. See FMIceLinkSdpIceCandidateAttribute#candidateType for possible values.
relatedAddress

The IP address related to the candidate.
relatedPort

The port related to the candidate.
protocol

The protocol.
componentId

The ID of the component for which this is a candidate.

Discussion

Initializes a new instance of the FMIceLinkSdpIceCandidateAttribute class.

Declared In

FMIceLinkSdpIceCandidateAttribute.h

– port

Gets the port of the candidate.
- (int)port

Discussion

Gets the port of the candidate.

Declared In

FMIceLinkSdpIceCandidateAttribute.h

– priority

Gets the priority of the candidate.
- (long long)priority

Discussion

Gets the priority of the candidate.

Declared In

FMIceLinkSdpIceCandidateAttribute.h

– protocol

Gets the protocol of this candidate.
- (NSString *)protocol

Discussion

Gets the protocol of this candidate.

Declared In

FMIceLinkSdpIceCandidateAttribute.h

– relatedAddress

Gets the IP address related to the candidate.
- (NSString *)relatedAddress

Discussion

Gets the IP address related to the candidate.

Declared In

FMIceLinkSdpIceCandidateAttribute.h

– relatedPort

Gets the [port](#//api/name/port) related to the candidate.
- (int)relatedPort

Discussion

Gets the [port](#//api/name/port) related to the candidate.

Declared In

FMIceLinkSdpIceCandidateAttribute.h

– setCandidateType:

Sets the type of the candidate. See FMIceLinkSdpIceCandidateAttribute#[candidateType](#//api/name/candidateType) for possible values.
- (void)setCandidateType:(NSString *)value

Discussion

Sets the type of the candidate. See FMIceLinkSdpIceCandidateAttribute#[candidateType](#//api/name/candidateType) for possible values.

Declared In

FMIceLinkSdpIceCandidateAttribute.h

– setComponentId:

Sets the ID of the component for which this is a candidate.
- (void)setComponentId:(int)value

Discussion

Sets the ID of the component for which this is a candidate.

Declared In

FMIceLinkSdpIceCandidateAttribute.h

– setConnectionAddress:

Sets the IP address of the candidate.
- (void)setConnectionAddress:(NSString *)value

Discussion

Sets the IP address of the candidate.

Declared In

FMIceLinkSdpIceCandidateAttribute.h

– setFoundation:

Sets the candidate's [foundation](#//api/name/foundation).
- (void)setFoundation:(NSString *)value

Discussion

Sets the candidate's [foundation](#//api/name/foundation).

Declared In

FMIceLinkSdpIceCandidateAttribute.h

– setPort:

Sets the [port](#//api/name/port) of the candidate.
- (void)setPort:(int)value

Discussion

Sets the [port](#//api/name/port) of the candidate.

Declared In

FMIceLinkSdpIceCandidateAttribute.h

– setPriority:

Sets the [priority](#//api/name/priority) of the candidate.
- (void)setPriority:(long long)value

Discussion

Sets the [priority](#//api/name/priority) of the candidate.

Declared In

FMIceLinkSdpIceCandidateAttribute.h

– setProtocol:

Sets the [protocol](#//api/name/protocol) of this candidate.
- (void)setProtocol:(NSString *)value

Discussion

Sets the [protocol](#//api/name/protocol) of this candidate.

Declared In

FMIceLinkSdpIceCandidateAttribute.h

– setRelatedAddress:

Sets the IP address related to the candidate.
- (void)setRelatedAddress:(NSString *)value

Discussion

Sets the IP address related to the candidate.

Declared In

FMIceLinkSdpIceCandidateAttribute.h

– setRelatedPort:

Sets the [port](#//api/name/port) related to the candidate.
- (void)setRelatedPort:(int)value

Discussion

Sets the [port](#//api/name/port) related to the candidate.

Declared In

FMIceLinkSdpIceCandidateAttribute.h