Skip to content
This repository was archived by the owner on Oct 25, 2024. It is now read-only.

Commit c2778d6

Browse files
authored
Update doc for WebTransport. (#463)
1 parent f694e27 commit c2778d6

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

docs/design/webtransport.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22

33
## Introduction
44

5-
This post describes changes to OWT JavaScript SDK to support QuicTransport of WebTransport. Other APIs defined in WebTransport might be supported in the future. QuicTransport is only supported in conference mode as an experimental feature.
5+
This post describes changes to OWT JavaScript SDK to support WebTransport. WebTransport is only supported in conference mode as an experimental feature.
6+
7+
The current implementation is based on QuicTransport, which was removed from WebTransport spec. Following changes will move to HTTP3 based WebTransport.
68

79
## API Changes
810

9-
Following APIs will be changed to support QuicTransport.
11+
Following APIs will be changed to support WebTransport.
1012

1113
- `LocalStream` can be constructed with a `WritableStream`.
1214
- `RemoteStream` can be constructed with a `ReadableStream`.
@@ -16,7 +18,7 @@ Following APIs will be changed to support QuicTransport.
1618

1719
## Internal Changes
1820

19-
JavaScript SDK creates a QuicTransport with a QUIC agent when QUIC agent is enabled at server side, and WebTransport is supported at client side. When app publishes or subscribes a data stream, a new QuicStream is created.
21+
JavaScript SDK creates a WebTransport with a QUIC agent when QUIC agent is enabled at server side, and WebTransport is supported at client side. When app publishes or subscribes a data stream, a new `BidirectionalStream` is created.
2022

2123
## Limitations
2224

docs/mdfiles/index.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ Open WebRTC Toolkit Client SDK for JavaScript provides tools to help you develop
66

77
Refer to the SDK release notes for the latest information on the SDK release package, including features, supported browsers, bug fixes, and known issues.
88

9-
Please include `adapter.js` before `owt.js` in HTML files. `adapter.js` is an open source project hosted on [Github](https://github.com/webrtc/adapter). The revision we depend on is `7.0.0`.
10-
119
If you want to use conference SDK, please also include `socket.io.js` before `owt.js`.
1210

1311
# 2 Browser requirement
@@ -53,7 +51,6 @@ To enable P2P chat, copy and paste the following code into the head section of y
5351
~~~~~~{.js}
5452
<script type="text/JavaScript" src="socket.io.js"></script>
5553
<script type="text/JavaScript" src="sc.websocket.js"></script>
56-
<script type="text/JavaScript" src="adapter.js"></script>
5754
<script type="text/JavaScript" src="owt.js"></script>
5855
~~~~~~
5956
If you're using customized signling channel, please replace `socket.io.js` and `sc.websocket.js` with your own signaling channel implementation.
@@ -73,7 +70,6 @@ In the customized signaling channel, you need to implement `connect`, `disconnec
7370
Conference mode is designed for applications with multiple participants through MCU conference server. To enable conference chat, copy and paste the following code into the head section of your HTML document:
7471
~~~~~~{.js}
7572
<script type="text/javascript" src="socket.io.js"></script>
76-
<script type="text/javascript" src="adapter.js"></script>
7773
<script type="text/javascript" src="owt.js"></script>
7874
~~~~~~
7975

@@ -146,11 +142,17 @@ a. The simulcast stream published to conference won't be transcoded.
146142
b. The `rid` attribute may not be present once a 'streamadded' event triggered. Users should listen on stream's `updated` event for new `rid` added.
147143
c. Current browsers support VP8 simulcast well while H.264 simulcast has some limitations.
148144

149-
# 6 Events
145+
# 6 WebTransport
146+
WebTransport is supported in conference mode as an experimental feature. QUIC agent on server side is not enabled by default. Please refer to following links for more information.
147+
148+
- [JavaScript SDK design doc for WebTransport support](https://github.com/open-webrtc-toolkit/owt-client-javascript/blob/master/docs/design/webtransport.md)
149+
- [QUIC programming guide for OWT server](https://github.com/open-webrtc-toolkit/owt-server/blob/master/doc/design/quic-programming-guide.md)
150+
151+
# 7 Events
150152

151153
The JavaScript objects fires events using `Owt.Base.EventDispatchers`. For more detailed events, please refer to the specific class description page.
152154

153-
# 7 Privacy and security
155+
# 8 Privacy and security
154156
SDK will send operation system's name and version, browser name, version and abilities, SDK name and version to conference server and P2P endpoints it tries to make connection. SDK does not store this information on disk.
155157

156158
**Note:** \* Other names and brands may be claimed as the property of others.

0 commit comments

Comments
 (0)