RTCRemoteInboundRtpStreamStats - plus alignment with outbound #32657

hamishwillee · 2024-03-12T06:11:42Z

This adds docs for RTCRemoteInboundRtpStreamStats , a stats object/dictionary you can get by iterating a RTCStatsReport.

It is not very exciting. Largely following the same patterns as the other docs.

This shares some common properties with RTCRemoteOutoundRtpStreamStats. There have been some changes to align those.

This is part of the ongoing work to finished RTC stats, which was started in #27028

github-actions · 2024-03-12T06:12:58Z

Preview URLs (25 pages)

Flaws (30)

Note! 1 document with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/RTCRemoteInboundRtpStreamStats
Title: RTCRemoteInboundRtpStreamStats
Flaw count: 1

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters

URL: /en-US/docs/Web/API/RTCRemoteInboundRtpStreamStats/type
Title: RTCRemoteInboundRtpStreamStats: type property
Flaw count: 1

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters

URL: /en-US/docs/Web/API/RTCRemoteInboundRtpStreamStats/roundTripTime
Title: RTCRemoteInboundRtpStreamStats: roundTripTime property
Flaw count: 1

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters

URL: /en-US/docs/Web/API/RTCRemoteInboundRtpStreamStats/jitter
Title: RTCRemoteInboundRtpStreamStats: jitter property
Flaw count: 2

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters
- /en-US/docs/Web/API/RTCInboundRtpStreamStats/jitter does not exist

URL: /en-US/docs/Web/API/RTCRemoteInboundRtpStreamStats/fractionLost
Title: RTCRemoteInboundRtpStreamStats: fractionLost property
Flaw count: 1

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters

URL: /en-US/docs/Web/API/RTCRemoteInboundRtpStreamStats/totalRoundTripTime
Title: RTCRemoteInboundRtpStreamStats: totalRoundTripTime property
Flaw count: 1

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters

URL: /en-US/docs/Web/API/RTCRemoteInboundRtpStreamStats/ssrc
Title: RTCRemoteInboundRtpStreamStats: ssrc property
Flaw count: 1

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters

URL: /en-US/docs/Web/API/RTCRemoteInboundRtpStreamStats/timestamp
Title: RTCRemoteInboundRtpStreamStats: timestamp property
Flaw count: 1

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters

URL: /en-US/docs/Web/API/RTCRemoteInboundRtpStreamStats/roundTripTimeMeasurements
Title: RTCRemoteInboundRtpStreamStats: roundTripTimeMeasurements property
Flaw count: 1

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters

URL: /en-US/docs/Web/API/RTCRemoteInboundRtpStreamStats/localId
Title: RTCRemoteInboundRtpStreamStats: localId property
Flaw count: 1

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters

URL: /en-US/docs/Web/API/RTCRemoteInboundRtpStreamStats/id
Title: RTCRemoteInboundRtpStreamStats: id property
Flaw count: 1

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters

URL: /en-US/docs/Web/API/RTCRemoteInboundRtpStreamStats/packetsLost
Title: RTCRemoteInboundRtpStreamStats: packetsLost property
Flaw count: 2

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters
- /en-US/docs/Web/API/RTCInboundRtpStreamStats/packetsLost does not exist

URL: /en-US/docs/Web/API/RTCRemoteInboundRtpStreamStats/kind
Title: RTCRemoteInboundRtpStreamStats: kind property
Flaw count: 1

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters

URL: /en-US/docs/Web/API/RTCRemoteInboundRtpStreamStats/codecId
Title: RTCRemoteInboundRtpStreamStats: codecId property
Flaw count: 1

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters

URL: /en-US/docs/Web/API/RTCRemoteInboundRtpStreamStats/packetsReceived
Title: RTCRemoteInboundRtpStreamStats: packetsReceived property
Flaw count: 2

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters
- /en-US/docs/Web/API/RTCInboundRtpStreamStats/packetsReceived does not exist

URL: /en-US/docs/Web/API/RTCRemoteInboundRtpStreamStats/transportId
Title: RTCRemoteInboundRtpStreamStats: transportId property
Flaw count: 1

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters

URL: /en-US/docs/Web/API/RTCRemoteOutboundRtpStreamStats
Title: RTCRemoteOutboundRtpStreamStats
Flaw count: 1

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters

URL: /en-US/docs/Web/API/RTCRemoteOutboundRtpStreamStats/totalRoundTripTime
Title: RTCRemoteOutboundRtpStreamStats: totalRoundTripTime property
Flaw count: 1

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters

URL: /en-US/docs/Web/API/RTCRemoteOutboundRtpStreamStats/ssrc
Title: RTCRemoteOutboundRtpStreamStats: ssrc property
Flaw count: 1

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters

URL: /en-US/docs/Web/API/RTCRemoteOutboundRtpStreamStats/roundTripTimeMeasurements
Title: RTCRemoteOutboundRtpStreamStats: roundTripTimeMeasurements property
Flaw count: 1

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters

URL: /en-US/docs/Web/API/RTCRemoteOutboundRtpStreamStats/localId
Title: RTCRemoteOutboundRtpStreamStats: localId property
Flaw count: 3

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters
- /en-US/docs/Web/API/RTCSentRtpStreamStats/packetsSent does not exist
- /en-US/docs/Web/API/RTCSentRtpStreamStats/bytesSent does not exist

URL: /en-US/docs/Web/API/RTCRemoteOutboundRtpStreamStats/kind
Title: RTCRemoteOutboundRtpStreamStats: kind property
Flaw count: 2

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters
- /en-US/docs/Web/API/RTCCodecStats/codec does not exist

URL: /en-US/docs/Web/API/RTCRemoteOutboundRtpStreamStats/codecId
Title: RTCRemoteOutboundRtpStreamStats: codecId property
Flaw count: 1

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters

URL: /en-US/docs/Web/API/RTCRemoteOutboundRtpStreamStats/transportId
Title: RTCRemoteOutboundRtpStreamStats: transportId property
Flaw count: 1

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters

External URLs (2)

URL: /en-US/docs/Web/API/RTCRemoteInboundRtpStreamStats/fractionLost
Title: RTCRemoteInboundRtpStreamStats: fractionLost property

https://datatracker.ietf.org/doc/html/rfc3550 (2 times) (Note! This may be a new URL 👀)

URL: /en-US/docs/Glossary/Jitter
Title: Jitter

https://en.wikipedia.org/wiki/Packet_delay_variation (1 time) (Note! This may be a new URL 👀)

(comment last updated: 2024-07-09 02:16:38)

hamishwillee · 2024-03-15T05:44:08Z

files/en-us/web/api/rtcremoteinboundrtpstreamstats/packetsreceived/index.md

+
+## Value
+
+A positive integer value indicating the total number of received RTP packets at the remote endpoint.


NOTE, I am confused here. For context RTCRemoteInboundRtpStreamStats are statistics from the remote system about inbound stream stats. In other words, the local end sent some information to the remote end. The remote end has reported some information back to say what it received.

So for remote inbound stats my understanding is that you're getting the packetsReceived as measured at the remote end. This will simply be all received packets since the beginning of the session including retransmissions.
This contrasts with RTCInboundRtpStreamStats.packetsRecieved which is the local end calculating stats for the inbound stream.

But the spec states for packetsReceived:

packetsReceived of type unsigned long long

Total number of RTP packets received for this SSRC. This includes retransmissions. At the receiving endpoint, this is calculated as defined in [RFC3550] section 6.4.1. At the sending endpoint the packetsReceived is estimated by subtracting the Cumulative Number of Packets Lost from the Extended Highest Sequence Number Received, both reported in the RTCP Receiver Report, and then subtracting the initial Extended Sequence Number that was sent to this SSRC in a RTCP Sender Report and then adding one, to mirror what is discussed in Appendix A.3 in [RFC3550], but for the sender side. If no RTCP Receiver Report has been received yet, then return 0.

IF we assume that by "receiving endpoint" we mean "whatever is calculating the packets received" then this works because a receiver just counts what packets it got - and that is then way we got back from the remote end in this report.

I THINK the bit about "at the sending endpoint ..." is irrelevant. I.e. you might calculate the packetsRecieved in that way at the sender, but that has nothing to do with this data we are reporting.

hamishwillee · 2024-03-19T05:37:55Z

files/en-us/web/api/rtcremoteinboundrtpstreamstats/fractionlost/index.md

+The value provides a quick and convenient measure of the link quality.
+It is the packet loss as a fraction, scaled up by 256.
+To convert to a percentage, divide by 256 and multiply by 100.
+For example, a value of 20 would equal a 7.8% packet loss.
+Note that the packet loss can be negative if more packets are received than expected, and in this case the fraction is set to zero.


Note that all of this is my "guess/evaluation" based on the RFC info and appending linked in the next section. All the spec says is that it is calculated as per those spec links. I have interpreted that to mean that the property contains the 8 bit unsigned integer in the RR/SR "fraction loss" field. That is calculated by 8 bit shifting a number so the fraction is now the number.

It all sounds rational, but I can't prove it. I've tried a bunch of examples out and they all give me a value of zero :-( (which is what you get if there is no loss OR if the loss is negative).

hamishwillee · 2024-03-19T05:39:31Z

@wbamberg Yet another one to look at. I will probably continue working on it to update RTCRemoteOutoundRtpStreamStats if you don't review it soon, as they have more common behaviour. But if you do start reviewing I'll stop that.

wbamberg · 2024-03-19T05:53:09Z

ah right, so the quicker I review it the smaller it'll be? :)

hamishwillee · 2024-03-19T05:59:15Z

@wbamberg Yes :-). I'll be pausing if you review this earlier so that neither of us have a moving target for the "common" changes that are in this PR. But I'm not back until Friday. No huge urgency.

wbamberg · 2024-04-06T03:50:46Z

@hamishwillee , I have started on this.

files/en-us/glossary/jitter/index.md

wbamberg · 2024-04-04T23:06:11Z

files/en-us/web/api/rtcremoteinboundrtpstreamstats/index.md

+
+<!-- RTCRemoteInboundRtpStreamStats -->
+
+- {{domxref("RTCRemoteInboundRtpStreamStats.localId", "localId")}} {{optional_inline}}


Alphabetical order for members?

files/en-us/web/api/rtcremoteinboundrtpstreamstats/index.md

files/en-us/web/api/rtcremoteoutboundrtpstreamstats/index.md

files/en-us/web/api/rtcremoteoutboundrtpstreamstats/roundtriptimemeasurements/index.md

files/en-us/web/api/rtcremoteoutboundrtpstreamstats/totalroundtriptime/index.md

pepelsbey · 2024-07-08T09:47:15Z

@hamishwillee hey! Do you think we can still pull this through?

hamishwillee · 2024-07-09T00:29:24Z

@pepelsbey I've been putting this off as "not a priority". I've merged most of the suggestions but I want to have another look at it on Friday. Will is on holiday, so it is not urgent unless you want to review it?

files/en-us/web/api/rtcremoteinboundrtpstreamstats/index.md

Co-authored-by: wbamberg <will@bootbonnet.ca>

files/en-us/web/api/rtcremoteinboundrtpstreamstats/index.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

pepelsbey · 2024-07-15T16:12:56Z

Will is on holiday, so it is not urgent unless you want to review it?

Thank you! As you said, it’s not a priority, so I’d leave it to Will since he’s already familiar with it.

hamishwillee · 2024-07-15T23:11:22Z

Cool. I have a few more review comments to address in any case. This moves to end of the cycle job.

github-actions bot added Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed labels Mar 12, 2024

hamishwillee force-pushed the rtcremoteinboundrtpstreamstats branch from ad6442b to 788f114 Compare March 15, 2024 02:52

github-actions bot added the Content:Glossary Glossary entries label Mar 15, 2024

hamishwillee commented Mar 15, 2024

View reviewed changes

hamishwillee force-pushed the rtcremoteinboundrtpstreamstats branch from d111915 to 137ef8a Compare March 19, 2024 00:16

github-actions bot added size/l [PR only] 501-1000 LoC changed and removed size/m [PR only] 51-500 LoC changed labels Mar 19, 2024

hamishwillee commented Mar 19, 2024

View reviewed changes

hamishwillee marked this pull request as ready for review March 19, 2024 05:38

hamishwillee requested review from a team as code owners March 19, 2024 05:38

hamishwillee requested review from Elchi3 and pepelsbey and removed request for a team March 19, 2024 05:38

wbamberg requested changes Apr 8, 2024

View reviewed changes

hamishwillee commented Jul 9, 2024

View reviewed changes

files/en-us/web/api/rtcremoteinboundrtpstreamstats/index.md Outdated Show resolved Hide resolved

hamishwillee commented Jul 9, 2024

View reviewed changes

files/en-us/web/api/rtcremoteinboundrtpstreamstats/index.md Outdated Show resolved Hide resolved

hamishwillee added 3 commits July 9, 2024 10:45

RTCRemoteInboundRtpStreamStats: id

e3e8966

RTCRemoteInboundRtpStreamStats.timestamp

af9aa71

RTCRemoteInboundRtpStreamStats.type

fda1a38

hamishwillee and others added 23 commits July 9, 2024 10:45

RTCRemoteInboundRtpStreamStats.transportId

bf0518f

RTCRemoteOuboundRtpStreamStats.transportId - match to inbound

5a1c11a

RTCRemoteInboundRtpStreamStats.ssrc

11f48ba

RTCRemoteOutboundRtpStreamStats.ssrc - alignment

bb6fe91

RTCRemoteInboundRtpStreamStats.kind

15dec7d

RTCRemoteOutboundRtpStreamStats.kind - alignment

d325603

Tweaks/aligment for transport id

dcbd2e7

RTCRemoteInboundRtpStreamStats.codecId

c8faca6

RTCRemoteOutboundRtpStreamStats.codecId - alignment

bd7ea6a

RTCRemoteOutboundRtpStreamStats improve description

d94bfc6

RTCRemoteInboundRtpStreamStats - partial draft

b70f246

RTCRemoteInboundRtpStreamStats.jitter and glossary

8ead0a5

RTCRemoteInboundRtpStreamStats.packetsLost

fd03370

RTCRemoteInboundRtpStreamStats.packetsReceived

67e61ab

Minor fixes to timestamp

6f1e2c8

rttmeasurements property

4439c3e

Add RTCRemoteInboundStats to sidebar

e382702

Assorted minor improvements

44c868d

RTCRemoteInboutRtpStreamStats.totalrtt, localid, rttmeas

0b0c385

RTCRemoteOutboundRtpStreamStats - matching localid, rttmeas, totalrtt

14dd7b7

RTCRemoteInboundRtpStreamStats.roundTripTime

2f87b09

RTCRemoteInboundRtpStreamStats.fractionLost

18e8ecb

Apply suggestions from code review

41bb603

Co-authored-by: wbamberg <will@bootbonnet.ca>

hamishwillee force-pushed the rtcremoteinboundrtpstreamstats branch from a5f1644 to 41bb603 Compare July 9, 2024 00:45

github-actions bot reviewed Jul 9, 2024

View reviewed changes

files/en-us/web/api/rtcremoteinboundrtpstreamstats/index.md Outdated Show resolved Hide resolved

Update files/en-us/web/api/rtcremoteinboundrtpstreamstats/index.md

ac40751

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Elchi3 removed their request for review July 17, 2024 10:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RTCRemoteInboundRtpStreamStats - plus alignment with outbound #32657

RTCRemoteInboundRtpStreamStats - plus alignment with outbound #32657

hamishwillee commented Mar 12, 2024

github-actions bot commented Mar 12, 2024 •

edited

Loading

hamishwillee Mar 15, 2024 •

edited

Loading

hamishwillee Mar 19, 2024

hamishwillee commented Mar 19, 2024

wbamberg commented Mar 19, 2024

hamishwillee commented Mar 19, 2024 •

edited

Loading

wbamberg commented Apr 6, 2024

wbamberg Apr 4, 2024

pepelsbey commented Jul 8, 2024

hamishwillee commented Jul 9, 2024 •

edited

Loading

pepelsbey commented Jul 15, 2024

hamishwillee commented Jul 15, 2024


		## Value

		A positive integer value indicating the total number of received RTP packets at the remote endpoint.


		<!-- RTCRemoteInboundRtpStreamStats -->

		- {{domxref("RTCRemoteInboundRtpStreamStats.localId", "localId")}} {{optional_inline}}

RTCRemoteInboundRtpStreamStats - plus alignment with outbound #32657

Are you sure you want to change the base?

RTCRemoteInboundRtpStreamStats - plus alignment with outbound #32657

Conversation

hamishwillee commented Mar 12, 2024

github-actions bot commented Mar 12, 2024 • edited Loading

hamishwillee Mar 15, 2024 • edited Loading

Choose a reason for hiding this comment

hamishwillee Mar 19, 2024

Choose a reason for hiding this comment

hamishwillee commented Mar 19, 2024

wbamberg commented Mar 19, 2024

hamishwillee commented Mar 19, 2024 • edited Loading

wbamberg commented Apr 6, 2024

wbamberg Apr 4, 2024

Choose a reason for hiding this comment

pepelsbey commented Jul 8, 2024

hamishwillee commented Jul 9, 2024 • edited Loading

pepelsbey commented Jul 15, 2024

hamishwillee commented Jul 15, 2024

github-actions bot commented Mar 12, 2024 •

edited

Loading

hamishwillee Mar 15, 2024 •

edited

Loading

hamishwillee commented Mar 19, 2024 •

edited

Loading

hamishwillee commented Jul 9, 2024 •

edited

Loading