Package com.banuba.sdk.frame

Enum Class FramePixelBufferFormat

java.lang.Object
java.lang.Enum<FramePixelBufferFormat>
com.banuba.sdk.frame.FramePixelBufferFormat
All Implemented Interfaces:
Serializable, Comparable<FramePixelBufferFormat>, Constable
public enum FramePixelBufferFormat extends Enum<FramePixelBufferFormat>
Available image formats for FramePixelBuffer Which are supported by the Player

  • Enum Constant Details

  • Method Details

    • values

      public static FramePixelBufferFormat[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static FramePixelBufferFormat valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • isBpc8

      public boolean isBpc8()
      Returns:
      true if the current format has only one plane

    • isI420

      public boolean isI420()
      Returns:
      true if the current format is i420 (has three planes)

    • getPixelFormat

      @Nullable public com.banuba.sdk.types.PixelFormat getPixelFormat()
      Get pixel format. IMPORTANT: available only for Bpc8 formats.
      Returns:
      pixel format or null if the format is not Bpc8
      See Also:
      • Available formats of pixels (only RGBA available here)

    • getColorStandard

      @Nullable public com.banuba.sdk.effect_player.ColorStd getColorStandard()
      Get color standard. IMPORTANT: available only for i420 (yuv) formats.
      Returns:
      color standard or null if the format is not i420 (is not yuv)
      See Also:
      • Available color standards

    • getColorRange

      @Nullable public com.banuba.sdk.effect_player.ColorRange getColorRange()
      Get color range. IMPORTANT: available only for i420 (yuv) formats.
      Returns:
      color range or null if the format is not i420 (is not yuv)
      See Also:
      • Available color ranges

    • getPixelComponents

      public int getPixelComponents()
      Get number of color components. IMPORTANT: available only for bpc8 (RGB) formats.
      Returns:
      number of color components