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

Commit 2c9fb1f

Browse files
xiewenlong1202jianjunz
authored andcommitted
Merge to 4.2.x: remove describe for screensharing of Chrome (#165)
* remove describe for screensharing of Chrome * remove descriptions for firefox.
1 parent b92c85c commit 2c9fb1f

File tree

1 file changed

+6
-23
lines changed

1 file changed

+6
-23
lines changed

docs/mdfiles/index.md

Lines changed: 6 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -45,27 +45,10 @@ Safari support is limited. Not all functions work in Safari.
4545

4646
In P2P mode, only one stream per direction can be published between Firefox and other clients.
4747

48-
# 3 Screen sharing
49-
50-
## 3.1 Chrome
51-
We provide source code of a Chrome screen sharing extension sample. Developers should edit manifest.json and publish it to Chrome App Store to make it work for their products. After your extension is published, you will get an extension ID. This ID will be used when creating screen sharing stream.
52-
53-
> **Note:** End users need to install your extension and visit your site with https if they want to use screen sharing.
54-
55-
## 3.2 Firefox
56-
Screen sharing on Firefox requires following in `about:config`.
57-
58-
- `media.getusermedia.screensharing.enabled` is `true`.
59-
- `media.getusermedia.screensharing.allowed_domains` includes your domain name. (only needed before Firefox 52)
60-
61-
Developers can help end users to make these changes by Firefox extension.
62-
63-
> **Note:** End users need to visit your site with https if they want to use screen sharing.
64-
65-
# 4 NAT and firewall traversal
48+
# 3 NAT and firewall traversal
6649
Open WebRTC Toolkit Client SDK for JavaScript fully supports NAT and firewall traversal with STUN / TURN / ICE. The Coturn TURN server from https://github.com/coturn/coturn can be one choice.
6750

68-
# 5 Peer-to-peer (P2P) mode
51+
# 4 Peer-to-peer (P2P) mode
6952
To enable P2P chat, copy and paste the following code into the head section of your HTML document:
7053
~~~~~~{.js}
7154
<script type="text/JavaScript" src="socket.io.js"></script>
@@ -75,21 +58,21 @@ To enable P2P chat, copy and paste the following code into the head section of y
7558
~~~~~~
7659
If you're using customized signling channel, please replace `socket.io.js` and `sc.websocket.js` with your own signaling channel implementation.
7760

78-
## 5.1 P2P direct call chat
61+
## 4.1 P2P direct call chat
7962

8063
Direct call chat refers to the discovery of another client by chatting with that user's ID. This is a synchronous call and requires that the two clients should be online on the signaling server.
8164

82-
## 5.2 Customize signaling channel
65+
## 4.2 Customize signaling channel
8366

8467
Signaling channel is an implementation to transmit signaling data for creating a WebRTC session. Signaling channel for P2P sessions can be customized. You can pass your customized signaling channel to `P2PClient`'s constructor. The default Socket.IO signaling channel has been provided in the release package with a file named `sc.websocket.js`.
8568

8669
In the customized signaling channel, you need to implement `connect`, `disconnect` and `send`, invoke `onMessage` when a new message arrives, and invoke `onServerDisconnected` when the connection is lost. Then include your customized `sc.*.js` into the HTML page.
8770

88-
# 6 Events
71+
# 5 Events
8972

9073
The JavaScript objects fires events using `Ics.Base.EventDispatchers`. For more detailed events, please refer to the specific class description page.
9174

92-
# 7 Privacy and security
75+
# 6 Privacy and security
9376
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.
9477

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

0 commit comments

Comments
 (0)