rtpsource: clarify meaning of the octets-sent and octets-received stats
authorAntonio Ospite <antonio.ospite@collabora.com>
Tue, 9 Apr 2019 08:46:39 +0000 (10:46 +0200)
committerAntonio Ospite <antonio.ospite@collabora.com>
Fri, 2 Aug 2019 15:22:51 +0000 (17:22 +0200)
The octets-send and octets-received stats count the payload bytes
excluding RTP and lower level headers, clarify that in the
documentation.

gst/rtpmanager/rtpsource.c

index da357ee..f4755c7 100644 (file)
@@ -161,13 +161,13 @@ rtp_source_class_init (RTPSourceClass * klass)
    * The following fields make sense for internal sources and will only increase
    * when "is-sender" is TRUE.
    *
-   *  "octets-sent"  G_TYPE_UINT64   number of bytes we sent
+   *  "octets-sent"  G_TYPE_UINT64   number of payload bytes we sent
    *  "packets-sent" G_TYPE_UINT64   number of packets we sent
    *
    * The following fields make sense for non-internal sources and will only
    * increase when "is-sender" is TRUE.
    *
-   *  "octets-received"  G_TYPE_UINT64  total number of bytes received
+   *  "octets-received"  G_TYPE_UINT64  total number of payload bytes received
    *  "packets-received" G_TYPE_UINT64  total number of packets received
    *  "bytes-received"   G_TYPE_UINT64  total number of bytes received including lower level headers overhead
    *