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 RTCRtxParameters {
  24   unsigned long ssrc;
  25 };
  26
  27 dictionary RTCFecParameters {
  28   unsigned long ssrc;
  29 };
  30
  31 dictionary RTCRtpEncodingParameters {
  32   unsigned long            ssrc;
  33   RTCRtxParameters         rtx;
  34   RTCFecParameters         fec;
  35   boolean                  active = true;
  36   // From https://www.w3.org/TR/webrtc-priority/
  37   RTCPriorityType          priority = "low";
  38   unsigned long            maxBitrate;
  39   DOMString                rid;
  40   double                   scaleResolutionDownBy;
  41   // From https://w3c.github.io/webrtc-extensions/#rtcrtpencodingparameters-dictionary
  42   double                   maxFramerate;
  43 };
  44
  45 dictionary RTCRtpHeaderExtensionParameters {
  46   DOMString      uri;
  47   unsigned short id;
  48   boolean        encrypted;
  49 };
  50
  51 dictionary RTCRtcpParameters {
  52   DOMString cname;
  53   boolean   reducedSize;
  54 };
  55
  56 dictionary RTCRtpCodecParameters {
  57   unsigned short payloadType;
  58   DOMString      mimeType;
  59   unsigned long  clockRate;
  60   unsigned short channels = 1;
  61   DOMString      sdpFmtpLine;
  62 };
  63
  64 dictionary RTCRtpParameters {
  65   // We do not support these, but every wpt test involving parameters insists
  66   // that these be present, regardless of whether the test-case has anything to
  67   // do with these in particular (see validateRtpParameters).
  68   sequence<RTCRtpHeaderExtensionParameters> headerExtensions;
  69   RTCRtcpParameters                         rtcp;
  70   sequence<RTCRtpCodecParameters>           codecs;
  71 };
  72
  73 dictionary RTCRtpSendParameters : RTCRtpParameters {
  74   DOMString transactionId;
  75   required sequence<RTCRtpEncodingParameters> encodings;
  76 };