fm.liveswitch.Candidate Class Reference

A candidate. More...

Public Member Functions

 Candidate ()
 
boolean getDispatched ()
 Gets a value indicating whether this candidate has been already been dispatched as a part of a session description. More...
 
fm.liveswitch.ProtocolType getRelayProtocol ()
 Gets the relay protocol, the protocol used by this candidate to communicate with the relay (TURN) server. More...
 
fm.liveswitch.sdp.ice.CandidateAttribute getSdpCandidateAttribute ()
 Gets the SDP candidate attribute. More...
 
int getSdpMediaIndex ()
 Gets the media index. More...
 
fm.liveswitch.ProtocolType getTurnTransportProtocol ()
 Gets the relay protocol, the protocol used by this candidate to communicate with the relay (TURN) server. More...
 
void setDispatched (boolean value)
 Sets a value indicating whether this candidate has been already been dispatched as a part of a session description. More...
 
void setRelayProtocol (fm.liveswitch.ProtocolType value)
 Sets the relay protocol, the protocol used by this candidate to communicate with the relay (TURN) server. More...
 
void setSdpCandidateAttribute (fm.liveswitch.sdp.ice.CandidateAttribute value)
 Sets the SDP candidate attribute. More...
 
void setSdpMediaIndex (int value)
 Sets the media index. More...
 
void setTurnTransportProtocol (fm.liveswitch.ProtocolType value)
 Sets the relay protocol, the protocol used by this candidate to communicate with the relay (TURN) server. More...
 
String toJson ()
 Serializes this instance to JSON. More...
 

Static Public Member Functions

static fm.liveswitch.Candidate fromJson (String candidateJson)
 Deserializes an instance from JSON. More...
 
static String toJson (final fm.liveswitch.Candidate candidate)
 Serializes an instance to JSON. More...
 

Detailed Description

A candidate.

Constructor & Destructor Documentation

◆ Candidate()

fm.liveswitch.Candidate.Candidate ( )

Member Function Documentation

◆ fromJson()

static fm.liveswitch.Candidate fm.liveswitch.Candidate.fromJson ( String  candidateJson)
static

Deserializes an instance from JSON.

Parameters
candidateJsonThe JSON to deserialize.
Returns
The deserialized candidate.

◆ getDispatched()

boolean fm.liveswitch.Candidate.getDispatched ( )

Gets a value indicating whether this candidate has been already been dispatched as a part of a session description.

◆ getRelayProtocol()

fm.liveswitch.ProtocolType fm.liveswitch.Candidate.getRelayProtocol ( )

Gets the relay protocol, the protocol used by this candidate to communicate with the relay (TURN) server.

◆ getSdpCandidateAttribute()

fm.liveswitch.sdp.ice.CandidateAttribute fm.liveswitch.Candidate.getSdpCandidateAttribute ( )

Gets the SDP candidate attribute.

◆ getSdpMediaIndex()

int fm.liveswitch.Candidate.getSdpMediaIndex ( )

Gets the media index.

◆ getTurnTransportProtocol()

fm.liveswitch.ProtocolType fm.liveswitch.Candidate.getTurnTransportProtocol ( )

Gets the relay protocol, the protocol used by this candidate to communicate with the relay (TURN) server.

Obsolete. Alias for fm.liveswitch.Candidate#getRelayProtocol.

◆ setDispatched()

void fm.liveswitch.Candidate.setDispatched ( boolean  value)

Sets a value indicating whether this candidate has been already been dispatched as a part of a session description.

◆ setRelayProtocol()

void fm.liveswitch.Candidate.setRelayProtocol ( fm.liveswitch.ProtocolType  value)

Sets the relay protocol, the protocol used by this candidate to communicate with the relay (TURN) server.

◆ setSdpCandidateAttribute()

void fm.liveswitch.Candidate.setSdpCandidateAttribute ( fm.liveswitch.sdp.ice.CandidateAttribute  value)

Sets the SDP candidate attribute.

◆ setSdpMediaIndex()

void fm.liveswitch.Candidate.setSdpMediaIndex ( int  value)

Sets the media index.

◆ setTurnTransportProtocol()

void fm.liveswitch.Candidate.setTurnTransportProtocol ( fm.liveswitch.ProtocolType  value)

Sets the relay protocol, the protocol used by this candidate to communicate with the relay (TURN) server.

Obsolete. Alias for fm.liveswitch.Candidate#getRelayProtocol.

◆ toJson() [1/2]

String fm.liveswitch.Candidate.toJson ( )

Serializes this instance to JSON.

◆ toJson() [2/2]

static String fm.liveswitch.Candidate.toJson ( final fm.liveswitch.Candidate  candidate)
static

Serializes an instance to JSON.

Parameters
candidateThe candidate to serialize.
Returns
The serialized JSON.