From f429d8a333320786bf0e405e683aee155afb8339 Mon Sep 17 00:00:00 2001 From: Hamish Willee Date: Fri, 1 Nov 2024 11:13:24 +1100 Subject: [PATCH] Apply suggestions from code review Co-authored-by: wbamberg --- .../availableincomingbitrate/index.md | 2 +- .../availableoutgoingbitrate/index.md | 2 +- files/en-us/web/api/rtcicecandidatepairstats/index.md | 4 ++-- .../api/rtcicecandidatepairstats/remotecandidateid/index.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/files/en-us/web/api/rtcicecandidatepairstats/availableincomingbitrate/index.md b/files/en-us/web/api/rtcicecandidatepairstats/availableincomingbitrate/index.md index 48e1440290f5cc2..17aab5424355742 100644 --- a/files/en-us/web/api/rtcicecandidatepairstats/availableincomingbitrate/index.md +++ b/files/en-us/web/api/rtcicecandidatepairstats/availableincomingbitrate/index.md @@ -15,7 +15,7 @@ You can get the outgoing available bitrate from {{domxref("RTCIceCandidatePairSt ## Value -A number value which approximates the amount of available bandwidth for incoming data on the network connection described by the `RTCIceCandidatePair`. +A number which approximates the amount of available bandwidth for incoming data on the network connection described by the `RTCIceCandidatePair`. The value is reported in bits per second and is computed over a 1-second interval. The value returned is calculated by adding up the available bit rate for every {{Glossary("RTP")}} stream using the connection described by this candidate pair. diff --git a/files/en-us/web/api/rtcicecandidatepairstats/availableoutgoingbitrate/index.md b/files/en-us/web/api/rtcicecandidatepairstats/availableoutgoingbitrate/index.md index 70752d34c180373..8934816b38b9eb7 100644 --- a/files/en-us/web/api/rtcicecandidatepairstats/availableoutgoingbitrate/index.md +++ b/files/en-us/web/api/rtcicecandidatepairstats/availableoutgoingbitrate/index.md @@ -15,7 +15,7 @@ You can get the incoming available bitrate from {{domxref("RTCIceCandidatePairSt ## Value -A number value which approximates the amount of available bandwidth for outgoing data on the network connection described by the +A number which approximates the amount of available bandwidth for outgoing data on the network connection described by the `RTCIceCandidatePair`. The value is reported in bits per second and is computed over a 1-second interval. diff --git a/files/en-us/web/api/rtcicecandidatepairstats/index.md b/files/en-us/web/api/rtcicecandidatepairstats/index.md index ae549ded5d155cd..90a6d334e4574dd 100644 --- a/files/en-us/web/api/rtcicecandidatepairstats/index.md +++ b/files/en-us/web/api/rtcicecandidatepairstats/index.md @@ -14,7 +14,7 @@ The statistics can be obtained by iterating the {{domxref("RTCStatsReport")}} re ## Instance properties - {{domxref("RTCIceCandidatePairStats.availableIncomingBitrate", "availableIncomingBitrate")}} {{optional_inline}} - - : An number representing the available inbound capacity of the network. + - : A number representing the available inbound capacity of the network. This reports the total number of bits per second available for all of the candidate pair's incoming {{Glossary("RTP")}} streams. It does not take into account the size of the Internet Protocol (IP) overhead, nor any other transport layers such as {{Glossary("TCP")}} or {{Glossary("UDP")}}. - {{domxref("RTCIceCandidatePairStats.availableOutgoingBitrate", "availableOutgoingBitrate")}} {{optional_inline}} @@ -59,7 +59,7 @@ The statistics can be obtained by iterating the {{domxref("RTCStatsReport")}} re - {{domxref("RTCIceCandidatePairStats.state", "state")}} {{optional_inline}} - : A string which indicates the state of the connection between the two candidates. - {{domxref("RTCIceCandidatePairStats.totalRoundTripTime", "totalRoundTripTime")}} {{optional_inline}} - - : A number value indicating the total time, in seconds, that has elapsed between sending STUN requests and receiving responses to them, for all such requests made to date on this candidate pair. + - : A number indicating the total time, in seconds, that has elapsed between sending STUN requests and receiving responses to them, for all such requests made to date on this candidate pair. This includes both connectivity check and consent check requests. You can compute the average round trip time (RTT) by dividing this value by {{domxref("RTCIceCandidatePairStats.responsesReceived", "responsesReceived")}}. - {{domxref("RTCIceCandidatePairStats.transportId", "transportId")}} {{optional_inline}} - : A string that uniquely identifies the {{domxref("RTCIceTransport")}} that was inspected to obtain the transport-related statistics (as found in {{domxref("RTCTransportStats")}}) used in generating this object. diff --git a/files/en-us/web/api/rtcicecandidatepairstats/remotecandidateid/index.md b/files/en-us/web/api/rtcicecandidatepairstats/remotecandidateid/index.md index a61cf96deef8c63..98151250000f3a5 100644 --- a/files/en-us/web/api/rtcicecandidatepairstats/remotecandidateid/index.md +++ b/files/en-us/web/api/rtcicecandidatepairstats/remotecandidateid/index.md @@ -12,7 +12,7 @@ The **`remoteCandidateId`** property of the {{domxref("RTCIceCandidatePairStats" ## Value -A string uniquely identifies the remote {{Glossary("ICE")}} candidate—that is, the candidate describing a configuration for the remote peer—which is represented by the remote end of these statistics. +A string uniquely identifying the remote {{Glossary("ICE")}} candidate—that is, the candidate describing a configuration for the remote peer—which is represented by the remote end of these statistics. ## Specifications