github.com/pion/webrtc/v3@v3.2.24/examples/stats/README.md (about)

     1  # stats
     2  stats demonstrates how to use the [webrtc-stats](https://www.w3.org/TR/webrtc-stats/) implementation provided by Pion WebRTC.
     3  
     4  This API gives you access to the statistical information about a PeerConnection. This can help you understand what is happening
     5  during a session and why.
     6  
     7  ## Instructions
     8  ### Download stats
     9  ```
    10  export GO111MODULE=on
    11  go get github.com/pion/webrtc/v3/examples/stats
    12  ```
    13  
    14  ### Open stats example page
    15  [jsfiddle.net](https://jsfiddle.net/s179hacu/) you should see your Webcam, two text-areas and two buttons: `Copy browser SDP to clipboard`, `Start Session`.
    16  
    17  ### Run stats, with your browsers SessionDescription as stdin
    18  In the jsfiddle the top textarea is your browser's Session Description. Press `Copy browser SDP to clipboard` or copy the base64 string manually.
    19  We will use this value in the next step.
    20  
    21  #### Linux/macOS
    22  Run `echo $BROWSER_SDP | stats`
    23  #### Windows
    24  1. Paste the SessionDescription into a file.
    25  1. Run `stats < my_file`
    26  
    27  ### Input stats' SessionDescription into your browser
    28  Copy the text that `stats` just emitted and copy into second text area
    29  
    30  ### Hit 'Start Session' in jsfiddle
    31  The `stats` program will now print the InboundRTPStreamStats for each incoming stream. You will see the following in
    32  your console. The exact fields will change as we add more values.
    33  
    34  ```
    35  Stats for: video/VP8
    36  InboundRTPStreamStats:
    37          PacketsReceived: 1255
    38          PacketsLost: 0
    39          Jitter: 588.9559641717999
    40          LastPacketReceivedTimestamp: 2023-04-26 13:16:16.63591134 -0400 EDT m=+18.317378921
    41          HeaderBytesReceived: 25100
    42          BytesReceived: 1361125
    43          FIRCount: 0
    44          PLICount: 0
    45          NACKCount: 0
    46  ```
    47  
    48  Congrats, you have used Pion WebRTC! Now start building something cool