Package com.twilio.video

Class EncodingParameters

  • public class EncodingParameters
extends java.lang.Object
    Defines audio and video encoding parameters. Maximum bitrate is specified as Transport Independent Application Specific Maximum (TIAS) bitrate RFC3890 in Kilobits per second (Kbps) excluding IP/UDP/TCP headers. These encoding parameters are applied for each PeerConnection. For peer-to-peer Rooms, there is a separate PeerConnection for each participant, i.e., if you set maximum video bitrate to 1,000 Kbps and you have two RemoteParticipant`s in the Room, the client sends up to 2,000 Kbps. For group Rooms, there is a single PeerConnection to Twilio's Media Server. If you are publishing multiple video tracks (e.g., video and screen share), each tracks receives the maximum bitrate specified, i.e., if you set maximum video bitrate to 1,000 Kbps and you publish both video and screen share, client sends out 2,000 Kbps. You may update encoding parameters any time using LocalParticipant.setEncodingParameters(EncodingParameters).

    • Field Summary

      Fields 
      Modifier and Type Field Description
      int maxAudioBitrate
      Maximum audio send bitrate in Kilobits per second (Kbps).
      int maxVideoBitrate
      Maximum video send bitrate in Kilobits per second (Kbps).

    • Constructor Summary

      Constructors 
      Constructor Description
      EncodingParameters​(int maxAudioBitrate, int maxVideoBitrate)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object o)  
      int hashCode()  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • maxAudioBitrate

        public final int maxAudioBitrate
        Maximum audio send bitrate in Kilobits per second (Kbps). Zero indicates the WebRTC default value, which is codec dependent. The maximum bitrate for Opus is 510 Kbps.

      • maxVideoBitrate

        public final int maxVideoBitrate
        Maximum video send bitrate in Kilobits per second (Kbps). Zero indicates the WebRTC default value, which is 2,000 Kbps.

    • Constructor Detail

      • EncodingParameters

        public EncodingParameters​(int maxAudioBitrate,
                          int maxVideoBitrate)

    • Method Detail

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        @NonNull
public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object