FMLiveSwitchCandidate Class Reference

A candidate. More...

Instance Methods

(bool) - dispatched
 Gets a value indicating whether this candidate has been already been dispatched as a part of a session description. More...
 
(instancetype) - init
 
(FMLiveSwitchProtocolType) - relayProtocol
 Gets the relay protocol, the protocol used by this candidate to communicate with the relay (TURN) server. More...
 
(FMLiveSwitchSdpIceCandidateAttribute *) - sdpCandidateAttribute
 Gets the SDP candidate attribute. More...
 
(int) - sdpMediaIndex
 Gets the media index. More...
 
(void) - setDispatched:
 Sets a value indicating whether this candidate has been already been dispatched as a part of a session description. More...
 
(void) - setRelayProtocol:
 Sets the relay protocol, the protocol used by this candidate to communicate with the relay (TURN) server. More...
 
(void) - setSdpCandidateAttribute:
 Sets the SDP candidate attribute. More...
 
(void) - setSdpMediaIndex:
 Sets the media index. More...
 
(void) - setTurnTransportProtocol:
 Sets the relay protocol, the protocol used by this candidate to communicate with the relay (TURN) server. More...
 
(NSString *) - toJson
 Serializes this instance to JSON. More...
 
(FMLiveSwitchProtocolType) - turnTransportProtocol
 Gets the relay protocol, the protocol used by this candidate to communicate with the relay (TURN) server. More...
 

Class Methods

(FMLiveSwitchCandidate *) + candidate
 
(FMLiveSwitchCandidate *) + fromJsonWithCandidateJson:
 Deserializes an instance from JSON. More...
 
(NSString *) + toJsonWithCandidate:
 Serializes an instance to JSON. More...
 

Detailed Description

A candidate.

Method Documentation

◆ candidate

+ (FMLiveSwitchCandidate*) candidate

◆ dispatched

- (bool) dispatched

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

◆ fromJsonWithCandidateJson:

+ (FMLiveSwitchCandidate*) fromJsonWithCandidateJson: (NSString *)  candidateJson

Deserializes an instance from JSON.

Parameters
candidateJsonThe JSON to deserialize.
Returns
The deserialized candidate.

◆ init

- (instancetype) init

◆ relayProtocol

- (FMLiveSwitchProtocolType) relayProtocol

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

◆ sdpCandidateAttribute

- (FMLiveSwitchSdpIceCandidateAttribute*) sdpCandidateAttribute

Gets the SDP candidate attribute.

◆ sdpMediaIndex

- (int) sdpMediaIndex

Gets the media index.

◆ setDispatched:

- (void) setDispatched: (bool)  value

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

◆ setRelayProtocol:

- (void) setRelayProtocol: (FMLiveSwitchProtocolType)  value

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

◆ setSdpCandidateAttribute:

- (void) setSdpCandidateAttribute: (FMLiveSwitchSdpIceCandidateAttribute *)  value

Sets the SDP candidate attribute.

◆ setSdpMediaIndex:

- (void) setSdpMediaIndex: (int)  value

Sets the media index.

◆ setTurnTransportProtocol:

- (void) setTurnTransportProtocol: (FMLiveSwitchProtocolType)  value

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

Deprecated:
Use RelayProtocol instead.

◆ toJson

- (NSString*) toJson

Serializes this instance to JSON.

◆ toJsonWithCandidate:

+ (NSString*) toJsonWithCandidate: (FMLiveSwitchCandidate *)  candidate

Serializes an instance to JSON.

Parameters
candidateThe candidate to serialize.
Returns
The serialized JSON.

◆ turnTransportProtocol

- (FMLiveSwitchProtocolType) turnTransportProtocol

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

Deprecated:
Use RelayProtocol instead.