Package com.amazonaws.ivs.player

Class UnavailableQuality

java.lang.Object
com.amazonaws.ivs.player.UnavailableQuality
public class UnavailableQuality extends Object
Describes a media rendition that is unavailable for playback The quality was either removed by the server or by the client. Unavailable qualities cannot be used as a normal Quality object, and do not map to a source rendition.

  • Constructor Summary

    Constructors
    Constructor
    Description
    UnavailableQuality(String name, String codecs, int width, int height, String group, int bitrate, float framerate, List<String> filterReasons, List<String> authReasons)
    Creates a new UnavailableQuality instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
     
    List<String>
    getAuthReasons()
    If populated, describes the authorization failures which resulted in the server removing this quality from the available quality list.
    int
    getBitrate()
    Gets the bitrate of the media expressed as bits per second.
    String
    getCodecs()
    Gets the codec string representing the media codec information, e.g.
    List<String>
    getFilterReasons()
    If populated, describes the technical reasons which resulted in the server or client removing this quality from the available quality list.
    float
    getFramerate()
    Gets the framerate of the quality expressed as frames per second.
    String
    getGroup()
    Gets the HLS group ID of the quality object.
    int
    getHeight()
    Gets the height of the unavailable quality in pixels.
    String
    getName()
    Gets the name of the quality.
    int
    getWidth()
    Gets the width of the unavailable quality in pixels.
    int
    hashCode()
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • UnavailableQuality

      public UnavailableQuality(@NonNull String name, @NonNull String codecs, int width, int height, @NonNull String group, int bitrate, float framerate, @NonNull List<String> filterReasons, @NonNull List<String> authReasons)
      Creates a new UnavailableQuality instance.
      Parameters:
      name - name of the quality, suitable for use in a user interface
      codecs - codec string representing the media codec information, e.g. "avc1.64002A,mp4a.40.2"
      width - the width of the unavailable quality in pixels
      height - the height of the unavailable quality in pixels
      group - the HLS group ID of the quality object
      bitrate - the bitrate of the media expressed as bits per second
      framerate - the framerate of the quality expressed as frames per second
      filterReasons - if populated, describes the technical reasons which resulted in the server or client removing this quality
      authReasons - if populated, describes the authorization failures which resulted in the server removing this quality

  • Method Details

    • getName

      @NonNull public String getName()
      Gets the name of the quality.
      Returns:
      name of the quality

    • getCodecs

      @NonNull public String getCodecs()
      Gets the codec string representing the media codec information, e.g. "avc1.64002A,mp4a.40.2"
      Returns:
      codec string

    • getWidth

      public int getWidth()
      Gets the width of the unavailable quality in pixels.
      Returns:
      width in pixels

    • getHeight

      public int getHeight()
      Gets the height of the unavailable quality in pixels.
      Returns:
      height in pixels

    • getGroup

      @NonNull public String getGroup()
      Gets the HLS group ID of the quality object.
      Returns:
      group ID

    • getBitrate

      public int getBitrate()
      Gets the bitrate of the media expressed as bits per second.
      Returns:
      bitrate in bps

    • getFramerate

      public float getFramerate()
      Gets the framerate of the quality expressed as frames per second.
      Returns:
      framerate or 0 if unknown

    • getFilterReasons

      @NonNull public List<String> getFilterReasons()
      If populated, describes the technical reasons which resulted in the server or client removing this quality from the available quality list.
      Returns:
      list of filter reasons

    • getAuthReasons

      @NonNull public List<String> getAuthReasons()
      If populated, describes the authorization failures which resulted in the server removing this quality from the available quality list.
      Returns:
      list of authorization reasons

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object