Enum Class AudioChannelPosition
- All Implemented Interfaces:
Enumeration
,Serializable
,Comparable<AudioChannelPosition>
,Constable
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.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionBottom front centerBottom front leftBottom front rightFront centerFront leftFront left of centerFront rightFront right of centerinvalid positionLow-frequency effects 1 (subwoofer)Low-frequency effects 2 (subwoofer)Mono without direction; can only be used with 1 channelused for position-less channels, e.g.Rear centerRear leftRear rightSide leftSide rightSurround left (between rear left and side left)Surround right (between rear right and side right)Top centerTop front centerTop front leftTop front rightTop rear centerTop rear leftTop rear rightTop side rightTop rear rightWide left (between front left and side left)Wide right (between front right and side right) -
Method Summary
Modifier and TypeMethodDescriptionstatic Type
getType()
Get the GType of the AudioChannelPosition classint
getValue()
Get the numeric value of this enumstatic AudioChannelPosition
of
(int value) Create a new AudioChannelPosition for the provided valuestatic AudioChannelPosition
Returns the enum constant of this class with the specified name.static AudioChannelPosition[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
NONE
used for position-less channels, e.g. from a sound card that records 1024 channels; mutually exclusive with any other channel position -
MONO
Mono without direction; can only be used with 1 channel -
INVALID
invalid position -
FRONT_LEFT
Front left -
FRONT_RIGHT
Front right -
FRONT_CENTER
Front center -
LFE1
Low-frequency effects 1 (subwoofer) -
REAR_LEFT
Rear left -
REAR_RIGHT
Rear right -
FRONT_LEFT_OF_CENTER
Front left of center -
FRONT_RIGHT_OF_CENTER
Front right of center -
REAR_CENTER
Rear center -
LFE2
Low-frequency effects 2 (subwoofer) -
SIDE_LEFT
Side left -
SIDE_RIGHT
Side right -
TOP_FRONT_LEFT
Top front left -
TOP_FRONT_RIGHT
Top front right -
TOP_FRONT_CENTER
Top front center -
TOP_CENTER
Top center -
TOP_REAR_LEFT
Top rear left -
TOP_REAR_RIGHT
Top rear right -
TOP_SIDE_LEFT
Top side right -
TOP_SIDE_RIGHT
Top rear right -
TOP_REAR_CENTER
Top rear center -
BOTTOM_FRONT_CENTER
Bottom front center -
BOTTOM_FRONT_LEFT
Bottom front left -
BOTTOM_FRONT_RIGHT
Bottom front right -
WIDE_LEFT
Wide left (between front left and side left) -
WIDE_RIGHT
Wide right (between front right and side right) -
SURROUND_LEFT
Surround left (between rear left and side left) -
SURROUND_RIGHT
Surround right (between rear right and side right)
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
of
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 interfaceEnumeration
- Returns:
- the enum value
-
getType
-