javazoom.jl.decoder

Class OutputChannels

public class OutputChannels extends Object

A Type-safe representation of the the supported output channel constants. This class is immutable and, hence, is thread safe.

Since: 0.0.7

Field Summary
static OutputChannelsBOTH
static intBOTH_CHANNELS
Flag to indicate output should include both channels.
static OutputChannelsDOWNMIX
static intDOWNMIX_CHANNELS
Flag to indicate output is mono.
static OutputChannelsLEFT
static intLEFT_CHANNEL
Flag to indicate output should include the left channel only.
static OutputChannelsRIGHT
static intRIGHT_CHANNEL
Flag to indicate output should include the right channel only.
Method Summary
booleanequals(Object o)
static OutputChannelsfromInt(int code)
Creates an OutputChannels instance corresponding to the given channel code.
intgetChannelCount()
Retrieves the number of output channels represented by this channel output type.
intgetChannelsOutputCode()
Retrieves the code representing the desired output channels.
inthashCode()

Field Detail

BOTH

public static final OutputChannels BOTH

BOTH_CHANNELS

public static final int BOTH_CHANNELS
Flag to indicate output should include both channels.

DOWNMIX

public static final OutputChannels DOWNMIX

DOWNMIX_CHANNELS

public static final int DOWNMIX_CHANNELS
Flag to indicate output is mono.

LEFT

public static final OutputChannels LEFT

LEFT_CHANNEL

public static final int LEFT_CHANNEL
Flag to indicate output should include the left channel only.

RIGHT

public static final OutputChannels RIGHT

RIGHT_CHANNEL

public static final int RIGHT_CHANNEL
Flag to indicate output should include the right channel only.

Method Detail

equals

public boolean equals(Object o)

fromInt

public static OutputChannels fromInt(int code)
Creates an OutputChannels instance corresponding to the given channel code.

Parameters: code one of the OutputChannels channel code constants.

Throws: IllegalArgumentException if code is not a valid channel code.

getChannelCount

public int getChannelCount()
Retrieves the number of output channels represented by this channel output type.

Returns: The number of output channels for this channel output type. This will be 2 for BOTH_CHANNELS only, and 1 for all other types.

getChannelsOutputCode

public int getChannelsOutputCode()
Retrieves the code representing the desired output channels. Will be one of LEFT_CHANNEL, RIGHT_CHANNEL, BOTH_CHANNELS or DOWNMIX_CHANNELS.

Returns: the channel code represented by this instance.

hashCode

public int hashCode()
JavaZOOM 1999-2005