/ fm / liveswitch / MediaTrackReport

Class: MediaTrackReport

fm.liveswitch.MediaTrackReport

Media track report.

Hierarchy

• Report

  ↳ MediaTrackReport

Table of contents

Constructors

• constructor

Methods

• deserializeProperties
• getBitrate
• getFrameHeight
• getFrameRate
• getFrameWidth
• getFramesCorrupted
• getFramesDecoded
• getFramesDropped
• getFramesEncoded
• getFramesReceived
• getFramesSent
• getMaxBitrate
• getMinBitrate
• getTypeString
• serializeProperties
• setBitrate
• setFrameHeight
• setFrameRate
• setFrameWidth
• setFramesCorrupted
• setFramesDecoded
• setFramesDropped
• setFramesEncoded
• setFramesReceived
• setFramesSent
• setMaxBitrate
• setMinBitrate
• toJson
• fromJson
• fromJsonArray
• processArray
• processBoolean
• processBooleanArray
• processDouble
• processFloat
• processFloatArray
• processInteger
• processIntegerArray
• processLong
• processLongArray
• processObject
• processShort
• processShortArray
• processString
• toJson
• toJsonArray

Constructors

constructor

+ new MediaTrackReport(): MediaTrackReport

Initializes a new instance of the [[fm.liveswitch.mediaTrackReport]] class.

Returns: MediaTrackReport

Inherited from: Report

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

+ new MediaTrackReport(stats: MediaTrackStats, lastStats: MediaTrackStats): MediaTrackReport

Parameters:

Name	Type
stats	MediaTrackStats
lastStats	MediaTrackStats

Returns: MediaTrackReport

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

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

Defined in: Generated/TypeScript/fm.liveswitch/MediaTrackReport.ts:146

---

getBitrate

▸ getBitrate(): number

Gets the bitrate.

Returns: number

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

---

getFrameHeight

▸ getFrameHeight(): number

Gets the frame height.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/MediaTrackReport.ts:210

---

getFrameRate

▸ getFrameRate(): number

Gets the frame rate.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/MediaTrackReport.ts:222

---

getFrameWidth

▸ getFrameWidth(): number

Gets the frame width.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/MediaTrackReport.ts:306

---

getFramesCorrupted

▸ getFramesCorrupted(): number

Gets the number of frames corrupted.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/MediaTrackReport.ts:234

---

getFramesDecoded

▸ getFramesDecoded(): number

Gets the number of frames decoded.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/MediaTrackReport.ts:246

---

getFramesDropped

▸ getFramesDropped(): number

Gets the number of frames dropped.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/MediaTrackReport.ts:258

---

getFramesEncoded

▸ getFramesEncoded(): number

Gets the number of frames encoded.

Returns: number

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

---

getFramesReceived

▸ getFramesReceived(): number

Gets the number of frames received.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/MediaTrackReport.ts:282

---

getFramesSent

▸ getFramesSent(): number

Gets the number of frames sent.

Returns: number

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

---

getMaxBitrate

▸ getMaxBitrate(): number

Gets the maximum bitrate.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/MediaTrackReport.ts:318

---

getMinBitrate

▸ getMinBitrate(): number

Gets the minimum bitrate.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/MediaTrackReport.ts:330

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Report

Defined in: Generated/TypeScript/fm.liveswitch/MediaTrackReport.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: Report

Defined in: Generated/TypeScript/fm.liveswitch/MediaTrackReport.ts:343

---

setBitrate

▸ setBitrate(value: number): void

Sets the bitrate.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaTrackReport.ts:391

---

setFrameHeight

▸ setFrameHeight(value: number): void

Sets the frame height.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaTrackReport.ts:403

---

setFrameRate

▸ setFrameRate(value: number): void

Sets the frame rate.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaTrackReport.ts:415

---

setFrameWidth

▸ setFrameWidth(value: number): void

Sets the frame width.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaTrackReport.ts:499

---

setFramesCorrupted

▸ setFramesCorrupted(value: number): void

Sets the number of frames corrupted.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaTrackReport.ts:427

---

setFramesDecoded

▸ setFramesDecoded(value: number): void

Sets the number of frames decoded.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaTrackReport.ts:439

---

setFramesDropped

▸ setFramesDropped(value: number): void

Sets the number of frames dropped.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaTrackReport.ts:451

---

setFramesEncoded

▸ setFramesEncoded(value: number): void

Sets the number of frames encoded.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaTrackReport.ts:463

---

setFramesReceived

▸ setFramesReceived(value: number): void

Sets the number of frames received.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaTrackReport.ts:475

---

setFramesSent

▸ setFramesSent(value: number): void

Sets the number of frames sent.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaTrackReport.ts:487

---

setMaxBitrate

▸ setMaxBitrate(value: number): void

Sets the maximum bitrate.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaTrackReport.ts:511

---

setMinBitrate

▸ setMinBitrate(value: number): void

Sets the minimum bitrate.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaTrackReport.ts:523

---

toJson

▸ toJson(): string

Serializes this instance to JSON.

Returns: string

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

---

fromJson

▸ StaticfromJson(instanceJson: string): MediaTrackReport

Deserializes an instance from JSON.

Parameters:

Name	Type	Description
instanceJson	string	The instance JSON.

Returns: MediaTrackReport

The deserialized instance.

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

---

fromJsonArray

▸ StaticfromJsonArray(arrayJson: string): MediaTrackReport[]

Derializes an array from JSON.

Parameters:

Name	Type	Description
arrayJson	string	The array JSON.

Returns: MediaTrackReport[]

The deserialized array.

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

---

processArray

▸ StaticprocessArray<T>(newValues: T[], oldValues: T[]): T[]

Processes an array for a report.

Type parameters:

Name	Type
T	IEquivalent<T, T>

Parameters:

Name	Type	Description
newValues	T[]	The new values.
oldValues	T[]	The old values.

Returns: T[]

The new values, if the new values are not equivalent to the old values; otherwise null.

Inherited from: Report

Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:31

---

processBoolean

▸ StaticprocessBoolean(newValue: boolean, oldValue: boolean): boolean

Processes a boolean for a report.

Parameters:

Name	Type	Description
newValue	boolean	The new value.
oldValue	boolean	The old value.

Returns: boolean

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Report

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

---

processBooleanArray

▸ StaticprocessBooleanArray(newValues: boolean[], oldValues: boolean[]): boolean[]

Processes a boolean array for a report.

Parameters:

Name	Type	Description
newValues	boolean[]	The new values.
oldValues	boolean[]	The old values.

Returns: boolean[]

The new values, if the new values do not equal the old values; otherwise null.

Inherited from: Report

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

---

processDouble

▸ StaticprocessDouble(newValue: number, oldValue: number): number

Processes a double for a report.

Parameters:

Name	Type	Description
newValue	number	The new value.
oldValue	number	The old value.

Returns: number

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Report

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

---

processFloat

▸ StaticprocessFloat(newValue: number, oldValue: number): number

Processes a float for a report.

Parameters:

Name	Type	Description
newValue	number	The new value.
oldValue	number	The old value.

Returns: number

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Report

Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:113

---

processFloatArray

▸ StaticprocessFloatArray(newValues: number[], oldValues: number[]): number[]

Processes a float array for a report.

Parameters:

Name	Type	Description
newValues	number[]	The new values.
oldValues	number[]	The old values.

Returns: number[]

The new values, if the new values do not equal the old values; otherwise null.

Inherited from: Report

Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:128

---

processInteger

▸ StaticprocessInteger(newValue: number, oldValue: number): number

Processes an integer for a report.

Parameters:

Name	Type	Description
newValue	number	The new value.
oldValue	number	The old value.

Returns: number

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Report

Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:154

---

processIntegerArray

▸ StaticprocessIntegerArray(newValues: number[], oldValues: number[]): number[]

Processes a integer array for a report.

Parameters:

Name	Type	Description
newValues	number[]	The new values.
oldValues	number[]	The old values.

Returns: number[]

The new values, if the new values do not equal the old values; otherwise null.

Inherited from: Report

Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:171

---

processLong

▸ StaticprocessLong(newValue: number, oldValue: number): number

Processes a long for a report.

Parameters:

Name	Type	Description
newValue	number	The new value.
oldValue	number	The old value.

Returns: number

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Report

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

---

processLongArray

▸ StaticprocessLongArray(newValues: number[], oldValues: number[]): number[]

Processes a long array for a report.

Parameters:

Name	Type	Description
newValues	number[]	The new values.
oldValues	number[]	The old values.

Returns: number[]

The new values, if the new values do not equal the old values; otherwise null.

Inherited from: Report

Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:214

---

processObject

▸ StaticprocessObject<T>(newValue: T, oldValue: T): T

Processes an array for a report.

Type parameters:

Name	Type
T	Object & IEquivalent<T, T>

Parameters:

Name	Type	Description
newValue	T	The new value.
oldValue	T	The old value.

Returns: T

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Report

Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:240

---

processShort

▸ StaticprocessShort(newValue: number, oldValue: number): number

Processes a short for a report.

Parameters:

Name	Type	Description
newValue	number	The new value.
oldValue	number	The old value.

Returns: number

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Report

Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:261

---

processShortArray

▸ StaticprocessShortArray(newValues: number[], oldValues: number[]): number[]

Processes a short array for a report.

Parameters:

Name	Type	Description
newValues	number[]	The new values.
oldValues	number[]	The old values.

Returns: number[]

The new values, if the new values do not equal the old values; otherwise null.

Inherited from: Report

Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:278

---

processString

▸ StaticprocessString(newValue: string, oldValue: string): string

Processes a string for a report.

Parameters:

Name	Type	Description
newValue	string	The new value.
oldValue	string	The old value.

Returns: string

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Report

Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:304

---

toJson

▸ StatictoJson(instance: MediaTrackReport): string

Serializes an instance to JSON.

Parameters:

Name	Type	Description
instance	MediaTrackReport	The instance.

Returns: string

The serialized instance JSON.

Defined in: Generated/TypeScript/fm.liveswitch/MediaTrackReport.ts:116

---

toJsonArray

▸ StatictoJsonArray(array: MediaTrackReport[]): string

Serializes an array to JSON.

Parameters:

Name	Type	Description
array	MediaTrackReport[]	The array.

Returns: string

The serialized array JSON.

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