Remove RTCOfferAnswerOptions and RTC[Offer/Answer]Options from MDN #9748

queengooborg · 2021-10-12T11:44:10Z

This PR removes the documentation for the RTCOfferAnswerOptions, RTCOfferOptions, and RTCAnswerOptions dictionaries from MDN, folding their data into the two respective methods that use it. Correlates with its removal in BCD, see mdn/browser-compat-data#12819.

github-actions · 2021-10-12T11:46:04Z

Preview URLs

Flaws

Note! 2 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/RTCPeerConnection/createAnswer
Title: RTCPeerConnection.createAnswer()
on GitHub
Flaw count: 2

macros:
- /en-US/docs/Web/API/RTCSessionDescriptionInit does not exist
broken_links:
- Can't resolve /en-US/docs/Web/API/WebSocket_API

URL: /en-US/docs/Web/API/RTCPeerConnection/createOffer
Title: RTCPeerConnection.createOffer()
on GitHub
Flaw count: 3

macros:
- /en-US/docs/Web/API/RTCSessionDescriptionInit does not exist
- /en-US/docs/Web/API/RTCSessionDescriptionInit does not exist
broken_links:
- Can't resolve /en-US/docs/Web/API/WebSocket_API

URL: /en-US/docs/Web/API/WebRTC_API/Using_DTMF
Title: Using DTMF with WebRTC
on GitHub
Flaw count: 4

macros:
- /en-US/docs/Web/API/MediaConstraints does not exist
- /en-US/docs/Web/API/RTCPeerConnection/createDTMFSender does not exist
- /en-US/docs/Web/API/RTCPeerConnection/getTracks does not exist
- /en-US/docs/Web/API/RTCTrackEvent/stream does not exist

URL: /en-US/docs/Mozilla/Firefox/Releases/43
Title: Firefox 43 for developers
on GitHub
Flaw count: 7

macros:
- /en-US/docs/Web/API/PerformanceRenderTiming does not exist
- /en-US/docs/Web/API/PerformanceCompositeTiming does not exist
- /en-US/docs/Web/API/Screen/mozOrientation does not exist
- /en-US/docs/Web/API/Screen/onmozorientationchange does not exist
- /en-US/docs/Web/API/Screen/mozLockOrientation does not exist
- and 1 more flaws omitted
broken_links:
- Can't resolve /en-US/docs/Web/API/Performance_Timeline_API

URL: /en-US/docs/Mozilla/Firefox/Releases/33
Title: Firefox 33 for developers
on GitHub
Flaw count: 8

macros:
- /en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toInteger does not exist
- /en-US/docs/Web/API/IDBFileHandle does not exist
broken_links:
- Can't resolve /en-US/docs/Mozilla/Add-ons/Code_snippets/JavaScript_Debugger_Service
- Can't resolve /en-US/docs/Mozilla/Add-ons/SDK/High-Level_APIs/panel#panel(options)
- Can't resolve /en-US/docs/Mozilla/Add-ons/SDK/High-Level_APIs/tabs#readystate
- Can't resolve /en-US/docs/Mozilla/Add-ons/SDK/High-Level_APIs/windows#browserwindow
- Can't resolve /en-US/docs/Mozilla/Add-ons/SDK/Low-Level_APIs/ui_sidebar#show(window)
- and 1 more flaws omitted

URL: /en-US/docs/Mozilla/Firefox/Releases/44
Title: Firefox 44 for developers
on GitHub
Flaw count: 23

macros:
- /en-US/docs/Web/CSS/-moz-math-display does not exist
- /en-US/docs/Web/CSS/-moz-window-shadow does not exist
- /en-US/docs/Web/CSS/@page/marks does not exist
- /en-US/docs/Web/CSS/page does not exist
- /en-US/docs/Web/CSS/size does not exist
- and 11 more flaws omitted
broken_links:
- Can't resolve /en-US/docs/Mozilla/Projects/SpiderMonkey/Introduction_to_the_JavaScript_shell
- Can't resolve /en-US/docs/Web/HTML/Using_the_application_cache
- Can't resolve /en-US/docs/Mozilla/Add-ons/Firefox_for_Android/API/Snackbars.jsm
- Can't resolve /en-US/docs/Mozilla/Firefox_for_Android
- Can't resolve /en-US/docs/Mozilla/Add-ons/SDK/Tools/cfx
- and 2 more flaws omitted

URL: /en-US/docs/Mozilla/Firefox/Releases/42
Title: Firefox 42 for developers
on GitHub
Flaw count: 9

macros:
- /en-US/docs/Web/API/HTMLInputElement/directory does not exist
- /en-US/docs/Web/API/HTMLInputElement/isFilesAndDirectoriesSupported does not exist
- /en-US/docs/Web/API/HTMLInputElement/getFilesAndDirectories does not exist
- /en-US/docs/Web/API/HTMLInputElement/chooseDirectory does not exist
- /en-US/docs/Web/API/Directory does not exist
- and 2 more flaws omitted
broken_links:
- Can't resolve /en-US/docs/Tools/WebIDE/Setting_up_runtimes#Configuring_Simulators
- Can't resolve /en-US/docs/Mozilla/Tech/XPCOM/Reference/Interface/nsIContentPolicy

URL: /en-US/docs/Mozilla/Firefox/Releases/48
Title: Firefox 48 for developers
on GitHub
Flaw count: 19

macros:
- /en-US/docs/Web/HTML/Element/referrer does not exist
- /en-US/docs/Web/API/@supports does not exist
- /en-US/docs/Web/API/NavigatorConcurrentHardware redirects to /en-US/docs/Web/API/Navigator
- /en-US/docs/Web/API/NavigatorConcurrentHardware/hardwareConcurrency redirects to /en-US/docs/Web/API/Navigator/hardwareConcurrency
- /en-US/docs/Web/API/MozContact does not exist
- and 11 more flaws omitted
broken_links:
- Can't resolve /en-US/docs/Archive/Web/Old_Proxy_API
- Can't resolve /en-US/docs/Mozilla/Projects/Social_API/Service_worker_API_reference
- Can't resolve /en-US/docs/Mozilla/Gecko/Chrome/CSS/-moz-bool-pref

URL: /en-US/docs/Mozilla/Firefox/Releases/55
Title: Firefox 55 for developers
on GitHub
Flaw count: 7

macros:
- /en-US/docs/Web/CSS/linear-gradient() redirects to /en-US/docs/Web/CSS/gradient/linear-gradient()
- /en-US/docs/Web/API/DOMString/href does not exist
- /en-US/docs/Web/API/WindowProxy does not exist
- /en-US/docs/Web/API/MediaKeySystemCapabilities does not exist
broken_links:
- Can't resolve /en-US/docs/Mozilla/Security/Security_and_the_jar_protocol
- Can't resolve /en-US/docs/Mozilla/Firefox/Headless_mode
- Can't resolve /en-US/docs/Archive/B2G_OS/API/Audio_Channels_API

External URLs

URL: /en-US/docs/Web/API/RTCRtpReceiver/getSynchronizationSources
Title: RTCRtpReceiver.getSynchronizationSources()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/RTCPeerConnection/createAnswer
Title: RTCPeerConnection.createAnswer()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/RTCPeerConnection/createOffer
Title: RTCPeerConnection.createOffer()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/WebRTC_API/Perfect_negotiation
Title: Establishing a connection: The WebRTC perfect negotiation pattern
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/WebRTC_API/Using_DTMF
Title: Using DTMF with WebRTC
on GitHub

No new external URLs

URL: /en-US/docs/Mozilla/Firefox/Releases/43
Title: Firefox 43 for developers
on GitHub

No new external URLs

URL: /en-US/docs/Mozilla/Firefox/Releases/33
Title: Firefox 33 for developers
on GitHub

No new external URLs

URL: /en-US/docs/Mozilla/Firefox/Releases/44
Title: Firefox 44 for developers
on GitHub

No new external URLs

URL: /en-US/docs/Mozilla/Firefox/Releases/42
Title: Firefox 42 for developers
on GitHub

No new external URLs

URL: /en-US/docs/Mozilla/Firefox/Releases/48
Title: Firefox 48 for developers
on GitHub

No new external URLs

URL: /en-US/docs/Mozilla/Firefox/Releases/55
Title: Firefox 55 for developers
on GitHub

No new external URLs

(this comment was updated 2021-10-22 06:53:45.150554)

wbamberg

I can't find any reference to voiceActivityDetection in the specification: https://w3c.github.io/webrtc-pc/#offer-answer-options . (It looks like it has been removed: https://www.w3.org/TR/2019/CR-webrtc-20191213/)

It looks like:

RTCOfferAnswerOptions (the base object) is an empty object
RTCAnswerOptions is an empty object
RTCOfferOptions contains a single boolean iceRestart

So effectively:

RTCPeerConnection.createAnswer() doesn't accept any options (I mean, I guess you can pass an empty object, but...)
RTCPeerConnection.createOffer() accepts an object with a single property iceRestart, which is a boolean defaulting to false (I think the description of this property should explicitly note that it's a boolean, which they don't currently do).

Rumyra · 2021-10-21T16:02:36Z

Hey - just wondering what the status of this pr is currently. I'm about to convert the firefox folder to markdown and this touches a few of those files. Let me know - I can help fix it up if there's no more feedback on it 👍

wbamberg · 2021-10-21T16:14:58Z

Sorry, I've been slow re-reviewing this but will get to it today.

wbamberg

Thanks for the updates, @queengooborg , and sorry to be slow reviewing. Just a couple of other bits.

files/en-us/web/api/rtcpeerconnection/createanswer/index.md

files/en-us/web/api/rtcrtpsynchronizationsource/voiceactivityflag/index.md

wbamberg · 2021-10-21T16:49:32Z

files/en-us/web/api/webrtc_api/using_dtmf/index.md

@@ -106,7 +106,7 @@ These are, in order:
 - `mediaConstraints`
  - : An object conforming to the {{domxref("MediaConstraints")}} dictionary specifying the constraints to use when starting the connection. We want an audio-only connection, so `video` is `false`, while `audio` is `true`.
 - `offerOptions`
-  - : An `RTCOfferOptions` object providing options to specify when calling {{domxref("RTCPeerConnection.createOffer()")}}. In this case, we state that we want to receive audio but not video.
+  - : An object object providing options to specify when calling {{domxref("RTCPeerConnection.createOffer()")}}. In this case, we state that we want to receive audio but not video.


It looks like this is using the "legacy properties" I think it is out of scope to fix it in this PR but we should file a follow-up issue.

Co-authored-by: wbamberg <will@bootbonnet.ca>

wbamberg

OK, this looks great now. Thanks for all your work on it @queengooborg !

Remove RTCOfferAnswerOptions and RTC[Offer/Answer]Options from MDN

64c1ad8

queengooborg requested a review from a team October 12, 2021 11:44

queengooborg requested review from a team as code owners October 12, 2021 11:44

queengooborg requested review from schalkneethling and wbamberg and removed request for a team October 12, 2021 11:44

github-actions bot added Content:Other Any docs not covered by another "Content:" label Content:WebAPI Web API docs labels Oct 12, 2021

wbamberg reviewed Oct 16, 2021

View reviewed changes

Remove reference to voiceActivityDetection

c7fbee5

wbamberg requested changes Oct 21, 2021

View reviewed changes

queengooborg and others added 8 commits October 21, 2021 23:18

Update files/en-us/web/api/rtcpeerconnection/createanswer/index.md

b8437a0

Co-authored-by: wbamberg <will@bootbonnet.ca>

Remove RTCRTPSynchronizationSource dictionary from MDN

a5cba60

Remove references to RTCRtpSynchronizationSource

b3baca4

Fix capitalization

31ac8d1

Merge branch 'main' into RTCOfferAnswerOptions

1d88a8f

Fix redirects

8b6810c

Fix redirects (again)

a71046d

Fix redirects (finally)

c0fa05d

wbamberg approved these changes Oct 22, 2021

View reviewed changes

wbamberg merged commit d4275bf into mdn:main Oct 22, 2021

wbamberg mentioned this pull request Oct 22, 2021

"Using DTMF" is using legacy APIs #10020

Open

queengooborg deleted the RTCOfferAnswerOptions branch October 22, 2021 22:02

wbamberg mentioned this pull request Jan 19, 2022

Document missing RTCPeerConnection»createOffer params #12165

Merged

thegiantbeast mentioned this pull request Feb 17, 2022

Issue with "RTCPeerConnection.createOffer()": missing params #12164

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove RTCOfferAnswerOptions and RTC[Offer/Answer]Options from MDN #9748

Remove RTCOfferAnswerOptions and RTC[Offer/Answer]Options from MDN #9748

queengooborg commented Oct 12, 2021

github-actions bot commented Oct 12, 2021 •

edited

wbamberg left a comment •

edited

Rumyra commented Oct 21, 2021

wbamberg commented Oct 21, 2021

wbamberg left a comment

wbamberg Oct 21, 2021

wbamberg left a comment

Remove RTCOfferAnswerOptions and RTC[Offer/Answer]Options from MDN #9748

Remove RTCOfferAnswerOptions and RTC[Offer/Answer]Options from MDN #9748

Conversation

queengooborg commented Oct 12, 2021

github-actions bot commented Oct 12, 2021 • edited

Preview URLs

Flaws

External URLs

wbamberg left a comment • edited

Choose a reason for hiding this comment

Rumyra commented Oct 21, 2021

wbamberg commented Oct 21, 2021

wbamberg left a comment

Choose a reason for hiding this comment

wbamberg Oct 21, 2021

Choose a reason for hiding this comment

wbamberg left a comment

Choose a reason for hiding this comment

github-actions bot commented Oct 12, 2021 •

edited

wbamberg left a comment •

edited