Package com.amazonaws.ivs.broadcast

Class StageVideoConfiguration.Simulcast.Layer

java.lang.Object
com.amazonaws.ivs.broadcast.StageVideoConfiguration.Simulcast.Layer
Enclosing class:
StageVideoConfiguration.Simulcast
public static class StageVideoConfiguration.Simulcast.Layer extends Object

  • Constructor Details

    • Layer

      public Layer()

  • Method Details

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getMaxBitrate

      public int getMaxBitrate()
      Returns the maximum bitrate for the layer.

    • setMaxBitrate

      public void setMaxBitrate(int maxBitrate)
      Set the maximum bitrate for the layer. This value must be between 50k and 2,500k. If the provided bitrate falls outside this range, the bitrate will not be set and an IllegalArgumentException will be thrown.
      Parameters:
      maxBitrate - the desired maximum bitrate
      Throws:
      IllegalArgumentException - if bitrate is not valid

    • getMinBitrate

      public int getMinBitrate()
      Returns the minimum bitrate for the publishing video stream.

    • setMinBitrate

      public void setMinBitrate(int minBitrate)
      Set the minimum bitrate for the layer. This value must be between 50k and 2,500k. If the provided bitrate falls outside this range, the bitrate will not be set and an IllegalArgumentException will be thrown.
      Parameters:
      minBitrate - the desired minimum bitrate
      Throws:
      IllegalArgumentException - if bitrate is not valid

    • getTargetFramerate

      public float getTargetFramerate()
      Returns the target framerate of the layer.

    • setTargetFramerate

      public void setTargetFramerate(float targetFramerate)
      Set the target framerate of the layer. The target framerate must be between 10 and 30. If the provided frame rate is outside of this range, the framerate will not be set and an IllegalArgumentException will be thrown.
      Parameters:
      targetFramerate - the desired target framerate
      Throws:
      IllegalArgumentException - if target framerate is not valid

    • getSize

      public BroadcastConfiguration.Vec2 getSize()
      Returns the resolution of the layer.

    • setSize

      public void setSize(int width, int height)

    • setSize

      public void setSize(BroadcastConfiguration.Vec2 size)
      Set the resolution of the layer. The width and height must both be within 160 and 1280, and the maximum total number of pixels is 921,600. So the smallest size you can provide is 160x160, and the largest is either 720x1280 or 1280x720. If the provided resolution does not meet this criteria, the resolution will not be set and an IllegalArgumentException will be thrown.
      Parameters:
      size - the desired resolution
      Throws:
      IllegalArgumentException - if resolution is not valid

    • getPriority

      public StageVideoConfiguration.Priority getPriority()
      Returns the current priority. By default this is Priority.LOW.

    • setPriority

      public void setPriority(StageVideoConfiguration.Priority priority)
      Set the priority of the layer.
      Parameters:
      priority - the desired priority

    • changing

      public StageVideoConfiguration.Simulcast.Layer changing(@NonNull Builder<StageVideoConfiguration.Simulcast.Layer> op)

    • with

      public static StageVideoConfiguration.Simulcast.Layer with(@NonNull Builder<StageVideoConfiguration.Simulcast.Layer> op)