/ fm / liveswitch / MediaReceiverStats

Class: MediaReceiverStats

fm.liveswitch.MediaReceiverStats

Media receiver stats.

Hierarchy

• MediaComponentStats

  ↳ MediaReceiverStats

Implements

• IEquivalent<MediaReceiverStats>

Table of contents

Constructors

• constructor

Methods

• deserializeProperties
• fmliveswitchMediaReceiverStatsInit
• getBytesReceived
• getCodec
• getFirCount
• getId
• getJitter
• getLrrCount
• getMediaQuality
• getNackCount
• getNetworkQuality
• getNetworkScore
• getPacketsDiscarded
• getPacketsDuplicated
• getPacketsLost
• getPacketsReceived
• getPacketsRepaired
• getPliCount
• getRepairedRtpStreamId
• getRoundTripTime
• getRtpStreamId
• getSink
• getSliCount
• getSynchronizationSource
• getTimestamp
• getTrack
• getTypeString
• isEquivalent
• serializeProperties
• setCodec
• setFirCount
• setLrrCount
• setNackCount
• setPliCount
• setRepairedRtpStreamId
• setRtpStreamId
• setSliCount
• setSynchronizationSource
• setTrack
• toJson
• fromJson
• fromJsonArray
• toJson
• toJsonArray

Constructors

constructor

+ new MediaReceiverStats(): MediaReceiverStats

Returns: MediaReceiverStats

Inherited from: MediaComponentStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaReceiverStats.ts:42

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: MediaComponentStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaReceiverStats.ts:124

---

fmliveswitchMediaReceiverStatsInit

▸ PrivatefmliveswitchMediaReceiverStatsInit(): void

Returns: void

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

---

getBytesReceived

▸ getBytesReceived(): number

Gets the number of bytes received.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/MediaReceiverStats.ts:167

---

getCodec

▸ getCodec(): CodecStats

Gets the codec stats.

Returns: CodecStats

Inherited from: MediaComponentStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentStats.ts:108

---

getFirCount

▸ getFirCount(): number

Gets the FIR count.

Returns: number

Inherited from: MediaComponentStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentStats.ts:120

---

getId

▸ getId(): string

Gets the identifier of the object generating these stats.

Returns: string

Inherited from: MediaComponentStats

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

---

getJitter

▸ getJitter(): number

Gets the jitter in milliseconds.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/MediaReceiverStats.ts:179

---

getLrrCount

▸ getLrrCount(): number

Gets the LRR count.

Returns: number

Inherited from: MediaComponentStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentStats.ts:132

---

getMediaQuality

▸ getMediaQuality(audio: boolean): number

Gets the receiver's estimated media quality.
The value ranges from 0.0 to 1.0, where 0.0 is the lowest quality and 1.0 is the highest quality.

Parameters:

Name	Type	Description
audio	boolean	Whether these are audio stats.

Returns: number

Overrides: MediaComponentStats

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

---

getNackCount

▸ getNackCount(): number

Gets the NACK count.

Returns: number

Inherited from: MediaComponentStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentStats.ts:163

---

getNetworkQuality

▸ getNetworkQuality(): number

Gets the receiver's estimated network quality.
The value ranges from 0.0 to 1.0, where 0.0 is the lowest quality and 1.0 is the highest quality.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/MediaReceiverStats.ts:250

---

getNetworkScore

▸ getNetworkScore(): number

Gets the receiver's estimated network score.
The value ranges from 1.0 to 5.0, where 1.0 is the lowest score and 5.0 is the highest score.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/MediaReceiverStats.ts:264

---

getPacketsDiscarded

▸ getPacketsDiscarded(): number

Gets the number of packets discarded.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/MediaReceiverStats.ts:334

---

getPacketsDuplicated

▸ getPacketsDuplicated(): number

Gets the number of packets duplicated.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/MediaReceiverStats.ts:346

---

getPacketsLost

▸ getPacketsLost(): number

Gets the number of packets lost.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/MediaReceiverStats.ts:358

---

getPacketsReceived

▸ getPacketsReceived(): number

Gets the number of packets received.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/MediaReceiverStats.ts:370

---

getPacketsRepaired

▸ getPacketsRepaired(): number

Gets the number of packets repaired.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/MediaReceiverStats.ts:382

---

getPliCount

▸ getPliCount(): number

Gets the PLI count.

Returns: number

Inherited from: MediaComponentStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentStats.ts:175

---

getRepairedRtpStreamId

▸ getRepairedRtpStreamId(): string

Gets the repaired RTP stream identifier.

Returns: string

Inherited from: MediaComponentStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentStats.ts:187

---

getRoundTripTime

▸ getRoundTripTime(): number

Gets the round trip time in milliseconds.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/MediaReceiverStats.ts:394

---

getRtpStreamId

▸ getRtpStreamId(): string

Gets the RTP stream identifier.

Returns: string

Inherited from: MediaComponentStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentStats.ts:199

---

getSink

▸ getSink(): MediaSinkStats

Gets the sink stats.

Returns: MediaSinkStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaReceiverStats.ts:406

---

getSliCount

▸ getSliCount(): number

Gets the SLI count.

Returns: number

Inherited from: MediaComponentStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentStats.ts:211

---

getSynchronizationSource

▸ getSynchronizationSource(): number

Gets the synchronization source.

Returns: number

Inherited from: MediaComponentStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentStats.ts:223

---

getTimestamp

▸ getTimestamp(): DateTime

Gets the timestamp when these stats were generated.

Returns: DateTime

Inherited from: MediaComponentStats

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

---

getTrack

▸ getTrack(): MediaTrackStats

Gets the track's stats.

Returns: MediaTrackStats

Inherited from: MediaComponentStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentStats.ts:235

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: MediaComponentStats

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

---

isEquivalent

▸ isEquivalent(instance: MediaReceiverStats): boolean

Checks if a media receiver is equivalent to this one.

Parameters:

Name	Type	Description
instance	MediaReceiverStats	The media receiver.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/MediaReceiverStats.ts:419

---

serializeProperties

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

Serializes the properties.

Parameters:

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

Returns: void

Overrides: MediaComponentStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaReceiverStats.ts:432

---

setCodec

▸ setCodec(value: CodecStats): void

Sets the codec stats.

Parameters:

Name	Type
value	CodecStats

Returns: void

Inherited from: MediaComponentStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentStats.ts:274

---

setFirCount

▸ setFirCount(value: number): void

Sets the FIR count.

Parameters:

Name	Type
value	number

Returns: void

Inherited from: MediaComponentStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentStats.ts:286

---

setLrrCount

▸ setLrrCount(value: number): void

Sets the LRR count.

Parameters:

Name	Type
value	number

Returns: void

Inherited from: MediaComponentStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentStats.ts:299

---

setNackCount

▸ setNackCount(value: number): void

Sets the NACK count.

Parameters:

Name	Type
value	number

Returns: void

Inherited from: MediaComponentStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentStats.ts:312

---

setPliCount

▸ setPliCount(value: number): void

Sets the PLI count.

Parameters:

Name	Type
value	number

Returns: void

Inherited from: MediaComponentStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentStats.ts:325

---

setRepairedRtpStreamId

▸ setRepairedRtpStreamId(value: string): void

Sets the repaired RTP stream identifier.

Parameters:

Name	Type
value	string

Returns: void

Inherited from: MediaComponentStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentStats.ts:338

---

setRtpStreamId

▸ setRtpStreamId(value: string): void

Sets the RTP stream identifier.

Parameters:

Name	Type
value	string

Returns: void

Inherited from: MediaComponentStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentStats.ts:350

---

setSliCount

▸ setSliCount(value: number): void

Sets the SLI count.

Parameters:

Name	Type
value	number

Returns: void

Inherited from: MediaComponentStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentStats.ts:362

---

setSynchronizationSource

▸ setSynchronizationSource(value: number): void

Sets the synchronization source.

Parameters:

Name	Type
value	number

Returns: void

Inherited from: MediaComponentStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentStats.ts:375

---

setTrack

▸ setTrack(value: MediaTrackStats): void

Sets the track's stats.

Parameters:

Name	Type
value	MediaTrackStats

Returns: void

Inherited from: MediaComponentStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentStats.ts:388

---

toJson

▸ toJson(): string

Serializes this to JSON.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/MediaReceiverStats.ts:535

---

fromJson

▸ StaticfromJson(mediaReceiverJson: string): MediaReceiverStats

Derializes media receiver stats from JSON.

Parameters:

Name	Type	Description
mediaReceiverJson	string	The media receiver's stats JSON.

Returns: MediaReceiverStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaReceiverStats.ts:61

---

fromJsonArray

▸ StaticfromJsonArray(mediaReceiversJson: string): MediaReceiverStats[]

Derializes media receiver stats array from JSON.

Parameters:

Name	Type	Description
mediaReceiversJson	string	The media receivers' stats JSON.

Returns: MediaReceiverStats[]

Defined in: Generated/TypeScript/fm.liveswitch/MediaReceiverStats.ts:78

---

toJson

▸ StatictoJson(mediaReceiver: MediaReceiverStats): string

Serializes media receiver stats to JSON.

Parameters:

Name	Type	Description
mediaReceiver	MediaReceiverStats	The media receiver's stats.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/MediaReceiverStats.ts:95

---

toJsonArray

▸ StatictoJsonArray(mediaReceivers: MediaReceiverStats[]): string

Serializes media receiver stats array to JSON.

Parameters:

Name	Type	Description
mediaReceivers	MediaReceiverStats[]	The media receivers' stats.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/MediaReceiverStats.ts:110