github.com/pion/webrtc/v4@v4.0.1/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  go install github.com/pion/webrtc/v4/examples/stats@latest
    11  ```
    12  
    13  ### Open stats example page
    14  [jsfiddle.net](https://jsfiddle.net/s179hacu/) you should see your Webcam, two text-areas and two buttons: `Copy browser SDP to clipboard`, `Start Session`.
    15  
    16  ### Run stats, with your browsers SessionDescription as stdin
    17  In the jsfiddle the top textarea is your browser's Session Description. Press `Copy browser SDP to clipboard` or copy the base64 string manually.
    18  We will use this value in the next step.
    19  
    20  #### Linux/macOS
    21  Run `echo $BROWSER_SDP | stats`
    22  #### Windows
    23  1. Paste the SessionDescription into a file.
    24  1. Run `stats < my_file`
    25  
    26  ### Input stats' SessionDescription into your browser
    27  Copy the text that `stats` just emitted and copy into second text area
    28  
    29  ### Hit 'Start Session' in jsfiddle
    30  The `stats` program will now print the InboundRTPStreamStats for each incoming stream and Remote IP+Ports.
    31  You will see the following in your console. The exact fields will change as we add more values.
    32  
    33  ```
    34  Stats for: video/VP8
    35  InboundRTPStreamStats:
    36          PacketsReceived: 1255
    37          PacketsLost: 0
    38          Jitter: 588.9559641717999
    39          LastPacketReceivedTimestamp: 2023-04-26 13:16:16.63591134 -0400 EDT m=+18.317378921
    40          HeaderBytesReceived: 25100
    41          BytesReceived: 1361125
    42          FIRCount: 0
    43          PLICount: 0
    44          NACKCount: 0
    45  
    46  
    47  remote-candidate IP(192.168.1.93) Port(59239)
    48  remote-candidate IP(172.18.176.1) Port(59241)
    49  remote-candidate IP(fd4d:d991:c340:6749:8c53:ee52:ae8c:14d4) Port(59238)
    50  ```
    51  
    52  Congrats, you have used Pion WebRTC! Now start building something cool