/ fm / liveswitch / StreamStats
Class: StreamStats
fm.liveswitch.StreamStats
Stream stats.
Hierarchy
-
↳ StreamStats
Table of contents
Constructors
Methods
- deserializeProperties
- getId
- getIsHost
- getIsReflexive
- getIsRelayed
- getTimestamp
- getTransport
- getType
- getTypeString
- serializeProperties
Constructors
constructor
+ new StreamStats(): StreamStats
Returns: StreamStats
Inherited from: BaseStats
Defined in: Generated/TypeScript/fm.liveswitch/StreamStats.ts:16
Methods
deserializeProperties
▸ Protected
deserializeProperties(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/StreamStats.ts:36
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
getIsHost
▸ getIsHost(): boolean
Gets whether the transport's active candidate pair has a host candidate.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/StreamStats.ts:58
getIsReflexive
▸ getIsReflexive(): boolean
Gets whether the transport's active candidate pair has a reflexive candidate.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/StreamStats.ts:74
getIsRelayed
▸ getIsRelayed(): boolean
Gets whether the transport's active candidate pair has a relayed candidate.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/StreamStats.ts:90
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
getTransport
▸ getTransport(): TransportStats
Gets the transport's stats.
Returns: TransportStats
Defined in: Generated/TypeScript/fm.liveswitch/StreamStats.ts:106
getType
▸ getType(): StreamType
Gets the type.
Returns: StreamType
Defined in: Generated/TypeScript/fm.liveswitch/StreamStats.ts:118
getTypeString
▸ getTypeString(): string
Returns: string
Overrides: BaseStats
Defined in: Generated/TypeScript/fm.liveswitch/StreamStats.ts:10
serializeProperties
▸ Protected
serializeProperties(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/StreamStats.ts:131