/ fm / liveswitch / RemoteReceiverStats
Class: RemoteReceiverStats
fm.liveswitch.RemoteReceiverStats
Remote receiver stats.
Implements
Table of contents
Constructors
Methods
- deserializeProperties
- fmliveswitchRemoteReceiverStatsInit
- getCumulativeNumberOfPacketsLost
- getDelaySinceLastSenderReport
- getExtendedHighestSequenceNumberReceived
- getFractionLost
- getInterarrivalJitter
- getLastSenderReportTimestamp
- getPercentLost
- getSynchronizationSource
- getTypeString
- isEquivalent
- serializeProperties
- toJson
- fromJson
- fromJsonArray
- toJson
- toJsonArray
Constructors
constructor
+ new RemoteReceiverStats(): RemoteReceiverStats
Returns: RemoteReceiverStats
Defined in: Generated/TypeScript/fm.liveswitch/RemoteReceiverStats.ts:39
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
Defined in: Generated/TypeScript/fm.liveswitch/RemoteReceiverStats.ts:121
fmliveswitchRemoteReceiverStatsInit
▸ PrivatefmliveswitchRemoteReceiverStatsInit(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/RemoteReceiverStats.ts:29
getCumulativeNumberOfPacketsLost
▸ getCumulativeNumberOfPacketsLost(): number
Gets the cumulative number of packets lost.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/RemoteReceiverStats.ts:160
getDelaySinceLastSenderReport
▸ getDelaySinceLastSenderReport(): number
Gets the delay since last sender report.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/RemoteReceiverStats.ts:172
getExtendedHighestSequenceNumberReceived
▸ getExtendedHighestSequenceNumberReceived(): number
Gets the extended highest sequence number received.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/RemoteReceiverStats.ts:184
getFractionLost
▸ getFractionLost(): number
Gets the fraction lost according to RFC 1889. The value has a range of 0 (no packet loss) to 255 (all packets lost).
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/RemoteReceiverStats.ts:197
getInterarrivalJitter
▸ getInterarrivalJitter(): number
Gets the interarrival jitter.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/RemoteReceiverStats.ts:209
getLastSenderReportTimestamp
▸ getLastSenderReportTimestamp(): number
Gets the last sender report timestamp.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/RemoteReceiverStats.ts:221
getPercentLost
▸ getPercentLost(): number
Gets the percentage of lost packets. The value has a range of 0.0 (no packet loss) to 1.0 (all packets lost).
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/RemoteReceiverStats.ts:234
getSynchronizationSource
▸ getSynchronizationSource(): number
Gets the synchronization source.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/RemoteReceiverStats.ts:246
getTypeString
▸ getTypeString(): string
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/RemoteReceiverStats.ts:9
isEquivalent
▸ isEquivalent(instance: RemoteReceiverStats): boolean
Checks if a remote receiver is equivalent to this one.
Parameters:
| Name | Type | Description |
|---|---|---|
instance |
RemoteReceiverStats | The remote receiver. |
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/RemoteReceiverStats.ts:259
serializeProperties
▸ ProtectedserializeProperties(jsonObject: Hash<string, string>): void
Serializes the properties.
Parameters:
| Name | Type | Description |
|---|---|---|
jsonObject |
Hash<string, string> | The JSON object. |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/RemoteReceiverStats.ts:272
toJson
▸ toJson(): string
Serializes this to JSON.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/RemoteReceiverStats.ts:362
fromJson
▸ StaticfromJson(remoteReceiverJson: string): RemoteReceiverStats
Derializes remote receiver stats from JSON.
Parameters:
| Name | Type | Description |
|---|---|---|
remoteReceiverJson |
string | The remote receiver's stats JSON. |
Returns: RemoteReceiverStats
Defined in: Generated/TypeScript/fm.liveswitch/RemoteReceiverStats.ts:58
fromJsonArray
▸ StaticfromJsonArray(remoteReceiversJson: string): RemoteReceiverStats[]
Derializes a remote receiver stats array from JSON.
Parameters:
| Name | Type | Description |
|---|---|---|
remoteReceiversJson |
string | The remote receivers' stats JSON. |
Returns: RemoteReceiverStats[]
Defined in: Generated/TypeScript/fm.liveswitch/RemoteReceiverStats.ts:75
toJson
▸ StatictoJson(remoteReceiver: RemoteReceiverStats): string
Serializes remote receiver stats to JSON.
Parameters:
| Name | Type | Description |
|---|---|---|
remoteReceiver |
RemoteReceiverStats | The remote receiver's stats. |
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/RemoteReceiverStats.ts:92
toJsonArray
▸ StatictoJsonArray(remoteReceivers: RemoteReceiverStats[]): string
Serializes a remote receiver stats array to JSON.
Parameters:
| Name | Type | Description |
|---|---|---|
remoteReceivers |
RemoteReceiverStats[] | The remote receivers' stats. |
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/RemoteReceiverStats.ts:107