/ fm / liveswitch / CandidateStats

Class: CandidateStats

fm.liveswitch.CandidateStats

Candidate stats.

Hierarchy

• BaseStats

  ↳ CandidateStats

Implements

• IEquivalent<CandidateStats>

Table of contents

Constructors

• constructor

Methods

• deserializeProperties
• fmliveswitchCandidateStatsInit
• getIPAddress
• getId
• getIsHost
• getIsReflexive
• getIsRelayed
• getPort
• getPriority
• getProtocol
• getRelatedIPAddress
• getRelatedPort
• getRelayProtocol
• getTimestamp
• getTurnProtocol
• getType
• getTypeString
• isEquivalent
• serializeProperties
• toJson
• fromJson
• fromJsonArray
• toJson
• toJsonArray

Constructors

constructor

+ new CandidateStats(): CandidateStats

Initializes a new instance of the [[fm.liveswitch.candidateStats]] class.

Returns: CandidateStats

Inherited from: BaseStats

Methods

deserializeProperties

▸ ProtecteddeserializeProperties(key: string, valueJson: string): void

Deserializes the properties.

Parameters:

Name	Type	Description
key	string	The key.
valueJson	string	The value in JSON format.

Returns: void

Overrides: BaseStats

---

fmliveswitchCandidateStatsInit

▸ PrivatefmliveswitchCandidateStatsInit(): void

Returns: void

---

getIPAddress

▸ getIPAddress(): string

Gets the IP address.

Returns: string

---

getId

▸ getId(): string

Gets the identifier of the object generating these stats.

Returns: string

Inherited from: BaseStats

---

getIsHost

▸ getIsHost(): boolean

Gets whether the candidate is host/local.

Returns: boolean

---

getIsReflexive

▸ getIsReflexive(): boolean

Gets whether the candidate is reflexive.

Returns: boolean

---

getIsRelayed

▸ getIsRelayed(): boolean

Gets whether the candidate is relayed.

Returns: boolean

---

getPort

▸ getPort(): number

Gets the port.

Returns: number

---

getPriority

▸ getPriority(): number

Gets the priority.

Returns: number

---

getProtocol

▸ getProtocol(): ProtocolType

Gets the protocol.

Returns: ProtocolType

---

getRelatedIPAddress

▸ getRelatedIPAddress(): string

Gets the related IP address.

Returns: string

---

getRelatedPort

▸ getRelatedPort(): number

Gets the related port.

Returns: number

---

getRelayProtocol

▸ getRelayProtocol(): ProtocolType

Gets the relay protocol.

Returns: ProtocolType

---

getTimestamp

▸ getTimestamp(): DateTime

Gets the timestamp when these stats were generated.

Returns: DateTime

Inherited from: BaseStats

---

getTurnProtocol

▸ getTurnProtocol(): ProtocolType

Gets the relay protocol. Obsolete. Alias for [[fm.liveswitch.candidateStats.relayProtocol]].

Returns: ProtocolType

---

getType

▸ getType(): CandidateType

Gets the type.

Returns: CandidateType

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: BaseStats

---

isEquivalent

▸ isEquivalent(instance: CandidateStats): boolean

Checks if a candidate is equivalent to this one.

Parameters:

Name	Type	Description
instance	CandidateStats	The candidate.

Returns: boolean

---

serializeProperties

▸ ProtectedserializeProperties(jsonObject: Hash<string, string>): void

Serializes the properties.

Parameters:

Name	Type	Description
jsonObject	Hash<string, string>	The JSON object.

Returns: void

Overrides: BaseStats

---

toJson

▸ toJson(): string

Serializes this to JSON.

Returns: string

---

fromJson

▸ StaticfromJson(candidateJson: string): CandidateStats

Derializes candidate stats from JSON.

Parameters:

Name	Type	Description
candidateJson	string	The candidate's stats JSON.

Returns: CandidateStats

---

fromJsonArray

▸ StaticfromJsonArray(candidatesJson: string): CandidateStats[]

Derializes an array of candidate stats from JSON.

Parameters:

Name	Type	Description
candidatesJson	string	The candidates' stats JSON.

Returns: CandidateStats[]

---

toJson

▸ StatictoJson(candidate: CandidateStats): string

Serializes candidate stats to JSON.

Parameters:

Name	Type	Description
candidate	CandidateStats	The candidate's stats.

Returns: string

---

toJsonArray

▸ StatictoJsonArray(candidates: CandidateStats[]): string

Serializes an array of candidate stats to JSON.

Parameters:

Name	Type	Description
candidates	CandidateStats[]	The candidates' stats.

Returns: string