fm.liveswitch.sdp.ice.CandidateAttribute Class Reference

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

Public Member Functions

 CandidateAttribute (String foundation, long priority, String connectionAddress, int port, String candidateType, int componentId)
 Initializes a new instance of the fm.liveswitch.sdp.ice.CandidateAttribute class. More...
 
 CandidateAttribute (String foundation, long priority, String connectionAddress, int port, String candidateType, String relatedAddress, int relatedPort, String protocol, int componentId)
 Initializes a new instance of the fm.liveswitch.sdp.ice.CandidateAttribute class. More...
 
String getCandidateType ()
 Gets the type of the candidate. More...
 
int getComponentId ()
 Gets the ID of the component for which this is a candidate. More...
 
String getConnectionAddress ()
 Gets the IP address of the candidate. More...
 
java.util.HashMap< String, String > getExtensions ()
 Gets the extensions. More...
 
String getFoundation ()
 Gets the candidate's foundation. More...
 
int getPort ()
 Gets the port of the candidate. More...
 
long getPriority ()
 Gets the priority of the candidate. More...
 
String getProtocol ()
 Gets the protocol of this candidate. More...
 
String getRelatedAddress ()
 Gets the IP address related to the candidate. More...
 
int getRelatedPort ()
 Gets the port related to the candidate. More...
 
void setCandidateType (String value)
 Sets the type of the candidate. More...
 
void setComponentId (int value)
 Sets the ID of the component for which this is a candidate. More...
 
void setConnectionAddress (String value)
 Sets the IP address of the candidate. More...
 
void setFoundation (String value)
 Sets the candidate's foundation. More...
 
void setPort (int value)
 Sets the port of the candidate. More...
 
void setPriority (long value)
 Sets the priority of the candidate. More...
 
void setProtocol (String value)
 Sets the protocol of this candidate. More...
 
void setRelatedAddress (String value)
 Sets the IP address related to the candidate. More...
 
void setRelatedPort (int value)
 Sets the port related to the candidate. More...
 
- Public Member Functions inherited from fm.liveswitch.sdp.Attribute
fm.liveswitch.sdp.AttributeType getAttributeType ()
 Gets this Attribute's Type. More...
 
fm.liveswitch.sdp.AttributeCategory getMultiplexingCategory ()
 Gets the Multiplexing Category of this Attribute. More...
 
void setAttributeType (fm.liveswitch.sdp.AttributeType value)
 Sets this Attribute's Type. More...
 
String toString ()
 Converts this instance to a string. More...
 

Static Public Member Functions

static fm.liveswitch.sdp.ice.CandidateAttribute fromAttributeValue (String value)
 Initializes a new instance of the fm.liveswitch.sdp.ice.CandidateAttribute class. More...
 
- Static Public Member Functions inherited from fm.liveswitch.sdp.Attribute
static fm.liveswitch.sdp.Attribute createAttribute (String name, String value)
 Creates an attribute. More...
 
static String getTypeName (@SuppressWarnings("rawtypes") Class type)
 Gets the name of the attribute type. More...
 
static boolean isMediaLevel (@SuppressWarnings("rawtypes") Class type)
 Determines whether the type applies to media streams. More...
 
static boolean isSessionLevel (@SuppressWarnings("rawtypes") Class type)
 Determines whether the type applies to sessions. More...
 
static fm.liveswitch.sdp.Attribute parse (String s)
 Creates an fm.liveswitch.sdp.ConnectionData instance from a string. More...
 

Protected Member Functions

String getAttributeValue ()
 Gets the value of the attribute. More...
 
- Protected Member Functions inherited from fm.liveswitch.sdp.Attribute
 Attribute ()
 
void setMultiplexingCategory (fm.liveswitch.sdp.AttributeCategory value)
 Sets the Multiplexing Category of this Attribute. 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.

Constructor & Destructor Documentation

◆ CandidateAttribute() [1/2]

fm.liveswitch.sdp.ice.CandidateAttribute.CandidateAttribute ( String  foundation,
long  priority,
String  connectionAddress,
int  port,
String  candidateType,
int  componentId 
)

Initializes a new instance of the fm.liveswitch.sdp.ice.CandidateAttribute 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 fm.liveswitch.sdp.ice.CandidateAttribute#getCandidateType for possible values.
componentIdThe component identifier.

◆ CandidateAttribute() [2/2]

fm.liveswitch.sdp.ice.CandidateAttribute.CandidateAttribute ( String  foundation,
long  priority,
String  connectionAddress,
int  port,
String  candidateType,
String  relatedAddress,
int  relatedPort,
String  protocol,
int  componentId 
)

Initializes a new instance of the fm.liveswitch.sdp.ice.CandidateAttribute 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 fm.liveswitch.sdp.ice.CandidateAttribute#getCandidateType 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.

Member Function Documentation

◆ fromAttributeValue()

static fm.liveswitch.sdp.ice.CandidateAttribute fm.liveswitch.sdp.ice.CandidateAttribute.fromAttributeValue ( String  value)
static

Initializes a new instance of the fm.liveswitch.sdp.ice.CandidateAttribute class.

Parameters
valueThe attribute as a string.

◆ getAttributeValue()

String fm.liveswitch.sdp.ice.CandidateAttribute.getAttributeValue ( )
protected

Gets the value of the attribute.

Reimplemented from fm.liveswitch.sdp.Attribute.

◆ getCandidateType()

String fm.liveswitch.sdp.ice.CandidateAttribute.getCandidateType ( )

Gets the type of the candidate.

See fm.liveswitch.sdp.ice.CandidateAttribute#getCandidateType for possible values.

◆ getComponentId()

int fm.liveswitch.sdp.ice.CandidateAttribute.getComponentId ( )

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

◆ getConnectionAddress()

String fm.liveswitch.sdp.ice.CandidateAttribute.getConnectionAddress ( )

Gets the IP address of the candidate.

◆ getExtensions()

java.util.HashMap<String,String> fm.liveswitch.sdp.ice.CandidateAttribute.getExtensions ( )

Gets the extensions.

◆ getFoundation()

String fm.liveswitch.sdp.ice.CandidateAttribute.getFoundation ( )

Gets the candidate's foundation.

◆ getPort()

int fm.liveswitch.sdp.ice.CandidateAttribute.getPort ( )

Gets the port of the candidate.

◆ getPriority()

long fm.liveswitch.sdp.ice.CandidateAttribute.getPriority ( )

Gets the priority of the candidate.

◆ getProtocol()

String fm.liveswitch.sdp.ice.CandidateAttribute.getProtocol ( )

Gets the protocol of this candidate.

◆ getRelatedAddress()

String fm.liveswitch.sdp.ice.CandidateAttribute.getRelatedAddress ( )

Gets the IP address related to the candidate.

◆ getRelatedPort()

int fm.liveswitch.sdp.ice.CandidateAttribute.getRelatedPort ( )

Gets the port related to the candidate.

◆ setCandidateType()

void fm.liveswitch.sdp.ice.CandidateAttribute.setCandidateType ( String  value)

Sets the type of the candidate.

See fm.liveswitch.sdp.ice.CandidateAttribute#getCandidateType for possible values.

◆ setComponentId()

void fm.liveswitch.sdp.ice.CandidateAttribute.setComponentId ( int  value)

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

◆ setConnectionAddress()

void fm.liveswitch.sdp.ice.CandidateAttribute.setConnectionAddress ( String  value)

Sets the IP address of the candidate.

◆ setFoundation()

void fm.liveswitch.sdp.ice.CandidateAttribute.setFoundation ( String  value)

Sets the candidate's foundation.

◆ setPort()

void fm.liveswitch.sdp.ice.CandidateAttribute.setPort ( int  value)

Sets the port of the candidate.

◆ setPriority()

void fm.liveswitch.sdp.ice.CandidateAttribute.setPriority ( long  value)

Sets the priority of the candidate.

◆ setProtocol()

void fm.liveswitch.sdp.ice.CandidateAttribute.setProtocol ( String  value)

Sets the protocol of this candidate.

◆ setRelatedAddress()

void fm.liveswitch.sdp.ice.CandidateAttribute.setRelatedAddress ( String  value)

Sets the IP address related to the candidate.

◆ setRelatedPort()

void fm.liveswitch.sdp.ice.CandidateAttribute.setRelatedPort ( int  value)

Sets the port related to the candidate.