Module webrtc.java

Class RTCRtpEncodingParameters


  • public class RTCRtpEncodingParameters
    extends Object
    Describes encoding options of an RTCRtpSender.
    Author:
    Alex Andres
    • Field Detail

      • active

        public Boolean active
        Indicates that this encoding is actively being sent. Setting it to false causes this encoding to no longer be sent. Setting it to true causes this encoding to be sent.
      • maxBitrate

        public Integer maxBitrate
        When present, indicates the maximum bitrate that can be used to send this encoding. If unset, there is no maximum bitrate.
      • scaleResolutionDownBy

        public Double scaleResolutionDownBy
        Only present if the sender's kind is "video". The video's resolution will be scaled down in each dimension by the given value before sending. For example, if the value is 2.0, the video will be scaled down by a factor of 2 in each dimension, resulting in sending a video of one quarter the size. If the value is 1.0, the video will not be affected. The value must be greater than or equal to 1.0. By default, the sender will not apply any scaling
    • Constructor Detail

      • RTCRtpEncodingParameters

        public RTCRtpEncodingParameters()
        Creates an instance of RTCRtpEncodingParameters.