Skip to content

Commit

Permalink
RTCTransportStats - index - partial
Browse files Browse the repository at this point in the history
  • Loading branch information
hamishwillee committed Dec 10, 2024
1 parent 06c8652 commit 03875a1
Showing 1 changed file with 22 additions and 37 deletions.
59 changes: 22 additions & 37 deletions files/en-us/web/api/rtctransportstats/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,37 +18,22 @@ These statistics can be obtained by iterating the {{domxref("RTCStatsReport")}}

## Instance properties

- `bytesReceived` {{optional_inline}}
- {{domxref("RTCTransportStats.bytesReceived", "bytesReceived")}} {{optional_inline}}
- : The total number of payload bytes received on this transport (bytes received, not including headers, padding or ICE connectivity checks).
- `bytesSent` {{optional_inline}}
- {{domxref("RTCTransportStats.bytesSent", "bytesSent")}} {{optional_inline}}
- : The total number of payload bytes sent on this transport (bytes sent, not including headers, padding or ICE connectivity checks).
- `dtlsCipher` {{optional_inline}}
- : A string indicating the name of the cipher suite used for the DTLS transport, as defined in the "Description" column of the [TLS Cipher Suites](https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-4) section in the _IANA cipher suite registry_.
For example `"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256"`.
- `dtlsRole` {{optional_inline}} {{experimental_inline}}

- : The DTLS role of the associated {{domxref("RTCPeerConnection")}}.
This is one of:

- `client`
- `server`
- `unknown` (before the DTLS negotiation starts).

- `dtlsState`

- {{domxref("RTCTransportStats.dtlsCipher", "dtlsCipher")}} {{optional_inline}}
- : A string indicating the name of the cipher suite used for the DTLS transport, such as `TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256`.
- {{domxref("RTCTransportStats.dtlsRole", "dtlsRole")}} {{optional_inline}} {{experimental_inline}}
- : A string indicating the DTLS role of the associated {{domxref("RTCPeerConnection")}}.
This is one of: `client`, `server`, `unknown` (before the DTLS negotiation starts).
- {{domxref("RTCTransportStats.dtlsState", "dtlsState")}}
- : A string indicating the current {{domxref("RTCDtlsTransport.state","state")}} of the underlying {{domxref("RTCDtlsTransport")}}.
This is one of:

- [`new`](/en-US/docs/Web/API/RTCDtlsTransport/state#new)
- [`connecting`](/en-US/docs/Web/API/RTCDtlsTransport/state#connecting)
- [`connected`](/en-US/docs/Web/API/RTCDtlsTransport/state#connected)
- [`closed`](/en-US/docs/Web/API/RTCDtlsTransport/state#closed)
- [`failed`](/en-US/docs/Web/API/RTCDtlsTransport/state#failed)

- `iceLocalUsernameFragment` {{optional_inline}} {{experimental_inline}}
This is one of: `new`, `connecting`, `connected`, `closed`, `failed`.
- {{domxref("RTCTransportStats.iceLocalUsernameFragment", "iceLocalUsernameFragment")}} {{optional_inline}} {{experimental_inline}}
- : A string indicating the local username fragment used in message validation procedures for this transport.
This is the same value as the local {{domxref("RTCIceCandidate.usernameFragment")}}, and will change if the connection is renegotiated.
- `iceRole` {{optional_inline}} {{experimental_inline}}
- {{domxref("RTCTransportStats.iceRole", "iceRole")}} {{optional_inline}} {{experimental_inline}}

- : A string indicating the [ICE `role`](/en-US/docs/Web/API/RTCIceTransport/role) of the underlying {{domxref("RTCDtlsTransport.iceTransport")}}.
This is one of:
Expand All @@ -57,7 +42,7 @@ These statistics can be obtained by iterating the {{domxref("RTCStatsReport")}}
- [`controlling`](/en-US/docs/Web/API/RTCIceTransport/role#controlling)
- [`unknown`](/en-US/docs/Web/API/RTCIceTransport/role#unknown)

- `iceState` {{optional_inline}} {{experimental_inline}}
- {{domxref("RTCTransportStats.iceState", "iceState")}} {{optional_inline}} {{experimental_inline}}

- : A string indicating the current {{domxref("RTCIceTransport.state","state")}} of the underlying {{domxref("RTCIceTransport")}}.
This is one of:
Expand All @@ -70,22 +55,22 @@ These statistics can be obtained by iterating the {{domxref("RTCStatsReport")}}
- [`failed`](/en-US/docs/Web/API/RTCIceTransport/state#failed)
- [`closed`](/en-US/docs/Web/API/RTCIceTransport/state#closed)

- `selectedCandidatePairId` {{optional_inline}}
- : A string containing the unique identifier for the object that was inspected to produce the {{domxref("RTCIceCandidatePairStats")}} associated with this transport.
- `localCertificateId` {{optional_inline}}
- {{domxref("RTCTransportStats.localCertificateId", "localCertificateId")}} {{optional_inline}}
- : A string containing the id of the local certificate used by this transport.
Only present for DTLS transports, and after DTLS has been negotiated.
- `packetsSent` {{optional_inline}} {{experimental_inline}}
- : The total number of packets sent over this transport.
- `packetsReceived` {{optional_inline}} {{experimental_inline}}
- {{domxref("RTCTransportStats.packetsReceived", "packetsReceived")}} {{optional_inline}} {{experimental_inline}}
- : The total number of packets received on this transport.
- `remoteCertificateId` {{optional_inline}}
- {{domxref("RTCTransportStats.packetsSent", "packetsSent")}} {{optional_inline}} {{experimental_inline}}
- : The total number of packets sent over this transport.
- {{domxref("RTCTransportStats.remoteCertificateId", "remoteCertificateId")}} {{optional_inline}}
- : A string containing the id or the remote certificate used by this transport.
Only present for DTLS transports, and after DTLS has been negotiated.
- `selectedCandidatePairChanges` {{optional_inline}}
- {{domxref("RTCTransportStats.selectedCandidatePairChanges", "selectedCandidatePairChanges")}} {{optional_inline}}
- : The number of times that the selected candidate pair of this transport has changed.
The value is initially zero and increases whenever a candidate pair selected or lost.
- `srtpCipher` {{optional_inline}}
- {{domxref("RTCTransportStats.selectedCandidatePairId", "selectedCandidatePairId")}} {{optional_inline}}
- : A string containing the unique identifier for the object that was inspected to produce the {{domxref("RTCIceCandidatePairStats")}} associated with this transport.
- {{domxref("RTCTransportStats.srtpCipher", "srtpCipher")}} {{optional_inline}}

- : A string indicating the descriptive name of the protection profile used for the [Secure Real-time Transport Protocol (SRTP)](/en-US/docs/Glossary/RTP) transport, as defined in the "Profile" column of the [IANA DTLS-SRTP protection profile registry](https://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml#srtp-protection-1) and [RFC5764](https://www.rfc-editor.org/rfc/rfc5764.html#section-4.1.2).

Expand All @@ -102,7 +87,7 @@ These statistics can be obtained by iterating the {{domxref("RTCStatsReport")}}
auth_tag_length: 80
```
- `tlsVersion` {{optional_inline}}
- {{domxref("RTCTransportStats.tlsVersion", "tlsVersion")}} {{optional_inline}}
- : A string containing the negotiated TLS version.
This is present for DTLS transports, and only exists after DTLS has been negotiated.
Expand Down

0 comments on commit 03875a1

Please sign in to comment.