/ fm / liveswitch / MediaStats

Class: MediaStats

fm.liveswitch.MediaStats

Media stats.

Hierarchy

• BaseStats

  ↳ MediaStats

Table of contents

Constructors

• constructor

Methods

• deserializeProperties
• getId
• getTimestamp
• getTrack
• getTracks
• getTypeString
• serializeProperties
• toJson
• fromJson
• toJson

Constructors

constructor

+ new MediaStats(): MediaStats

Returns: MediaStats

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

---

getId

▸ getId(): string

Gets the identifier of the object generating these stats.

Returns: string

Inherited from: BaseStats

---

getTimestamp

▸ getTimestamp(): DateTime

Gets the timestamp when these stats were generated.

Returns: DateTime

Inherited from: BaseStats

---

getTrack

▸ getTrack(): MediaTrackStats

Gets the first track's stats.

Returns: MediaTrackStats

▸ getTrack(trackId: string): MediaTrackStats

Gets a track by its identifier.

Parameters:

Name	Type	Description
trackId	string	The track identifier.

Returns: MediaTrackStats

---

getTracks

▸ getTracks(): MediaTrackStats[]

Gets the tracks' stats.

Returns: MediaTrackStats[]

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: BaseStats

---

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(mediaJson: string): MediaStats

Derializes media stats from JSON.

Parameters:

Name	Type	Description
mediaJson	string	The media's stats JSON.

Returns: MediaStats

---

toJson

▸ StatictoJson(media: MediaStats): string

Serializes media stats to JSON.

Parameters:

Name	Type	Description
media	MediaStats	The media's stats.

Returns: string