/ fm / liveswitch / CodecStats

Class: CodecStats

fm.liveswitch.CodecStats

Codec stats.

Hierarchy

• BaseStats

  ↳ CodecStats

Implements

• IEquivalent<CodecStats>

Table of contents

Constructors

• constructor

Methods

• deserializeProperties
• fmliveswitchCodecStatsInit
• getChannelCount
• getClockRate
• getCodecType
• getId
• getName
• getParameters
• getPayloadType
• getTimestamp
• getTypeString
• isEquivalent
• serializeProperties
• toJson
• fromJson
• toJson

Constructors

constructor

+ new CodecStats(): CodecStats

Returns: CodecStats

Inherited from: BaseStats

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

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

Defined in: Generated/TypeScript/fm.liveswitch/CodecStats.ts:83

---

fmliveswitchCodecStatsInit

▸ PrivatefmliveswitchCodecStatsInit(): void

Returns: void

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

---

getChannelCount

▸ getChannelCount(): number

Gets the channel count.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/CodecStats.ts:122

---

getClockRate

▸ getClockRate(): number

Gets the clock rate.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/CodecStats.ts:134

---

getCodecType

▸ getCodecType(): CodecType

Gets the codec type, "encode" or "decode", depending on whether this object represents a media format that the implementation is prepared to encode or decode.

Returns: CodecType

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

---

getId

▸ getId(): string

Gets the identifier of the object generating these stats.

Returns: string

Inherited from: BaseStats

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

---

getName

▸ getName(): string

Gets the name.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/CodecStats.ts:158

---

getParameters

▸ getParameters(): string

Gets the parameters.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/CodecStats.ts:170

---

getPayloadType

▸ getPayloadType(): number

Gets the payload type.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/CodecStats.ts:182

---

getTimestamp

▸ getTimestamp(): DateTime

Gets the timestamp when these stats were generated.

Returns: DateTime

Inherited from: BaseStats

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

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: BaseStats

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

---

isEquivalent

▸ isEquivalent(instance: CodecStats): boolean

Checks if a codec is equivalent to this one.

Parameters:

Name	Type	Description
instance	CodecStats	The codec.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/CodecStats.ts:195

---

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

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

---

toJson

▸ toJson(): string

Serializes this to JSON.

Returns: string

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

---

fromJson

▸ StaticfromJson(codecJson: string): CodecStats

Derializes codec stats from JSON.

Parameters:

Name	Type	Description
codecJson	string	The codec's stats JSON.

Returns: CodecStats

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

---

toJson

▸ StatictoJson(codec: CodecStats): string

Serializes codec stats to JSON.

Parameters:

Name	Type	Description
codec	CodecStats	The codec's stats.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/CodecStats.ts:67