Skip to content

Commit

Permalink
add 9d6f2ed
Browse files Browse the repository at this point in the history
  • Loading branch information
topi314 committed Aug 15, 2023
1 parent 40eb68d commit f76366a
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions docs/api/websocket.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ Dispatched every x seconds (configurable in `application.yml`) with the current

#### Stats OP

A collection of stats sent every minute.
A collection of statistics sent every minute.

##### Stats Object

Expand Down Expand Up @@ -148,11 +148,13 @@ A collection of stats sent every minute.

##### Frame Stats

| Field | Type | Description |
|---------|------|----------------------------------------|
| sent | int | The amount of frames sent to Discord |
| nulled | int | The amount of frames that were nulled |
| deficit | int | The amount of frames that were deficit |
| Field | Type | Description |
|-----------|------|----------------------------------------------------------------------|
| sent | int | The amount of frames sent to Discord |
| nulled | int | The amount of frames that were nulled |
| deficit * | int | The difference between sent frames and the expected amount of frames |

\* The expected amount of frames is 3000 (1 every 20 ms) per player. If the `deficit` is negative, too many frames were sent, and if it's positive, not enough frames got sent.

<details>
<summary>Example Payload</summary>
Expand All @@ -175,9 +177,9 @@ A collection of stats sent every minute.
"lavalinkLoad": 0.5
},
"frameStats": {
"sent": 123456789,
"nulled": 123456789,
"deficit": 123456789
"sent": 6000,
"nulled": 10,
"deficit": -3010
}
}
```
Expand Down

0 comments on commit f76366a

Please sign in to comment.