webrtcbin: Update documentation of 'get-stats' action signal

Some stats fields are updated according to the current implementation.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/2005>
This commit is contained in:
Sangchul Lee 2022-03-22 00:30:28 +09:00 committed by GStreamer Marge Bot
parent c1a3f958e7
commit 952c1194f3

View file

@ -7783,25 +7783,29 @@ gst_webrtc_bin_class_init (GstWebRTCBinClass * klass)
* "ssrc" G_TYPE_STRING the rtp sequence src in use * "ssrc" G_TYPE_STRING the rtp sequence src in use
* "transport-id" G_TYPE_STRING identifier for the associated RTCTransportStats for this stream * "transport-id" G_TYPE_STRING identifier for the associated RTCTransportStats for this stream
* "codec-id" G_TYPE_STRING identifier for the associated RTCCodecStats for this stream * "codec-id" G_TYPE_STRING identifier for the associated RTCCodecStats for this stream
* "fir-count" G_TYPE_UINT FIR requests received by the sender (only for local statistics)
* "pli-count" G_TYPE_UINT PLI requests received by the sender (only for local statistics)
* "nack-count" G_TYPE_UINT NACK requests received by the sender (only for local statistics)
* *
* RTCReceivedStreamStats supported fields (https://w3c.github.io/webrtc-stats/#receivedrtpstats-dict*) * RTCReceivedStreamStats supported fields (https://w3c.github.io/webrtc-stats/#receivedrtpstats-dict*)
* *
* "packets-received" G_TYPE_UINT64 number of packets received (only for local inbound) * "packets-received" G_TYPE_UINT64 number of packets received (only for local inbound)
* "bytes-received" G_TYPE_UINT64 number of bytes received (only for local inbound) * "packets-lost" G_TYPE_UINT64 number of packets lost
* "packets-lost" G_TYPE_UINT number of packets lost * "packets-discarded" G_TYPE_UINT64 number of packets discarded
* "jitter" G_TYPE_DOUBLE packet jitter measured in secondss * "packets-repaired" G_TYPE_UINT64 number of packets repaired
* "jitter" G_TYPE_DOUBLE packet jitter measured in seconds
* *
* RTCInboundRTPStreamStats supported fields (https://w3c.github.io/webrtc-stats/#inboundrtpstats-dict*) * RTCInboundRTPStreamStats supported fields (https://w3c.github.io/webrtc-stats/#inboundrtpstats-dict*)
* *
* "remote-id" G_TYPE_STRING identifier for the associated RTCRemoteOutboundRTPStreamStats * "remote-id" G_TYPE_STRING identifier for the associated RTCRemoteOutboundRTPStreamStats
* "bytes-received" G_TYPE_UINT64 number of bytes received (only for local inbound)
* "packets-duplicated" G_TYPE_UINT64 number of packets duplicated
* "fir-count" G_TYPE_UINT FIR packets sent by the receiver
* "pli-count" G_TYPE_UINT PLI packets sent by the receiver
* "nack-count" G_TYPE_UINT NACK packets sent by the receiver
* *
* RTCRemoteInboundRTPStreamStats supported fields (https://w3c.github.io/webrtc-stats/#remoteinboundrtpstats-dict*) * RTCRemoteInboundRTPStreamStats supported fields (https://w3c.github.io/webrtc-stats/#remoteinboundrtpstats-dict*)
* *
* "local-id" G_TYPE_STRING identifier for the associated RTCOutboundRTPSTreamStats * "local-id" G_TYPE_STRING identifier for the associated RTCOutboundRTPSTreamStats
* "round-trip-time" G_TYPE_DOUBLE round trip time of packets measured in seconds * "round-trip-time" G_TYPE_DOUBLE round trip time of packets measured in seconds
* "fraction-lost" G_TYPE_DOUBLE fraction packet loss
* *
* RTCSentRTPStreamStats supported fields (https://w3c.github.io/webrtc-stats/#sentrtpstats-dict*) * RTCSentRTPStreamStats supported fields (https://w3c.github.io/webrtc-stats/#sentrtpstats-dict*)
* *
@ -7811,10 +7815,14 @@ gst_webrtc_bin_class_init (GstWebRTCBinClass * klass)
* RTCOutboundRTPStreamStats supported fields (https://w3c.github.io/webrtc-stats/#outboundrtpstats-dict*) * RTCOutboundRTPStreamStats supported fields (https://w3c.github.io/webrtc-stats/#outboundrtpstats-dict*)
* *
* "remote-id" G_TYPE_STRING identifier for the associated RTCRemoteInboundRTPSTreamStats * "remote-id" G_TYPE_STRING identifier for the associated RTCRemoteInboundRTPSTreamStats
* "fir-count" G_TYPE_UINT FIR packets received by the sender
* "pli-count" G_TYPE_UINT PLI packets received by the sender
* "nack-count" G_TYPE_UINT NACK packets received by the sender
* *
* RTCRemoteOutboundRTPStreamStats supported fields (https://w3c.github.io/webrtc-stats/#remoteoutboundrtpstats-dict*) * RTCRemoteOutboundRTPStreamStats supported fields (https://w3c.github.io/webrtc-stats/#remoteoutboundrtpstats-dict*)
* *
* "local-id" G_TYPE_STRING identifier for the associated RTCInboundRTPSTreamStats * "local-id" G_TYPE_STRING identifier for the associated RTCInboundRTPSTreamStats
* "remote-timestamp" G_TYPE_DOUBLE remote timestamp the statistics were sent by the remote
* *
*/ */
gst_webrtc_bin_signals[GET_STATS_SIGNAL] = gst_webrtc_bin_signals[GET_STATS_SIGNAL] =