com.github.hoary.javaav

Enum ChannelLayout

java.lang.Object

java.lang.Enum<ChannelLayout>

com.github.hoary.javaav.ChannelLayout

All Implemented Interfaces:

Serializable, Comparable<ChannelLayout>

public enum ChannelLayout
extends Enum<ChannelLayout>

Enumeration of all supported channel layouts. A ChannelLayout can be retrieved by passing a FFmpeg channel layout id to byId(long).

Author:

Alex Andres

Enum Constant Summary

Enum Constants

Enum Constant and Description
_2_1
_2_2
_2POINT1
_3POINT1
_4POINT0
_4POINT1
_5POINT0
_5POINT0_BACK
_5POINT1
_5POINT1_BACK
_6POINT0
_6POINT0_FRONT
_6POINT1
_6POINT1_BACK
_6POINT1_FRONT
_7POINT0
_7POINT0_FRONT
_7POINT1
_7POINT1_WIDE
_7POINT1_WIDE_BACK
HEXAGONAL
MONO
OCTAGONAL
QUAD
STEREO
STEREO_DOWNMIX
SURROUND

Method Summary

Methods

Modifier and Type	Method and Description
String	asString() Get the channel layout description.
static ChannelLayout	byId(long id) Get a ChannelLayout that matches to the specified FFmpeg id.
long	value() Get the channel layout id defined in FFmpeg.
static ChannelLayout	valueOf(String name) Returns the enum constant of this type with the specified name.
static ChannelLayout[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MONO

public static final ChannelLayout MONO

STEREO

public static final ChannelLayout STEREO

_2POINT1

public static final ChannelLayout _2POINT1

_2_1

public static final ChannelLayout _2_1

SURROUND

public static final ChannelLayout SURROUND

_3POINT1

public static final ChannelLayout _3POINT1

_4POINT0

public static final ChannelLayout _4POINT0

_4POINT1

public static final ChannelLayout _4POINT1

_2_2

public static final ChannelLayout _2_2

QUAD

public static final ChannelLayout QUAD

_5POINT0

public static final ChannelLayout _5POINT0

_5POINT1

public static final ChannelLayout _5POINT1

_5POINT0_BACK

public static final ChannelLayout _5POINT0_BACK

_5POINT1_BACK

public static final ChannelLayout _5POINT1_BACK

_6POINT0

public static final ChannelLayout _6POINT0

_6POINT0_FRONT

public static final ChannelLayout _6POINT0_FRONT

HEXAGONAL

public static final ChannelLayout HEXAGONAL

_6POINT1

public static final ChannelLayout _6POINT1

_6POINT1_BACK

public static final ChannelLayout _6POINT1_BACK

_6POINT1_FRONT

public static final ChannelLayout _6POINT1_FRONT

_7POINT0

public static final ChannelLayout _7POINT0

_7POINT0_FRONT

public static final ChannelLayout _7POINT0_FRONT

_7POINT1

public static final ChannelLayout _7POINT1

_7POINT1_WIDE

public static final ChannelLayout _7POINT1_WIDE

_7POINT1_WIDE_BACK

public static final ChannelLayout _7POINT1_WIDE_BACK

OCTAGONAL

public static final ChannelLayout OCTAGONAL

STEREO_DOWNMIX

public static final ChannelLayout STEREO_DOWNMIX

Method Detail

values

public static ChannelLayout[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ChannelLayout c : ChannelLayout.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ChannelLayout valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

value

public final long value()

Get the channel layout id defined in FFmpeg.

Returns:

FFmpeg channel layout id.

asString

public final String asString()

Get the channel layout description.

Returns:

channel layout description.

byId

public static ChannelLayout byId(long id)

Get a ChannelLayout that matches to the specified FFmpeg id.

Parameters:

id - FFmpeg channel layout id.

Returns:

matching channel layout, or null if id is not defined.