Skip to content

Commit 9bdd58d

Browse files
committed
Update README.md
1 parent d15ea1b commit 9bdd58d

File tree

1 file changed

+30
-23
lines changed

1 file changed

+30
-23
lines changed

README.md

Lines changed: 30 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,26 @@
11
WebRTC Permissions UI Toggle
22
============================
33

4-
This is an extension for [SeaMonkey](http://www.seamonkey-project.org/) that
5-
toggles the **media.navigator.permission.disabled** setting on and off.
4+
This extension provides a UI to enable the WebRTC support in SeaMonkey. When
5+
you activate it (from a toolbar button or from the Tools menu in the browser),
6+
it does three things:
7+
8+
* Enables WebRTC (if currently disabled)
9+
* Turns on the setting `media.navigator.permission.disabled`, which allows
10+
all WebRTC connections without prompting
11+
* Checks the status of [OpenH264](http://www.openh264.org/); if it's enabled
12+
but not installed, the user will be asked if they want to install or disable it
13+
614
SeaMonkey does not have a permissions dialog to let the user select a camera
715
and microphone (see [bug 956854](https://bugzilla.mozilla.org/show_bug.cgi?id=956854)),
8-
so using this setting to override the dialog is the only way to enable WebRTC
9-
support.
16+
so using `media.navigator.permission.disabled` to override the dialog is the
17+
only way to enable WebRTC support.
1018

1119
Of course, leaving this setting on is insecure, since any web site that's open
1220
will be able to get access to your microphone, camera, and screen! So be sure
1321
to only turn it on when you need to use WebRTC, and turn it off once you're
1422
done with it.
1523

16-
Some versions of SeaMonkey might ship with WebRTC disabled by default.
17-
WebRTC Permissions UI Toggle 1.3.0+ will enable WebRTC while toggled on, and
18-
reset it to its original value when toggled off.
19-
2024
Instructions
2125
------------
2226

@@ -25,19 +29,30 @@ Instructions
2529
After you install the extension, you will need to restart SeaMonkey.
2630

2731
2. Before visiting a website that needs to use WebRTC, open the Tools menu and
28-
select "WebRTC Override." A box will appear asking if you want to share your
32+
select "Enable WebRTC." A box will appear asking if you want to share your
2933
camera, microphone, and screen with all open websites. Clicking OK will enable
3034
the override until you turn it off or close your browser.
3135

32-
3. If you are on a page that uses WebRTC and you have just enabled the
36+
3. If you do not have OpenH264 installed yet (and you haven't disabled it),
37+
the extension will offer to install it for you.
38+
39+
4. If you are on a page that uses WebRTC and you have just enabled the
3340
override, you may need to refresh the page for it to work.
3441

35-
Known Bugs
36-
----------
42+
Notes for Web Developers
43+
------------------------
3744

38-
* If toggling the override is configured to trigger a standard notification
39-
(the default), and you have windows open that were launched from JavaScript,
40-
the notification may appear outside of the top edge of the monitor.
45+
In SeaMonkey (2.49.1 and later), WebRTC is typically disabled, which means the
46+
`navigator.mediaDevices` object will be undefined. When this extension is
47+
activated, `navigator.mediaDevices` will be present.
48+
49+
In Firefox, the user is prompted to select a camera/microphone device. In
50+
SeaMonkey, however, the user's default camera/microphone will always be used
51+
unless you specify a device. `navigator.mediaDevices.enumerateDevices` will
52+
get you a list of devices, but the device labels will only be included if
53+
there is already an active `MediaStream` from `getUserMedia`. One possible
54+
workaround is to start a stream, grab the list of devices, and then stop the
55+
stream.
4156

4257
Notes
4358
-----
@@ -46,12 +61,4 @@ Closing the entire application, or disabling or removing the extension, will
4661
always turn off the override. If you want, you can also have it turn off
4762
whenever a new browser window is opened.
4863

49-
Your first camera/screen/etc. will be chosen automatically. If you need to
50-
select a particular camera, mic, screen, or window to share, you'll
51-
have to use another web browser (like Firefox.)
52-
53-
Sites that use H.264 as a video codec instead of VP8 might not work properly
54-
in SeaMonkey 2.49.x. This problem is not specific to SeaMonkey; Firefox 52 ESR
55-
has the same issue.
56-
5764
If the SeaMonkey Add-ons site is down, check the [Releases](https://github.com/IsaacSchemm/webrtc-permissions-ui-toggle/releases) section on GitHub for the most recent .xpi file.

0 commit comments

Comments
 (0)