/ fm / liveswitch / TransportStats

Class: TransportStats

fm.liveswitch.TransportStats

Transport stats.

Hierarchy

• BaseStats

  ↳ TransportStats

Table of contents

Constructors

• constructor

Methods

• deserializeProperties
• fmliveswitchTransportStatsInit
• getActiveCandidatePair
• getBytesReceived
• getBytesSent
• getCandidatePair
• getCandidatePairs
• getId
• getIsHost
• getIsReflexive
• getIsRelayed
• getLocalCandidate
• getLocalCandidates
• getLocalCertificate
• getRemoteCandidate
• getRemoteCandidates
• getRemoteCertificate
• getRtcpTransport
• getTimestamp
• getTypeString
• serializeProperties
• setActiveCandidatePair
• setBytesReceived
• setBytesSent
• setCandidatePairs
• setLocalCandidates
• setLocalCertificate
• setRemoteCandidates
• setRemoteCertificate
• setRtcpTransport
• toJson
• fromJson
• toJson

Constructors

constructor

+ new TransportStats(): TransportStats

Returns: TransportStats

Inherited from: BaseStats

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:36

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

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:88

---

fmliveswitchTransportStatsInit

▸ PrivatefmliveswitchTransportStatsInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:32

---

getActiveCandidatePair

▸ getActiveCandidatePair(): CandidatePairStats

Gets the active candidate pair's stats.

Returns: CandidatePairStats

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:131

---

getBytesReceived

▸ getBytesReceived(): number

Gets the number of bytes received.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:143

---

getBytesSent

▸ getBytesSent(): number

Gets the number of bytes sent.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:155

---

getCandidatePair

▸ getCandidatePair(candidatePairId: string): CandidatePairStats

Gets a candidate pair by its identifier.

Parameters:

Name	Type	Description
candidatePairId	string	The candidate pair identifier.

Returns: CandidatePairStats

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:168

---

getCandidatePairs

▸ getCandidatePairs(): CandidatePairStats[]

Gets the candidate pairs' stats.

Returns: CandidatePairStats[]

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:185

---

getId

▸ getId(): string

Gets the identifier of the object generating these stats.

Returns: string

Inherited from: BaseStats

Defined in: Generated/TypeScript/fm.liveswitch/BaseStats.ts:57

---

getIsHost

▸ getIsHost(): boolean

Gets whether the active candidate pair has a host candidate.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:197

---

getIsReflexive

▸ getIsReflexive(): boolean

Gets whether the active candidate pair has a reflexive candidate.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:215

---

getIsRelayed

▸ getIsRelayed(): boolean

Gets whether the active candidate pair has a relayed candidate.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:233

---

getLocalCandidate

▸ getLocalCandidate(candidateId: string): CandidateStats

Gets a local candidate by its identifier.

Parameters:

Name	Type	Description
candidateId	string	The candidate identifier.

Returns: CandidateStats

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:252

---

getLocalCandidates

▸ getLocalCandidates(): CandidateStats[]

Gets the local candidates' stats.

Returns: CandidateStats[]

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:269

---

getLocalCertificate

▸ getLocalCertificate(): CertificateStats

Gets the local certificate's stats.

Returns: CertificateStats

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:281

---

getRemoteCandidate

▸ getRemoteCandidate(candidateId: string): CandidateStats

Gets a remote candidate by its identifier.

Parameters:

Name	Type	Description
candidateId	string	The candidate identifier.

Returns: CandidateStats

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:294

---

getRemoteCandidates

▸ getRemoteCandidates(): CandidateStats[]

Gets the remote candidates' stats.

Returns: CandidateStats[]

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:311

---

getRemoteCertificate

▸ getRemoteCertificate(): CertificateStats

Gets the remote certificate's stats.

Returns: CertificateStats

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:323

---

getRtcpTransport

▸ getRtcpTransport(): TransportStats

Gets the RTCP transport's stats.

Returns: TransportStats

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:335

---

getTimestamp

▸ getTimestamp(): DateTime

Gets the timestamp when these stats were generated.

Returns: DateTime

Inherited from: BaseStats

Defined in: Generated/TypeScript/fm.liveswitch/BaseStats.ts:70

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: BaseStats

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:10

---

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

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:348

---

setActiveCandidatePair

▸ setActiveCandidatePair(value: CandidatePairStats): void

Sets the active candidate pair's stats.

Parameters:

Name	Type
value	CandidatePairStats

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:383

---

setBytesReceived

▸ setBytesReceived(value: number): void

Sets the number of bytes received.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:395

---

setBytesSent

▸ setBytesSent(value: number): void

Sets the number of bytes sent.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:408

---

setCandidatePairs

▸ setCandidatePairs(value: CandidatePairStats[]): void

Sets the candidate pairs' stats.

Parameters:

Name	Type
value	CandidatePairStats[]

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:421

---

setLocalCandidates

▸ setLocalCandidates(value: CandidateStats[]): void

Sets the local candidates' stats.

Parameters:

Name	Type
value	CandidateStats[]

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:433

---

setLocalCertificate

▸ setLocalCertificate(value: CertificateStats): void

Sets the local certificate's stats.

Parameters:

Name	Type
value	CertificateStats

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:445

---

setRemoteCandidates

▸ setRemoteCandidates(value: CandidateStats[]): void

Sets the remote candidates' stats.

Parameters:

Name	Type
value	CandidateStats[]

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:457

---

setRemoteCertificate

▸ setRemoteCertificate(value: CertificateStats): void

Sets the remote certificate's stats.

Parameters:

Name	Type
value	CertificateStats

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:469

---

setRtcpTransport

▸ setRtcpTransport(value: TransportStats): void

Sets the RTCP transport's stats.

Parameters:

Name	Type
value	TransportStats

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:481

---

toJson

▸ toJson(): string

Serializes this to JSON.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:493

---

fromJson

▸ StaticfromJson(transportJson: string): TransportStats

Derializes transport stats from JSON.

Parameters:

Name	Type	Description
transportJson	string	The transport's stats JSON.

Returns: TransportStats

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:55

---

toJson

▸ StatictoJson(transport: TransportStats): string

Serializes transport stats to JSON.

Parameters:

Name	Type	Description
transport	TransportStats	The transport's stats.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/TransportStats.ts:72