Enum Class AudioChannelPosition

java.lang.Object
java.lang.Enum<AudioChannelPosition>
org.freedesktop.gstreamer.audio.AudioChannelPosition
All Implemented Interfaces:
Serializable, Comparable<AudioChannelPosition>, Constable, Enumeration
@Generated("org.javagi.JavaGI") public enum AudioChannelPosition extends Enum<AudioChannelPosition> implements Enumeration

Audio channel positions.

These are the channels defined in SMPTE 2036-2-2008 Table 1 for 22.2 audio systems with the Surround and Wide channels from DTS Coherent Acoustics (v.1.3.1) and 10.2 and 7.1 layouts. In the caps the actual channel layout is expressed with a channel count and a channel mask, which describes the existing channels. The positions in the bit mask correspond to the enum values. For negotiation it is allowed to have more bits set in the channel mask than the number of channels to specify the allowed channel positions but this is not allowed in negotiated caps. It is not allowed in any situation other than the one mentioned below to have less bits set in the channel mask than the number of channels.

GSTAUDIOCHANNELPOSITIONMONO can only be used with a single mono channel that has no direction information and would be mixed into all directional channels. This is expressed in caps by having a single channel and no channel mask.

GSTAUDIOCHANNELPOSITIONNONE can only be used if all channels have this position. This is expressed in caps by having a channel mask with no bits set.

As another special case it is allowed to have two channels without a channel mask. This implicitly means that this is a stereo stream with a front left and front right channel.

  • Enum Constant Details

  • Method Details

    • values

      public static AudioChannelPosition[] 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 AudioChannelPosition 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

    • of

      public static AudioChannelPosition of(int value)
      Create a new AudioChannelPosition for the provided value
      Parameters:
      value - the enum value
      Returns:
      the enum for the provided value

    • getValue

      public int getValue()
      Get the numeric value of this enum
      Specified by:
      getValue in interface Enumeration
      Returns:
      the enum value

    • of

      public static AudioChannelPosition of(MemorySegment address)
      Create a new AudioChannelPosition for the value in the provided memory address.
      Parameters:
      address - the memory address holding a enum value
      Returns:
      the enum for the value in the provided memory address

    • getType

      public static @Nullable Type getType()
      Get the GType of the AudioChannelPosition class.
      Returns:
      the GType