Skip to content

RTCRtpSender.get/setParameters - encodings.codec property #40629

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

hamishwillee
Copy link
Collaborator

FF142 adds support for the dictionary property RTCRtpEncodingParameters.codec in https://bugzilla.mozilla.org/show_bug.cgi?id=1894137

This is used when setting encodings in RTCRtpSender.setParameters(parameter.encodings) and RTCPeerConnection.addTransceiver(sendencodings), and returned in RTCRtpSender/getParameters() (encodings.codec).

This updates the set/getParameters on the sender. The transceiver just references the sender, so doesn't need an update.

Related docs work can be tracked in #40477

@hamishwillee hamishwillee requested a review from a team as a code owner August 5, 2025 01:26
@hamishwillee hamishwillee requested review from wbamberg and removed request for a team August 5, 2025 01:26
@github-actions github-actions bot added Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed labels Aug 5, 2025

The object may have the following properties: <!-- RTCRtcpParameters -->
- `cname`
- : A read-only string giving the canonical name (CNAME) used by RTCP (e.g. in SDES messages).
Copy link
Contributor

Choose a reason for hiding this comment

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

[mdn-linter] reported by reviewdog 🐶

Suggested change
- : A read-only string giving the canonical name (CNAME) used by RTCP (e.g. in SDES messages).
- : A read-only string giving the canonical name (CNAME) used by RTCP (e.g., in SDES messages).


The object may have the following properties: <!-- RTCRtcpParameters -->
- `cname`
- : A read-only string giving the canonical name (CNAME) used by RTCP (e.g. in SDES messages).
Copy link
Contributor

Choose a reason for hiding this comment

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

[mdn-linter] reported by reviewdog 🐶

Suggested change
- : A read-only string giving the canonical name (CNAME) used by RTCP (e.g. in SDES messages).
- : A read-only string giving the canonical name (CNAME) used by RTCP (e.g., in SDES messages).

@@ -32,6 +32,29 @@ An object indicating the current configuration of the sender. <!-- RTCRtpSendPar
- `active`
- : `true` (the default) if the encoding is being sent, `false` if it is not being sent or used.

- `codec` {{optional_inline}}
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

FYI This is the same type of object as used in the following codecs array except that has a payload type as well. Decided not to update that one to say "this is the same as codec + payload type".

@@ -96,8 +119,15 @@ An object indicating the current configuration of the sender. <!-- RTCRtpSendPar
- : An array of zero or more RTP header extensions, each identifying an extension supported by the sender or receiver. Header extensions are described in {{RFC(3550, "", "5.3.1")}}.
This parameter cannot be changed once initially set.
- `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.
- : An object providing the configuration parameters used for {{Glossary("RTCP")}} on the sender.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Decided to fix up missing object while here.

Copy link
Contributor

github-actions bot commented Aug 5, 2025

Preview URLs

External URLs (2)

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


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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant