FMLiveSwitchSdpIceCandidateAttribute Class Reference

The candidate attribute is a media-level attribute only. More...

Instance Methods

(NSString *) - candidateType
 Gets the type of the candidate. More...
 
(int) - componentId
 Gets the ID of the component for which this is a candidate. More...
 
(NSString *) - connectionAddress
 Gets the IP address of the candidate. More...
 
(NSMutableDictionary< NSString *, NSString * > *) - extensions
 Gets the extensions. More...
 
(NSString *) - foundation
 Gets the candidate's foundation. More...
 
(NSString *) - getAttributeValue
 Gets the value of the attribute. More...
 
(instancetype) - initWithFoundation:priority:connectionAddress:port:candidateType:componentId:
 Initializes a new instance of the FMLiveSwitchSdpIceCandidateAttribute class. More...
 
(instancetype) - initWithFoundation:priority:connectionAddress:port:candidateType:relatedAddress:relatedPort:protocol:componentId:
 Initializes a new instance of the FMLiveSwitchSdpIceCandidateAttribute class. More...
 
(int) - port
 Gets the port of the candidate. More...
 
(long long) - priority
 Gets the priority of the candidate. More...
 
(NSString *) - protocol
 Gets the protocol of this candidate. More...
 
(NSString *) - relatedAddress
 Gets the IP address related to the candidate. More...
 
(int) - relatedPort
 Gets the port related to the candidate. More...
 
(void) - setCandidateType:
 Sets the type of the candidate. More...
 
(void) - setComponentId:
 Sets the ID of the component for which this is a candidate. More...
 
(void) - setConnectionAddress:
 Sets the IP address of the candidate. More...
 
(void) - setFoundation:
 Sets the candidate's foundation. More...
 
(void) - setPort:
 Sets the port of the candidate. More...
 
(void) - setPriority:
 Sets the priority of the candidate. More...
 
(void) - setProtocol:
 Sets the protocol of this candidate. More...
 
(void) - setRelatedAddress:
 Sets the IP address related to the candidate. More...
 
(void) - setRelatedPort:
 Sets the port related to the candidate. More...
 
- Instance Methods inherited from FMLiveSwitchSdpAttribute
(FMLiveSwitchSdpAttributeType) - attributeType
 Gets this Attribute's Type. More...
 
(NSString *) - description
 Converts this instance to a string. More...
 
(instancetype) - init
 
(FMLiveSwitchSdpAttributeCategory) - multiplexingCategory
 Gets the Multiplexing Category of this Attribute. More...
 
(void) - setAttributeType:
 Sets this Attribute's Type. More...
 
(void) - setMultiplexingCategory:
 Sets the Multiplexing Category of this Attribute. More...
 

Class Methods

(FMLiveSwitchSdpIceCandidateAttribute *) + candidateAttributeWithFoundation:priority:connectionAddress:port:candidateType:componentId:
 Initializes a new instance of the FMLiveSwitchSdpIceCandidateAttribute class. More...
 
(FMLiveSwitchSdpIceCandidateAttribute *) + candidateAttributeWithFoundation:priority:connectionAddress:port:candidateType:relatedAddress:relatedPort:protocol:componentId:
 Initializes a new instance of the FMLiveSwitchSdpIceCandidateAttribute class. More...
 
(FMLiveSwitchSdpIceCandidateAttribute *) + fromAttributeValue:
 Initializes a new instance of the FMLiveSwitchSdpIceCandidateAttribute class. More...
 
- Class Methods inherited from FMLiveSwitchSdpAttribute
(FMLiveSwitchSdpAttribute *) + attribute
 
(FMLiveSwitchSdpAttribute *) + createAttributeWithName:value:
 Creates an attribute. More...
 
(NSString *) + getTypeNameWithType:
 Gets the name of the attribute type. More...
 
(bool) + isMediaLevelWithType:
 Determines whether the type applies to media streams. More...
 
(bool) + isSessionLevelWithType:
 Determines whether the type applies to sessions. More...
 
(FMLiveSwitchSdpAttribute *) + parseWithS:
 Creates an FMLiveSwitchSdpConnectionData instance from a string. More...
 

Detailed Description

The candidate attribute is a media-level attribute only.

It contains a transport address for a candidate that can be used for connectivity checks.

Method Documentation

◆ candidateAttributeWithFoundation:priority:connectionAddress:port:candidateType:componentId:

+ (FMLiveSwitchSdpIceCandidateAttribute*) candidateAttributeWithFoundation: (NSString *)  foundation
priority: (long long)  priority
connectionAddress: (NSString *)  connectionAddress
port: (int)  port
candidateType: (NSString *)  candidateType
componentId: (int)  componentId 

Initializes a new instance of the FMLiveSwitchSdpIceCandidateAttribute class.

Parameters
foundationThe candidate's foundation.
priorityThe priority of the candidate.
connectionAddressThe IP address of the candidate.
portThe port of the candidate.
candidateTypeThe type of the candidate. See candidateType for possible values.
componentIdThe component identifier.

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

+ (FMLiveSwitchSdpIceCandidateAttribute*) 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 

Initializes a new instance of the FMLiveSwitchSdpIceCandidateAttribute class.

Parameters
foundationThe candidate's foundation.
priorityThe priority of the candidate.
connectionAddressThe IP address of the candidate.
portThe port of the candidate.
candidateTypeThe type of the candidate. See candidateType for possible values.
relatedAddressThe IP address related to the candidate.
relatedPortThe port related to the candidate.
protocolThe protocol.
componentIdThe ID of the component for which this is a candidate.

◆ candidateType

- (NSString*) candidateType

Gets the type of the candidate.

See candidateType for possible values.

◆ componentId

- (int) componentId

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

◆ connectionAddress

- (NSString*) connectionAddress

Gets the IP address of the candidate.

◆ extensions

- (NSMutableDictionary<NSString*,NSString*>*) extensions

Gets the extensions.

◆ foundation

- (NSString*) foundation

Gets the candidate's foundation.

◆ fromAttributeValue:

+ (FMLiveSwitchSdpIceCandidateAttribute*) fromAttributeValue: (NSString *)  value

Initializes a new instance of the FMLiveSwitchSdpIceCandidateAttribute class.

Parameters
valueThe attribute as a string.

◆ getAttributeValue

- (NSString*) getAttributeValue

Gets the value of the attribute.

Implements FMLiveSwitchSdpAttribute.

◆ initWithFoundation:priority:connectionAddress:port:candidateType:componentId:

- (instancetype) initWithFoundation: (NSString *)  foundation
priority: (long long)  priority
connectionAddress: (NSString *)  connectionAddress
port: (int)  port
candidateType: (NSString *)  candidateType
componentId: (int)  componentId 

Initializes a new instance of the FMLiveSwitchSdpIceCandidateAttribute class.

Parameters
foundationThe candidate's foundation.
priorityThe priority of the candidate.
connectionAddressThe IP address of the candidate.
portThe port of the candidate.
candidateTypeThe type of the candidate. See candidateType for possible values.
componentIdThe component identifier.

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

- (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 

Initializes a new instance of the FMLiveSwitchSdpIceCandidateAttribute class.

Parameters
foundationThe candidate's foundation.
priorityThe priority of the candidate.
connectionAddressThe IP address of the candidate.
portThe port of the candidate.
candidateTypeThe type of the candidate. See candidateType for possible values.
relatedAddressThe IP address related to the candidate.
relatedPortThe port related to the candidate.
protocolThe protocol.
componentIdThe ID of the component for which this is a candidate.

◆ port

- (int) port

Gets the port of the candidate.

◆ priority

- (long long) priority

Gets the priority of the candidate.

◆ protocol

- (NSString*) protocol

Gets the protocol of this candidate.

◆ relatedAddress

- (NSString*) relatedAddress

Gets the IP address related to the candidate.

◆ relatedPort

- (int) relatedPort

Gets the port related to the candidate.

◆ setCandidateType:

- (void) setCandidateType: (NSString *)  value

Sets the type of the candidate.

See candidateType for possible values.

◆ setComponentId:

- (void) setComponentId: (int)  value

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

◆ setConnectionAddress:

- (void) setConnectionAddress: (NSString *)  value

Sets the IP address of the candidate.

◆ setFoundation:

- (void) setFoundation: (NSString *)  value

Sets the candidate's foundation.

◆ setPort:

- (void) setPort: (int)  value

Sets the port of the candidate.

◆ setPriority:

- (void) setPriority: (long long)  value

Sets the priority of the candidate.

◆ setProtocol:

- (void) setProtocol: (NSString *)  value

Sets the protocol of this candidate.

◆ setRelatedAddress:

- (void) setRelatedAddress: (NSString *)  value

Sets the IP address related to the candidate.

◆ setRelatedPort:

- (void) setRelatedPort: (int)  value

Sets the port related to the candidate.