Class: Statistics

Guacamole.Display.Statistics(templateopt)

new Statistics(templateopt)

A set of Guacamole display performance statistics, describing the speed at which the remote desktop, Guacamole server, and Guacamole client are rendering frames.
Parameters:
Name Type Attributes Default Description
template Guacamole.Display.Statistics | Object <optional>
{} The object whose properties should be copied within the new Guacamole.Display.Statistics.
Source:

Members

(nullable) clientFps :number

The rate at which the Guacamole client is consuming frames generated by the Guacamole server, in frames per second. If the Guacamole server is correctly adjusting for variance in client/browser processing power, this rate should closely match the server rate, regardless of any latency on the network between the server and client. If this value is unknown, such as if the there are insufficient frame statistics recorded to calculate this value, this will be null.
Type:
  • number
Source:

(nullable) desktopFps :number

The framerate of the remote desktop currently being viewed within the relevant Gucamole.Display, independent of Guacamole, in frames per second. This represents the speed at which the remote desktop is producing frame data for the Guacamole server to consume. If this value is unknown, such as if the remote desktop server does not actually define frame boundaries, this will be null.
Type:
  • number
Source:

dropRate

The rate at which the Guacamole server is dropping or combining frames received from the remote desktop server to compensate for variance in client/browser processing power, in frames per second. This value may also be non-zero if the server is compensating for variances in its own processing power, or relative slowness in image compression vs. the rate that inbound frames are received. If this value is unknown, such as if the remote desktop server does not actually define frame boundaries, this will be null.
Source:

(nullable) processingLag :number

The amount of time that the Guacamole client is taking to render individual frames, in milliseconds, if known. If this value is unknown, such as if the there are insufficient frame statistics recorded to calculate this value, this will be null.
Type:
  • number
Source:

(nullable) serverFps :number

The rate at which the Guacamole server is generating frames for the Guacamole client to consume, in frames per second. If the Guacamole server is correctly adjusting for variance in client/browser processing power, this rate should closely match the client rate, and should remain independent of any network latency. If this value is unknown, such as if the there are insufficient frame statistics recorded to calculate this value, this will be null.
Type:
  • number
Source: