/ fm / liveswitch / MediaStreamStats

Class: MediaStreamStats

fm.liveswitch.MediaStreamStats

Media stream stats.

Hierarchy

• StreamStats

  ↳ MediaStreamStats

Table of contents

Constructors

• constructor

Methods

• deserializeProperties
• fmliveswitchMediaStreamStatsInit
• getDirection
• getId
• getIsHost
• getIsReflexive
• getIsRelayed
• getMaxReceiveBitrate
• getMaxSendBitrate
• getReceiver
• getReceivers
• getSender
• getSenders
• getTimestamp
• getTransport
• getType
• getTypeString
• serializeProperties
• toJson
• fromJson
• fromJsonArray
• toJson
• toJsonArray

Constructors

constructor

+ new MediaStreamStats(): MediaStreamStats

Returns: MediaStreamStats

Inherited from: StreamStats

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStreamStats.ts:26

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

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStreamStats.ts:98

---

fmliveswitchMediaStreamStatsInit

▸ PrivatefmliveswitchMediaStreamStatsInit(): void

Returns: void

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

---

getDirection

▸ getDirection(): StreamDirection

Gets the direction.

Returns: StreamDirection

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStreamStats.ts:130

---

getId

▸ getId(): string

Gets the identifier of the object generating these stats.

Returns: string

Inherited from: StreamStats

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

---

getIsHost

▸ getIsHost(): boolean

Gets whether the transport's active candidate pair has a host candidate.

Returns: boolean

Inherited from: StreamStats

Defined in: fm/Generated/TypeScript/fm.liveswitch/StreamStats.ts:52

---

getIsReflexive

▸ getIsReflexive(): boolean

Gets whether the transport's active candidate pair has a reflexive candidate.

Returns: boolean

Inherited from: StreamStats

Defined in: fm/Generated/TypeScript/fm.liveswitch/StreamStats.ts:66

---

getIsRelayed

▸ getIsRelayed(): boolean

Gets whether the transport's active candidate pair has a relayed candidate.

Returns: boolean

Inherited from: StreamStats

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

---

getMaxReceiveBitrate

▸ getMaxReceiveBitrate(): number

Gets the max receive bitrate.

Returns: number

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStreamStats.ts:140

---

getMaxSendBitrate

▸ getMaxSendBitrate(): number

Gets the max send bitrate.

Returns: number

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStreamStats.ts:150

---

getReceiver

▸ getReceiver(): MediaReceiverStats

Gets the first receiver's stats.

Returns: MediaReceiverStats

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStreamStats.ts:160

---

getReceivers

▸ getReceivers(): MediaReceiverStats[]

Gets the receivers' stats.

Returns: MediaReceiverStats[]

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStreamStats.ts:174

---

getSender

▸ getSender(): MediaSenderStats

Gets the first sender's stats.

Returns: MediaSenderStats

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStreamStats.ts:184

---

getSenders

▸ getSenders(): MediaSenderStats[]

Gets the senders' stats.

Returns: MediaSenderStats[]

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStreamStats.ts:198

---

getTimestamp

▸ getTimestamp(): DateTime

Gets the timestamp when these stats were generated.

Returns: DateTime

Inherited from: StreamStats

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

---

getTransport

▸ getTransport(): TransportStats

Gets the transport's stats.

Returns: TransportStats

Inherited from: StreamStats

Defined in: fm/Generated/TypeScript/fm.liveswitch/StreamStats.ts:94

---

getType

▸ getType(): StreamType

Gets the type.

Returns: StreamType

Inherited from: StreamStats

Defined in: fm/Generated/TypeScript/fm.liveswitch/StreamStats.ts:104

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: StreamStats

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStreamStats.ts:8

---

serializeProperties

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

Serializes the properties.

Parameters:

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

Returns: void

Overrides: StreamStats

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStreamStats.ts:209

---

toJson

▸ toJson(): string

Serializes this to JSON.

Returns: string

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStreamStats.ts:270

---

fromJson

▸ StaticfromJson(mediaStreamJson: string): MediaStreamStats

Derializes media stream stats from JSON.

Parameters:

Name	Type	Description
mediaStreamJson	string	The media stream's stats JSON.

Returns: MediaStreamStats

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStreamStats.ts:43

---

fromJsonArray

▸ StaticfromJsonArray(mediaStreamsJson: string): MediaStreamStats[]

Derializes an array of media stream stats from JSON.

Parameters:

Name	Type	Description
mediaStreamsJson	string	The media streams' stats JSON.

Returns: MediaStreamStats[]

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStreamStats.ts:58

---

toJson

▸ StatictoJson(mediaStream: MediaStreamStats): string

Serializes media stream stats to JSON.

Parameters:

Name	Type	Description
mediaStream	MediaStreamStats	The media stream's stats.

Returns: string

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStreamStats.ts:73

---

toJsonArray

▸ StatictoJsonArray(mediaStreams: MediaStreamStats[]): string

Serializes an array of media stream stats to JSON.

Parameters:

Name	Type	Description
mediaStreams	MediaStreamStats[]	The media streams' stats.

Returns: string

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStreamStats.ts:86