Struct kittycad_modeling_cmds::websocket::ClientMetrics

pub struct ClientMetrics {
    pub rtc_frames_dropped: u32,
    pub rtc_frames_decoded: u64,
    pub rtc_frames_received: u64,
    pub rtc_frames_per_second: u8,
    pub rtc_freeze_count: u32,
    pub rtc_jitter_sec: f32,
    pub rtc_keyframes_decoded: u32,
    pub rtc_total_freezes_duration_sec: f32,
}

ClientMetrics contains information regarding the state of the peer.

Fields

rtc_frames_dropped: u32

Counter of the number of WebRTC frames the client has dropped during this session.

rtc_frames_decoded: u64

Counter of the number of WebRTC frames that the client has decoded during this session.

rtc_frames_received: u64

Counter of the number of WebRTC frames that the client has received during this session.

rtc_frames_per_second: u8

Current number of frames being rendered per second. A good target is 60 frames per second, but it can fluctuate depending on network conditions.

rtc_freeze_count: u32

Number of times the WebRTC playback has frozen. This is usually due to network conditions.

rtc_jitter_sec: f32

Amount of “jitter” in the WebRTC session. Network latency is the time it takes a packet to traverse the network. The amount that the latency varies is the jitter. Video latency is the time it takes to render a frame sent by the server (including network latency). A low jitter means the video latency can be reduced without impacting smooth playback. High jitter means clients will increase video latency to ensure smooth playback.

rtc_keyframes_decoded: u32

Number of “key frames” decoded in the underlying h.264 stream. A key frame is an expensive (bandwidth-wise) “full image” of the video frame. Data after the keyframe become – effectively – “diff” operations on that key frame. The Engine will only send a keyframe if required, which is an indication that some of the “diffs” have been lost, usually an indication of poor network conditions. We like this metric to understand times when the connection has had to recover.

rtc_total_freezes_duration_sec: f32

Number of seconds of frozen video the user has been subjected to.

Trait Implementations

impl Clone for ClientMetrics

fn clone(&self) -> ClientMetrics

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClientMetrics

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ClientMetrics

fn default() -> ClientMetrics

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClientMetrics

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ClientMetrics

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for ClientMetrics

fn eq(&self, other: &ClientMetrics) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ClientMetrics

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ClientMetrics