RTCRtpReceiver.getParameters() and friends - return value not dict by hamishwillee · Pull Request #24503 · mdn/content

hamishwillee · 2023-02-17T01:56:25Z

This continues the work started in #24239 of removing the dictionaries RTCRtpParameter, RTCRtpReceiveParameters, RTCRtpSendParameters in
RTCRtpReceiver.setParameters(), RTCRtpReceiver.getParameters(), RTCRtpReceiver.setParameters() replacing them with objects.

The associated work for BCD has already been done in mdn/browser-compat-data#18834

This is part of the work for #23677

github-actions · 2023-02-17T01:59:02Z

Preview URLs (8 pages)

Flaws (15)

Note! 1 document with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/RTCRtpEncodingParameters
Title: RTCRtpEncodingParameters
Flaw count: 4

macros:
- /en-US/docs/Web/API/RTCRtpEncodingParameters/active does not exist
- /en-US/docs/Web/API/RTCRtpEncodingParameters/dtx does not exist
- /en-US/docs/Web/API/RTCRtpEncodingParameters/rid does not exist
- /en-US/docs/Web/API/RTCRtpDecodingParameters does not exist

URL: /en-US/docs/Web/API/RTCRtpCodecParameters
Title: RTCRtpCodecParameters
Flaw count: 5

macros:
- /en-US/docs/Web/API/RTCRtpCodecParameters/payloadType does not exist
- /en-US/docs/Web/API/RTCRtpCodecParameters/mimeType does not exist
- /en-US/docs/Web/API/RTCRtpCodecParameters/clockRate does not exist
- /en-US/docs/Web/API/RTCRtpCodecParameters/channels does not exist
- /en-US/docs/Web/API/RTCRtpCodecParameters/sdpFmtpLine does not exist

URL: /en-US/docs/Web/API/RTCRtpSender/getParameters
Title: RTCRtpSender.getParameters()
Flaw count: 1

macros:
- /en-US/docs/Web/API/RTCRtcpParameters does not exist

URL: /en-US/docs/Web/API/RTCRtpSender/setParameters
Title: RTCRtpSender.setParameters()
Flaw count: 1

macros:
- /en-US/docs/Web/API/RTCRtcpParameters does not exist

URL: /en-US/docs/Web/API/RTCRtpReceiver
Title: RTCRtpReceiver
Flaw count: 1

macros:
- /en-US/docs/Web/API/RTCRtpSynchronizationSource redirects to /en-US/docs/Web/API/RTCRtpReceiver/getSynchronizationSources

URL: /en-US/docs/Web/API/RTCRtpReceiver/getParameters
Title: RTCRtpReceiver.getParameters()
Flaw count: 1

macros:
- /en-US/docs/Web/API/RTCRtcpParameters does not exist

URL: /en-US/docs/Web/Media/Formats/WebRTC_codecs
Title: Codecs used by WebRTC
Flaw count: 2

macros:
- /en-US/docs/Web/API/MediaStreamTrack/track does not exist
- /en-US/docs/Web/API/RTCRtpCodecParameters/payloadType does not exist

(comment last updated: 2023-02-24 03:10:35)

hamishwillee · 2023-02-17T04:06:42Z

files/en-us/web/api/rtcrtpsender/getparameters/index.md

+- `rtcp`
+  - : An {{domxref("RTCRtcpParameters")}} object providing the configuration parameters used for {{Glossary("RTCP")}} on the sender or receiver.
+    This parameter cannot be changed once initially set.
+- `degradationPreference` {{deprecated_inline}} {{optional_inline}} <!-- removed from spec. May have been or be in chrome -->


FYI, I made the objects from the get call match the objects in the set call. This degradationPreference was revoked from spec and is not in BCD, but may be in some versions of chrome.

There was a priority field I removed because it never had an impl..

teoli2003 · 2023-02-17T06:18:06Z

files/en-us/_wikihistory.json

      "asadotzler"
    ]
  },
+  "Web/API/Document_object_model/Using_the_Document_Object_Model": {


Side comment, I wonder why this is in this PR...

Ok, it is lexicographic ordering fix. I will investigate this in a separate PR. This is harmless.

teoli2003 · 2023-02-17T06:38:46Z

Still a small redirect problem (orphaned pages) to fix and this is good to go.

github-actions · 2023-02-19T12:07:29Z

This pull request has merge conflicts that must be resolved before it can be merged.

github-actions · 2023-02-19T12:07:29Z

This pull request has merge conflicts that must be resolved before it can be merged.

hamishwillee · 2023-02-20T00:56:34Z

@teoli2003 Thanks for the review. I have rebased. Can I ignore the build error about redirects ... and if not, how to I fix this? I did the redirects in the "normal" way using the redirect option when deleting.

files/en-us/_redirects.txt

…ont create

hamishwillee · 2023-02-20T23:32:13Z

@teoli2003 The redirects from this are definitely correct - i.e. the message says the files don't exist, but they most definitely do. Further I used the proper tools to create these redirects so I'm not sure what else I can do.

I think it might be a lint issue. OK to merge this and see if it breaks anything?

bsmth · 2023-02-22T12:17:55Z

It looks like there's an issue with this one:

yarn content fix-redirects en-us
removing orphaned redirect (from exists): /en-US/docs/Web/API/RTCRtpParameters  /en-US/docs/Web/API/RTCRtpSender/setParameters
info: Fixed en-us

yarn content validate-redirects en-us --strict
info: ✓ redirects for en-us looking good!
info: 🍾 All is well in the world of redirects 🥂

bsmth · 2023-02-22T12:19:45Z

Shall we remove this line in the redirect (using yarn content fix-redirects en-us) then add a redirect in a follow-up PR?

bsmth · 2023-02-22T12:45:14Z

The problem is we're adding a redirect from a page that exists:

https://github.com/mdn/content/blob/RTCRtpReceiver_getParameters/files/en-us/web/api/rtcrtpparameters/index.md?plain=1#L3

hamishwillee · 2023-02-24T02:58:27Z

@bsmth That shouldn't be the problem because this PR deletes that file. Though as you say, that is what is reported. I'm going to remove the redirects from this PR, merge, and recreate them in another.

github-actions bot added the Content:WebAPI Web API docs label Feb 17, 2023

github-actions bot added the Content:Media Media docs label Feb 17, 2023

hamishwillee commented Feb 17, 2023

View reviewed changes

hamishwillee marked this pull request as ready for review February 17, 2023 04:07

hamishwillee requested review from a team as code owners February 17, 2023 04:07

hamishwillee requested review from wbamberg and removed request for a team February 17, 2023 04:07

This was referenced Feb 17, 2023

[Web API] Updates to WebRTC RTCRtpParameters.set(get)Parameters etc #23677

Closed

Delete RTCRtpSendParameters dictionary mdn/browser-compat-data#18935

Merged

teoli2003 reviewed Feb 17, 2023

View reviewed changes

teoli2003 approved these changes Feb 17, 2023

View reviewed changes

github-actions bot added the rebase needed 🚧 label Feb 19, 2023

hamishwillee force-pushed the RTCRtpReceiver_getParameters branch from 8c8375e to b2ebec8 Compare February 20, 2023 00:50

github-actions bot removed the rebase needed 🚧 label Feb 20, 2023

hamishwillee commented Feb 20, 2023

View reviewed changes

files/en-us/_redirects.txt Outdated Show resolved Hide resolved

hamishwillee force-pushed the RTCRtpReceiver_getParameters branch from f4ad41a to fd8aa86 Compare February 20, 2023 23:17

hamishwillee requested review from a team and schalkneethling as code owners February 20, 2023 23:17

hamishwillee removed the request for review from a team February 20, 2023 23:17

github-actions bot added Content:Learn Learning area docs Content:Other Any docs not covered by another "Content:" label Content:wasm WebAssembly docs labels Feb 20, 2023

hamishwillee added 8 commits February 21, 2023 10:19

RTCRtpReceiver.getParameters() - return object not dict

4045d3c

RTCRtpSender.getParameters() remove links to sub topics we probably w…

54ba614

…ont create

Remove/redirect RTCRtpReceiveParameters

6af38db

RTCRtpSender.set/getParameters() - check spec and make corrct

7d2b1a5

Remove RTCRtpSendParameters dictionary

f42b14b

Remove mentions of RTCRtpSendParameters

f8ef9a2

Delete RTCRtpParameters

944fc2f

Remove cross links to RTCRtpParameters (deleted)

91bb4d5

hamishwillee force-pushed the RTCRtpReceiver_getParameters branch from fd8aa86 to 91bb4d5 Compare February 20, 2023 23:19

Try fix up the redirects

5619f85

Remove orphaned redirect

46b3abb

hamishwillee merged commit c18578d into main Feb 24, 2023

hamishwillee deleted the RTCRtpReceiver_getParameters branch February 24, 2023 03:14

bsmth mentioned this pull request Feb 24, 2023

chore(rtc): delete RTCRtpParameters with redirect to RTCRtpSender/setParameters #24836

Merged

Conversation

hamishwillee commented Feb 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Feb 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hamishwillee Feb 17, 2023

Choose a reason for hiding this comment

Uh oh!

teoli2003 Feb 17, 2023

Choose a reason for hiding this comment

Uh oh!

teoli2003 Feb 17, 2023

Choose a reason for hiding this comment

Uh oh!

teoli2003 commented Feb 17, 2023

Uh oh!

github-actions bot commented Feb 19, 2023

Uh oh!

github-actions bot commented Feb 19, 2023

Uh oh!

hamishwillee commented Feb 20, 2023

Uh oh!

Uh oh!

hamishwillee commented Feb 20, 2023

Uh oh!

bsmth commented Feb 22, 2023

Uh oh!

bsmth commented Feb 22, 2023

Uh oh!

bsmth commented Feb 22, 2023

Uh oh!

hamishwillee commented Feb 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

hamishwillee commented Feb 17, 2023 •

edited

Loading

github-actions bot commented Feb 17, 2023 •

edited

Loading

hamishwillee commented Feb 24, 2023 •

edited

Loading