Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

RTCRtpCodecParameters - removal - merge into where it is used #34150

Merged
merged 9 commits into from
Jun 17, 2024
Merged

RTCRtpCodecParameters - removal - merge into where it is used #34150

merged 9 commits into from
Jun 17, 2024

Conversation

hamishwillee
Copy link
Collaborator

@hamishwillee hamishwillee commented Jun 14, 2024 •
edited
Loading

This merges RTCRtpCodecParameters into the places where it is used - RTCRtpReceiver.getParameters(), RTCRtpSender.getParameters(), RTCRtpTransceiver.setCodecPreferences(), RTCRtpSender: setParameters() (and then deletes it).

This is part of "getting docs to standard" for #33988

@github-actions github-actions bot added the Content:WebAPI Web API docs label Jun 14, 2024
@hamishwillee hamishwillee mentioned this pull request Jun 14, 2024
Closed
8 tasks
@github-actions github-actions bot added the size/m [PR only] 51-500 LoC changed label Jun 14, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 14, 2024 •
edited
Loading

Preview URLs (11 pages)
Flaws (25)

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

URL: /en-US/docs/Web/API/RTCCodecStats/payloadType
Title: RTCCodecStats: payloadType property
Flaw count: 4

  • macros:
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters
  • broken_links:
    • Anchor not lowercase
    • Anchor not lowercase
    • Anchor not lowercase

URL: /en-US/docs/Web/API/RTCCodecStats/clockRate
Title: RTCCodecStats: clockRate property
Flaw count: 5

  • macros:
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters
  • broken_links:
    • Anchor not lowercase
    • Anchor not lowercase
    • Anchor not lowercase
    • Anchor not lowercase

URL: /en-US/docs/Web/API/RTCCodecStats/sdpFmtpLine
Title: RTCCodecStats: sdpFmtpLine property
Flaw count: 5

  • macros:
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters
  • broken_links:
    • Anchor not lowercase
    • Anchor not lowercase
    • Anchor not lowercase
    • Anchor not lowercase

URL: /en-US/docs/Web/API/RTCCodecStats/mimeType
Title: RTCCodecStats: mimeType property
Flaw count: 5

  • macros:
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters
  • broken_links:
    • Anchor not lowercase
    • Anchor not lowercase
    • Anchor not lowercase
    • Anchor not lowercase

URL: /en-US/docs/Web/API/RTCCodecStats/channels
Title: RTCCodecStats: channels property
Flaw count: 1

  • macros:
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters

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

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

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

  • macros:
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters

URL: /en-US/docs/Web/API/RTCRtpTransceiver/setCodecPreferences
Title: RTCRtpTransceiver: setCodecPreferences() method
Flaw count: 1

  • macros:
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters

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

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

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

  • macros:
    • /en-US/docs/Web/API/RTCRtcpParameters does not exist
External URLs (5)

URL: /en-US/docs/Web/API/RTCRtpReceiver/getParameters
Title: RTCRtpReceiver: getParameters() method

URL: /en-US/docs/Web/API/RTCRtpTransceiver/setCodecPreferences
Title: RTCRtpTransceiver: setCodecPreferences() method

URL: /en-US/docs/Web/API/RTCRtpSender/getParameters
Title: RTCRtpSender: getParameters() method

URL: /en-US/docs/Web/API/RTCRtpSender/setParameters
Title: RTCRtpSender: setParameters() method

(comment last updated: 2024-06-17 04:04:03)

hamishwillee
hamishwillee commented Jun 14, 2024
View reviewed changes
files/en-us/web/api/rtcrtpreceiver/getparameters/index.md
- : An array of {{domxref("RTCRtpCodecParameters")}} objects describing the set of codecs from which the sender or receiver will choose.

- : An array of objects describing the [media codecs](/en-US/docs/Web/Media/Formats/WebRTC_codecs) that the receiver is ready to use.
This is the subset of codecs that the receiver has indicated it prefers and that the remote endpoint has indicated it is prepared to send.
This parameter cannot be changed once initially set.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line predates me - I'm not sure what it actually means.

@hamishwillee hamishwillee marked this pull request as ready for review June 17, 2024 04:02
@hamishwillee hamishwillee requested review from a team as code owners June 17, 2024 04:02
@hamishwillee hamishwillee requested review from sideshowbarker and removed request for a team June 17, 2024 04:02
@hamishwillee hamishwillee mentioned this pull request Jun 17, 2024
Closed
8 tasks
@sideshowbarker sideshowbarker merged commit e82d46f into mdn:main Jun 17, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sideshowbarker sideshowbarker sideshowbarker approved these changes

Assignees
No one assigned
Labels
Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@hamishwillee @sideshowbarker