/ fm / liveswitch / CandidatePairStats

Class: CandidatePairStats

fm.liveswitch.CandidatePairStats

Candidate pair stats.

Hierarchy

• BaseStats

  ↳ CandidatePairStats

Implements

• IEquivalent<CandidatePairStats>

Table of contents

Constructors

• constructor

Methods

• deserializeProperties
• fmliveswitchCandidatePairStatsInit
• getBytesReceived
• getBytesSent
• getConsentRequestsReceived
• getConsentRequestsSent
• getConsentResponsesReceived
• getConsentResponsesSent
• getCurrentRoundTripTime
• getId
• getLocalCandidateId
• getNominated
• getPriority
• getRemoteCandidateId
• getRequestsReceived
• getRequestsSent
• getResponsesReceived
• getResponsesSent
• getState
• getTimestamp
• getTotalRoundTripTime
• getTransportId
• getTypeString
• isEquivalent
• serializeProperties
• toJson
• fromJson
• fromJsonArray
• toJson
• toJsonArray

Constructors

constructor

+ new CandidatePairStats(): CandidatePairStats

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

Returns: CandidatePairStats

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

---

fmliveswitchCandidatePairStatsInit

▸ PrivatefmliveswitchCandidatePairStatsInit(): void

Returns: void

---

getBytesReceived

▸ getBytesReceived(): number

Gets the number of bytes received.

Returns: number

---

getBytesSent

▸ getBytesSent(): number

Gets the number of bytes sent.

Returns: number

---

getConsentRequestsReceived

▸ getConsentRequestsReceived(): number

Gets the number of consent requests received.

Returns: number

---

getConsentRequestsSent

▸ getConsentRequestsSent(): number

Gets the number of consent requests sent.

Returns: number

---

getConsentResponsesReceived

▸ getConsentResponsesReceived(): number

Gets the number of consent responses received.

Returns: number

---

getConsentResponsesSent

▸ getConsentResponsesSent(): number

Gets the number of consent responses sent.

Returns: number

---

getCurrentRoundTripTime

▸ getCurrentRoundTripTime(): number

Gets the current round trip time in milliseconds.

Returns: number

---

getId

▸ getId(): string

Gets the identifier of the object generating these stats.

Returns: string

Inherited from: BaseStats

---

getLocalCandidateId

▸ getLocalCandidateId(): string

Gets the local candidate identifier.

Returns: string

---

getNominated

▸ getNominated(): boolean

Gets whether the candidate pair is nominated.

Returns: boolean

---

getPriority

▸ getPriority(): number

Gets the priority.

Returns: number

---

getRemoteCandidateId

▸ getRemoteCandidateId(): string

Gets the remote candidate identifier.

Returns: string

---

getRequestsReceived

▸ getRequestsReceived(): number

Gets the number of requests received.

Returns: number

---

getRequestsSent

▸ getRequestsSent(): number

Gets the number of requests sent.

Returns: number

---

getResponsesReceived

▸ getResponsesReceived(): number

Gets the number of responses received.

Returns: number

---

getResponsesSent

▸ getResponsesSent(): number

Gets the number of responses sent.

Returns: number

---

getState

▸ getState(): CandidatePairState

Gets the state.

Returns: CandidatePairState

---

getTimestamp

▸ getTimestamp(): DateTime

Gets the timestamp when these stats were generated.

Returns: DateTime

Inherited from: BaseStats

---

getTotalRoundTripTime

▸ getTotalRoundTripTime(): number

Gets the total round trip time in milliseconds.

Returns: number

---

getTransportId

▸ getTransportId(): string

Gets the transport identifier.

Returns: string

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: BaseStats

---

isEquivalent

▸ isEquivalent(instance: CandidatePairStats): boolean

Checks if a candidate pair is equivalent to this one.

Parameters:

Name	Type	Description
instance	CandidatePairStats	The candidate pair.

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(candidatePairJson: string): CandidatePairStats

Derializes candidate pair stats from JSON.

Parameters:

Name	Type	Description
candidatePairJson	string	The candidate pair's stats JSON.

Returns: CandidatePairStats

---

fromJsonArray

▸ StaticfromJsonArray(candidatePairsJson: string): CandidatePairStats[]

Derializes an array of candidate pair stats from JSON.

Parameters:

Name	Type	Description
candidatePairsJson	string	The candidate pairs' stats JSON.

Returns: CandidatePairStats[]

---

toJson

▸ StatictoJson(candidatePair: CandidatePairStats): string

Serializes candidate pair stats to JSON.

Parameters:

Name	Type	Description
candidatePair	CandidatePairStats	The candidate pair's stats.

Returns: string

---

toJsonArray

▸ StatictoJsonArray(candidatePairs: CandidatePairStats[]): string

Serializes an array of candidate pair stats to JSON.

Parameters:

Name	Type	Description
candidatePairs	CandidatePairStats[]	The candidate pairs' stats.

Returns: string