Skip to content

Commit

Permalink
Synchronize with BCD v5.2.58 (#26829)
Browse files Browse the repository at this point in the history
Co-authored-by: OnkarRuikar <[email protected]>
  • Loading branch information
OnkarRuikar and OnkarRuikar authored May 18, 2023
1 parent 93bb459 commit 341eecc
Show file tree
Hide file tree
Showing 30 changed files with 60 additions and 106 deletions.
4 changes: 3 additions & 1 deletion files/en-us/web/api/rtcaudiosourcestats/audiolevel/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@ title: "RTCAudioSourceStats: audioLevel property"
short-title: audioLevel
slug: Web/API/RTCAudioSourceStats/audioLevel
page-type: web-api-instance-property
status:
- experimental
browser-compat: api.RTCStatsReport.type_media-source.audioLevel
---

{{APIRef("WebRTC")}}
{{APIRef("WebRTC")}}{{SeeCompatTable}}

The {{domxref("RTCAudioSourceStats")}} dictionary's **`audioLevel`** property represents the audio level of the media source.

Expand Down
6 changes: 3 additions & 3 deletions files/en-us/web/api/rtcaudiosourcestats/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ These statistics can be obtained by iterating the {{domxref("RTCStatsReport")}}
## Instance properties

- {{domxref("RTCAudioSourceStats.audioLevel", "audioLevel")}}
- {{domxref("RTCAudioSourceStats.audioLevel", "audioLevel")}} {{Experimental_Inline}}
- : A number that represents the audio level of the media source.
- {{domxref("RTCAudioSourceStats.totalAudioEnergy", "totalAudioEnergy")}}
- {{domxref("RTCAudioSourceStats.totalAudioEnergy", "totalAudioEnergy")}} {{Experimental_Inline}}
- : A number that represents the total audio energy of the media source over the lifetime of the stats object.
- {{domxref("RTCAudioSourceStats.totalSamplesDuration", "totalSamplesDuration")}}
- {{domxref("RTCAudioSourceStats.totalSamplesDuration", "totalSamplesDuration")}} {{Experimental_Inline}}
- : A number that represents the total duration of all samples produced by the media source over the lifetime of the stats object.

The following properties are present in both `RTCAudioSourceStats` and {{domxref("RTCVideoSourceStats")}}: <!-- RTCMediaSourceStats -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@ title: "RTCAudioSourceStats: totalAudioEnergy property"
short-title: totalAudioEnergy
slug: Web/API/RTCAudioSourceStats/totalAudioEnergy
page-type: web-api-instance-property
status:
- experimental
browser-compat: api.RTCStatsReport.type_media-source.totalAudioEnergy
---

{{APIRef("WebRTC")}}
{{APIRef("WebRTC")}}{{SeeCompatTable}}

The {{domxref("RTCAudioSourceStats")}} dictionary's **`totalAudioEnergy`** property represents the total audio energy of the media source over the lifetime of this stats object.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@ title: "RTCAudioSourceStats: totalSamplesDuration property"
short-title: totalSamplesDuration
slug: Web/API/RTCAudioSourceStats/totalSamplesDuration
page-type: web-api-instance-property
status:
- experimental
browser-compat: api.RTCStatsReport.type_media-source.totalSamplesDuration
---

{{APIRef("WebRTC")}}
{{APIRef("WebRTC")}}{{SeeCompatTable}}

The {{domxref("RTCAudioSourceStats")}} dictionary's **`totalSamplesDuration`** property represents the combined duration of all samples produced by the media source over the lifetime of this stats object, in seconds.
It does not include samples dropped before reaching this media source. <!-- Dropped samples in `droppedSamplesDuration`; not implemented -->
Expand Down
4 changes: 1 addition & 3 deletions files/en-us/web/api/webtransport/close/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@ title: "WebTransport: close() method"
short-title: close()
slug: Web/API/WebTransport/close
page-type: web-api-instance-method
status:
- experimental
browser-compat: api.WebTransport.close
---

{{APIRef("WebTransport API")}}{{SeeCompatTable}}{{SecureContext_Header}}
{{APIRef("WebTransport API")}}{{SecureContext_Header}}

The **`close()`** method of the {{domxref("WebTransport")}} interface closes an ongoing WebTransport session.

Expand Down
4 changes: 1 addition & 3 deletions files/en-us/web/api/webtransport/closed/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@ title: "WebTransport: closed property"
short-title: closed
slug: Web/API/WebTransport/closed
page-type: web-api-instance-property
status:
- experimental
browser-compat: api.WebTransport.closed
---

{{APIRef("WebTransport API")}}{{SeeCompatTable}}{{SecureContext_Header}}
{{APIRef("WebTransport API")}}{{SecureContext_Header}}

The **`closed`** read-only property of the {{domxref("WebTransport")}} interface returns a promise that resolves when the transport is closed.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@ title: "WebTransport: createBidirectionalStream() method"
short-title: createBidirectionalStream()
slug: Web/API/WebTransport/createBidirectionalStream
page-type: web-api-instance-method
status:
- experimental
browser-compat: api.WebTransport.createBidirectionalStream
---

{{APIRef("WebTransport API")}}{{SeeCompatTable}}{{SecureContext_Header}}
{{APIRef("WebTransport API")}}{{SecureContext_Header}}

The **`createBidirectionalStream()`** method of the {{domxref("WebTransport")}} interface opens a bidirectional stream; it returns a {{domxref("WebTransportBidirectionalStream")}} object containing `readable` and `writable` properties, which can be used to reliably read from and write to the server.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@ title: "WebTransport: createUnidirectionalStream() method"
short-title: createUnidirectionalStream()
slug: Web/API/WebTransport/createUnidirectionalStream
page-type: web-api-instance-method
status:
- experimental
browser-compat: api.WebTransport.createUnidirectionalStream
---

{{APIRef("WebTransport API")}}{{SeeCompatTable}}{{SecureContext_Header}}
{{APIRef("WebTransport API")}}{{SecureContext_Header}}

The **`createUnidirectionalStream()`** method of the {{domxref("WebTransport")}} interface opens a unidirectional stream; it returns a {{domxref("WritableStream")}} object that can be used to reliably write data to the server.

Expand Down
4 changes: 1 addition & 3 deletions files/en-us/web/api/webtransport/datagrams/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@ title: "WebTransport: datagrams property"
short-title: datagrams
slug: Web/API/WebTransport/datagrams
page-type: web-api-instance-property
status:
- experimental
browser-compat: api.WebTransport.datagrams
---

{{APIRef("WebTransport API")}}{{SeeCompatTable}}{{SecureContext_Header}}
{{APIRef("WebTransport API")}}{{SecureContext_Header}}

The **`datagrams`** read-only property of the {{domxref("WebTransport")}} interface returns a {{domxref("WebTransportDatagramDuplexStream")}} instance that can be used to send and receive datagrams — unreliable data transmission.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@ title: "WebTransport: incomingBidirectionalStreams property"
short-title: incomingBidirectionalStreams
slug: Web/API/WebTransport/incomingBidirectionalStreams
page-type: web-api-instance-property
status:
- experimental
browser-compat: api.WebTransport.incomingBidirectionalStreams
---

{{APIRef("WebTransport API")}}{{SeeCompatTable}}{{SecureContext_Header}}
{{APIRef("WebTransport API")}}{{SecureContext_Header}}

The **`incomingBidirectionalStreams`** read-only property of the {{domxref("WebTransport")}} interface represents one or more bidirectional streams opened by the server. Returns a {{domxref("ReadableStream")}} of {{domxref("WebTransportBidirectionalStream")}} objects. Each one can be used to reliably read data from the server and write data back to it.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@ title: "WebTransport: incomingUnidirectionalStreams property"
short-title: incomingUnidirectionalStreams
slug: Web/API/WebTransport/incomingUnidirectionalStreams
page-type: web-api-instance-property
status:
- experimental
browser-compat: api.WebTransport.incomingUnidirectionalStreams
---

{{APIRef("WebTransport API")}}{{SeeCompatTable}}{{SecureContext_Header}}
{{APIRef("WebTransport API")}}{{SecureContext_Header}}

The **`incomingUnidirectionalStreams`** read-only property of the {{domxref("WebTransport")}} interface represents one or more unidirectional streams opened by the server. Returns a {{domxref("ReadableStream")}} of {{domxref("WebTransportReceiveStream")}} objects. Each one can be used to reliably read data from the server.

Expand Down
22 changes: 10 additions & 12 deletions files/en-us/web/api/webtransport/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@
title: WebTransport
slug: Web/API/WebTransport
page-type: web-api-interface
status:
- experimental
browser-compat: api.WebTransport
---

{{APIRef("WebTransport API")}}{{SeeCompatTable}}{{SecureContext_Header}}
{{APIRef("WebTransport API")}}{{SecureContext_Header}}

The **`WebTransport`** interface of the {{domxref("WebTransport API", "WebTransport API", "", "nocode")}} provides functionality to enable a user agent to connect to an HTTP/3 server, initiate reliable and unreliable transport in either or both directions, and close the connection once it is no longer needed.

Expand All @@ -17,29 +15,29 @@ The **`WebTransport`** interface of the {{domxref("WebTransport API", "WebTransp

## Constructor

- {{domxref("WebTransport.WebTransport", "WebTransport()")}} {{Experimental_Inline}}
- {{domxref("WebTransport.WebTransport", "WebTransport()")}}
- : Creates a new `WebTransport` object instance.

## Instance properties

- {{domxref("WebTransport.closed", "closed")}} {{ReadOnlyInline}} {{Experimental_Inline}}
- {{domxref("WebTransport.closed", "closed")}} {{ReadOnlyInline}}
- : Returns a promise that resolves when the transport is closed.
- {{domxref("WebTransport.datagrams", "datagrams")}} {{ReadOnlyInline}} {{Experimental_Inline}}
- {{domxref("WebTransport.datagrams", "datagrams")}} {{ReadOnlyInline}}
- : Returns a {{domxref("WebTransportDatagramDuplexStream")}} instance that can be used to send and receive datagrams.
- {{domxref("WebTransport.incomingBidirectionalStreams", "incomingBidirectionalStreams")}} {{ReadOnlyInline}} {{Experimental_Inline}}
- {{domxref("WebTransport.incomingBidirectionalStreams", "incomingBidirectionalStreams")}} {{ReadOnlyInline}}
- : Represents one or more bidirectional streams opened by the server. Returns a {{domxref("ReadableStream")}} of {{domxref("WebTransportBidirectionalStream")}} objects. Each one can be used to read data from the server and write data back to it.
- {{domxref("WebTransport.incomingUnidirectionalStreams", "incomingUnidirectionalStreams")}} {{ReadOnlyInline}} {{Experimental_Inline}}
- {{domxref("WebTransport.incomingUnidirectionalStreams", "incomingUnidirectionalStreams")}} {{ReadOnlyInline}}
- : Represents one or more unidirectional streams opened by the server. Returns a {{domxref("ReadableStream")}} of {{domxref("WebTransportReceiveStream")}} objects. Each one can be used to read data from the server.
- {{domxref("WebTransport.ready", "ready")}} {{ReadOnlyInline}} {{Experimental_Inline}}
- {{domxref("WebTransport.ready", "ready")}} {{ReadOnlyInline}}
- : Returns a promise that resolves when the transport is ready to use.

## Instance methods

- {{domxref("WebTransport.close", "close()")}} {{Experimental_Inline}}
- {{domxref("WebTransport.close", "close()")}}
- : Closes an ongoing WebTransport session.
- {{domxref("WebTransport.createBidirectionalStream", "createBidirectionalStream()")}} {{Experimental_Inline}}
- {{domxref("WebTransport.createBidirectionalStream", "createBidirectionalStream()")}}
- : Opens a bidirectional stream; returns a {{domxref("WebTransportBidirectionalStream")}} object containing `readable` and `writable` properties, which can be used to read from and write to the server.
- {{domxref("WebTransport.createUnidirectionalStream", "createUnidirectionalStream()")}} {{Experimental_Inline}}
- {{domxref("WebTransport.createUnidirectionalStream", "createUnidirectionalStream()")}}
- : Opens a unidirectional stream; returns a {{domxref("WritableStream")}} object that can be used to write to the server.

## Examples
Expand Down
4 changes: 1 addition & 3 deletions files/en-us/web/api/webtransport/ready/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@ title: "WebTransport: ready property"
short-title: ready
slug: Web/API/WebTransport/ready
page-type: web-api-instance-property
status:
- experimental
browser-compat: api.WebTransport.ready
---

{{APIRef("WebTransport API")}}{{SeeCompatTable}}{{SecureContext_Header}}
{{APIRef("WebTransport API")}}{{SecureContext_Header}}

The **`ready`** read-only property of the {{domxref("WebTransport")}} interface returns a promise that resolves when the transport is ready to use.

Expand Down
4 changes: 1 addition & 3 deletions files/en-us/web/api/webtransport/webtransport/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@ title: "WebTransport: WebTransport() constructor"
short-title: WebTransport()
slug: Web/API/WebTransport/WebTransport
page-type: web-api-constructor
status:
- experimental
browser-compat: api.WebTransport.WebTransport
---

{{APIRef("WebTransport API")}}{{SeeCompatTable}}{{SecureContext_Header}}
{{APIRef("WebTransport API")}}{{SecureContext_Header}}

The **`WebTransport()`** constructor creates a new
{{domxref("WebTransport")}} object instance.
Expand Down
6 changes: 2 additions & 4 deletions files/en-us/web/api/webtransport_api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@
title: WebTransport API
slug: Web/API/WebTransport_API
page-type: web-api-overview
status:
- experimental
browser-compat: api.WebTransport
---

{{SeeCompatTable}}{{DefaultAPISidebar("WebTransport API")}}{{SecureContext_Header}}
{{DefaultAPISidebar("WebTransport API")}}{{SecureContext_Header}}

The **WebTransport API** provides a modern update to {{domxref("WebSockets API", "WebSockets", "", "nocode")}}, transmitting data between client and server using [HTTP/3 Transport](https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/). WebTransport provides support for multiple streams, unidirectional streams, and out-of-order delivery. It enables reliable transport via {{domxref("Streams API", "streams", "", "nocode")}} and unreliable transport via UDP-like datagrams.

Expand Down Expand Up @@ -221,7 +219,7 @@ async function receiveBidirectional() {

## Interfaces

- {{domxref("WebTransport")}} {{Experimental_Inline}}
- {{domxref("WebTransport")}}
- : Provides functionality to enable a user agent to connect to an HTTP/3 server, initiate reliable and unreliable transport in either or both directions, and close the connection once it is no longer needed.
- {{domxref("WebTransportBidirectionalStream")}}
- : Represents a bidirectional stream created by a server or a client that can be used for reliable transport. Provides access to a {{domxref("ReadableStream")}} for reading incoming data, and a {{domxref("WritableStream")}} for writing outgoing data.
Expand Down
8 changes: 3 additions & 5 deletions files/en-us/web/api/webtransportbidirectionalstream/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@
title: WebTransportBidirectionalStream
slug: Web/API/WebTransportBidirectionalStream
page-type: web-api-interface
status:
- experimental
browser-compat: api.WebTransportBidirectionalStream
---

{{APIRef("WebTransport API")}}{{SeeCompatTable}}{{SecureContext_Header}}
{{APIRef("WebTransport API")}}{{SecureContext_Header}}

The **`WebTransportBidirectionalStream`** interface of the {{domxref("WebTransport API", "WebTransport API", "", "nocode")}} represents a bidirectional stream created by a server or a client that can be used for reliable transport. Provides access to a {{domxref("ReadableStream")}} for reading incoming data, and a {{domxref("WritableStream")}} for writing outgoing data.

Expand All @@ -17,9 +15,9 @@ The **`WebTransportBidirectionalStream`** interface of the {{domxref("WebTranspo

## Instance properties

- {{domxref("WebTransportBidirectionalStream.readable", "readable")}} {{ReadOnlyInline}} {{Experimental_Inline}}
- {{domxref("WebTransportBidirectionalStream.readable", "readable")}} {{ReadOnlyInline}}
- : Returns a {{domxref("ReadableStream")}} instance that can be used to read incoming data.
- {{domxref("WebTransportBidirectionalStream.writable", "writable")}} {{ReadOnlyInline}} {{Experimental_Inline}}
- {{domxref("WebTransportBidirectionalStream.writable", "writable")}} {{ReadOnlyInline}}
- : Returns a {{domxref("WritableStream")}} instance that can be used to write outgoing data.

## Examples
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@ title: "WebTransportBidirectionalStream: readable property"
short-title: readable
slug: Web/API/WebTransportBidirectionalStream/readable
page-type: web-api-instance-property
status:
- experimental
browser-compat: api.WebTransportBidirectionalStream.readable
---

{{APIRef("WebTransport API")}}{{SeeCompatTable}}{{SecureContext_Header}}
{{APIRef("WebTransport API")}}{{SecureContext_Header}}

The **`readable`** read-only property of the {{domxref("WebTransportBidirectionalStream")}} interface returns a {{domxref("ReadableStream")}} instance that can be used to reliably read incoming data.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@ title: "WebTransportBidirectionalStream: writable property"
short-title: writable
slug: Web/API/WebTransportBidirectionalStream/writable
page-type: web-api-instance-property
status:
- experimental
browser-compat: api.WebTransportBidirectionalStream.writable
---

{{APIRef("WebTransport API")}}{{SeeCompatTable}}{{SecureContext_Header}}
{{APIRef("WebTransport API")}}{{SecureContext_Header}}

The **`writable`** read-only property of the {{domxref("WebTransportBidirectionalStream")}} interface returns a {{domxref("WritableStream")}} instance that can be used to write outgoing data.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@ title: "WebTransportDatagramDuplexStream: incomingHighWaterMark property"
short-title: incomingHighWaterMark
slug: Web/API/WebTransportDatagramDuplexStream/incomingHighWaterMark
page-type: web-api-instance-property
status:
- experimental
browser-compat: api.WebTransportDatagramDuplexStream.incomingHighWaterMark
---

{{APIRef("WebTransport API")}}{{SeeCompatTable}}{{SecureContext_Header}}
{{APIRef("WebTransport API")}}{{SecureContext_Header}}

The **`incomingHighWaterMark`** property of the {{domxref("WebTransportDatagramDuplexStream")}} interface gets or sets the high water mark for incoming chunks of data — this is the maximum size, in chunks, that the incoming {{domxref("ReadableStream")}}'s internal queue can reach before it is considered full. See [Internal queues and queuing strategies](/en-US/docs/Web/API/Streams_API/Concepts#internal_queues_and_queuing_strategies) for more information.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@ title: "WebTransportDatagramDuplexStream: incomingMaxAge property"
short-title: incomingMaxAge
slug: Web/API/WebTransportDatagramDuplexStream/incomingMaxAge
page-type: web-api-instance-property
status:
- experimental
browser-compat: api.WebTransportDatagramDuplexStream.incomingMaxAge
---

{{APIRef("WebTransport API")}}{{SeeCompatTable}}{{SecureContext_Header}}
{{APIRef("WebTransport API")}}{{SecureContext_Header}}

The **`incomingMaxAge`** property of the {{domxref("WebTransportDatagramDuplexStream")}} interface gets or sets the maximum age for incoming datagrams, in milliseconds.

Expand Down
Loading

0 comments on commit 341eecc

Please sign in to comment.