/ fm / liveswitch / MediaSenderStats

Class: MediaSenderStats

fm.liveswitch.MediaSenderStats

Media sender stats.

Hierarchy

• MediaComponentStats

  ↳ MediaSenderStats

Implements

• IEquivalent<MediaSenderStats>

Table of contents

Constructors

• constructor

Methods

• deserializeProperties
• fmliveswitchMediaSenderStatsInit
• getBytesSent
• getCodec
• getFirCount
• getId
• getLrrCount
• getMediaQuality
• getNackCount
• getNetworkQuality
• getPacketsSent
• getPliCount
• getRepairedRtpStreamId
• getRoundTripTime
• getRtpStreamId
• getSliCount
• getSource
• getSynchronizationSource
• getTimestamp
• getTrack
• getTypeString
• isEquivalent
• serializeProperties
• setCodec
• setFirCount
• setLrrCount
• setNackCount
• setPliCount
• setRepairedRtpStreamId
• setRtpStreamId
• setSliCount
• setSynchronizationSource
• setTrack
• toJson
• fromJson
• fromJsonArray
• toJson
• toJsonArray

Constructors

constructor

+ new MediaSenderStats(): MediaSenderStats

Returns: MediaSenderStats

Inherited from: MediaComponentStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderStats.ts:27

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/MediaSenderStats.ts:109

---

fmliveswitchMediaSenderStatsInit

▸ PrivatefmliveswitchMediaSenderStatsInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderStats.ts:22

---

getBytesSent

▸ getBytesSent(): number

Gets the number of bytes sent.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderStats.ts:139

---

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

---

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 component'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

Inherited from: MediaComponentStats

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

---

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 sender'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/MediaSenderStats.ts:153

---

getPacketsSent

▸ getPacketsSent(): number

Gets the number of packets sent.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderStats.ts:196

---

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/MediaSenderStats.ts:208

---

getRtpStreamId

▸ getRtpStreamId(): string

Gets the RTP stream identifier.

Returns: string

Inherited from: MediaComponentStats

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

---

getSliCount

▸ getSliCount(): number

Gets the SLI count.

Returns: number

Inherited from: MediaComponentStats

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

---

getSource

▸ getSource(): MediaSourceStats

Gets the source stats.

Returns: MediaSourceStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderStats.ts:220

---

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/MediaSenderStats.ts:10

---

isEquivalent

▸ isEquivalent(instance: MediaSenderStats): boolean

Checks if a media sender is equivalent to this one.

Parameters:

Name	Type	Description
instance	MediaSenderStats	The media sender.

Returns: boolean

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

---

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/MediaSenderStats.ts:246

---

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/MediaSenderStats.ts:299

---

fromJson

▸ StaticfromJson(mediaSenderJson: string): MediaSenderStats

Derializes media sender stats from JSON.

Parameters:

Name	Type	Description
mediaSenderJson	string	The media sender's stats JSON.

Returns: MediaSenderStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderStats.ts:46

---

fromJsonArray

▸ StaticfromJsonArray(mediaSendersJson: string): MediaSenderStats[]

Derializes a media sender stats array from JSON.

Parameters:

Name	Type	Description
mediaSendersJson	string	The media senders' stats JSON.

Returns: MediaSenderStats[]

Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderStats.ts:63

---

toJson

▸ StatictoJson(mediaSender: MediaSenderStats): string

Serializes media sender stats to JSON.

Parameters:

Name	Type	Description
mediaSender	MediaSenderStats	The media sender's stats.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderStats.ts:80

---

toJsonArray

▸ StatictoJsonArray(mediaSenders: MediaSenderStats[]): string

Serializes a media sender stats array to JSON.

Parameters:

Name	Type	Description
mediaSenders	MediaSenderStats[]	The media senders' stats.

Returns: string

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