dom/webidl/RTCRtpParameters.webidl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   4  * You can obtain one at http://mozilla.org/MPL/2.0/.
   5  *
   6  * The origin of this IDL file is
   7  * http://w3c.github.io/webrtc-pc/#rtcrtpsender-interface
   8  */
   9
  10 enum RTCPriorityType {
  11   "very-low",
  12   "low",
  13   "medium",
  14   "high"
  15 };
  16
  17 enum RTCDegradationPreference {
  18   "maintain-framerate",
  19   "maintain-resolution",
  20   "balanced"
  21 };
  22
  23 dictionary RTCRtpEncodingParameters {
  24   boolean                  active = true;
  25   // From https://www.w3.org/TR/webrtc-priority/
  26   RTCPriorityType          priority = "low";
  27   unsigned long            maxBitrate;
  28   DOMString                rid;
  29   double                   scaleResolutionDownBy;
  30   // From https://w3c.github.io/webrtc-extensions/#rtcrtpencodingparameters-dictionary
  31   double                   maxFramerate;
  32 };
  33
  34 dictionary RTCRtpHeaderExtensionParameters {
  35   DOMString      uri;
  36   unsigned short id;
  37   boolean        encrypted;
  38 };
  39
  40 dictionary RTCRtcpParameters {
  41   DOMString cname;
  42   boolean   reducedSize;
  43 };
  44
  45 dictionary RTCRtpCodecParameters {
  46   unsigned short payloadType;
  47   DOMString      mimeType;
  48   unsigned long  clockRate;
  49   unsigned short channels = 1;
  50   DOMString      sdpFmtpLine;
  51 };
  52
  53 dictionary RTCRtpParameters {
  54   // We do not support these, but every wpt test involving parameters insists
  55   // that these be present, regardless of whether the test-case has anything to
  56   // do with these in particular (see validateRtpParameters).
  57   sequence<RTCRtpHeaderExtensionParameters> headerExtensions;
  58   RTCRtcpParameters                         rtcp;
  59   sequence<RTCRtpCodecParameters>           codecs;
  60 };
  61
  62 dictionary RTCRtpSendParameters : RTCRtpParameters {
  63   DOMString transactionId;
  64   required sequence<RTCRtpEncodingParameters> encodings;
  65 };