diff --git a/index.html b/index.html index dd1f238..42696ae 100644 --- a/index.html +++ b/index.html @@ -359,12 +359,38 @@

additional members to control audio packetization.

partial dictionary RTCRtpEncodingParameters {
-  unsigned long ptime;
-  boolean adaptivePtime = false;
+    RTCResolutionRestriction scaleResolutionDownTo;
+    unsigned long            ptime;
+    boolean                  adaptivePtime = false;
 };

Dictionary {{RTCRtpEncodingParameters}} Members

+
+ scaleResolutionDownTo of type {{RTCResolutionRestriction}} +
+
+

The maximum dimensions at which to restrict this encoding.

+

When {{scaleResolutionDownTo}} is specified, the + {{RTCRtpEncodingParameters/scaleResolutionDownBy}} value MUST be + ignored. Instead, frames are sent according to the specified + resolution restrictions: frames MUST NOT be upscaled.

+

When configuring parameters, the following validation MUST be + performed if {{scaleResolutionDownTo}} is specified on any encoding or + else {{RTCPeerConnection/addTransceiver()}} [= exception/throws =] a + newly [= exception/created =] {{OperationError}} and + {{RTCRtpSender/setParameters()}} [= reject|rejects =] with a newly + [= exception/created =] {{InvalidModificationError}}:

+
    +
  • +

    {{scaleResolutionDownTo}} is specified on all encodings.

    +
  • +
  • +

    For each {{scaleResolutionDownTo}} value, both dimensions have + a value greater than 0.

    +
  • +
+
ptime of type unsigned long
@@ -403,6 +429,46 @@

Dictionary {{RTCRtpEncodingParameters}} Members

+
+

+ The {{RTCResolutionRestriction}} dictionary. +

+
dictionary RTCResolutionRestriction {
+    unsigned long maxWidth;
+    unsigned long maxHeight;
+};
+
+

Dictionary {{RTCResolutionRestriction}} Members

+
+
+ maxWidth of type unsigned long +
+
+

The maximum width that frames will be encoded with. The + restrictions are orientation agnostic, see note below. When scaling is + applied, both dimensions of the frame are downscaled using the same + factor.

+
+
+ maxHeight of type unsigned long +
+
+

The maximum height that frames will be encoded with. The + restrictions are orientation agnostic, see note below. When scaling is + applied, both dimensions of the frame MUST be downscaled using the + same factor.

+
+

+ The restrictions being orientation agnostic means that they will + automatically be adjusted to the orientation of the frame being + restricted (portrait mode or landscape mode) by swapping width and + height if necessary. This means that it does not matter if 1280x720 or + 720x1280 is specified, both always result in the exact same scaling + factor regardless of the orientation of the frame. +

+
+
+

{{RTCRtpSender}} {{RTCRtpSender/setParameters()}} extensions for requesting the generation of a key frame.