javazoom.jl.decoder

Class OutputChannels


public class OutputChannels
extends java.lang.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 OutputChannels
BOTH
static int
BOTH_CHANNELS
Flag to indicate output should include both channels.
static OutputChannels
DOWNMIX
static int
DOWNMIX_CHANNELS
Flag to indicate output is mono.
static OutputChannels
LEFT
static int
LEFT_CHANNEL
Flag to indicate output should include the left channel only.
static OutputChannels
RIGHT
static int
RIGHT_CHANNEL
Flag to indicate output should include the right channel only.

Method Summary

boolean
equals(Object o)
static OutputChannels
fromInt(int code)
Creates an OutputChannels instance corresponding to the given channel code.
int
getChannelCount()
Retrieves the number of output channels represented by this channel output type.
int
getChannelsOutputCode()
Retrieves the code representing the desired output channels.
int
hashCode()

Field Details

BOTH

public static final OutputChannels BOTH

BOTH_CHANNELS

public static final int BOTH_CHANNELS
Flag to indicate output should include both channels.
Field Value:
0

DOWNMIX

public static final OutputChannels DOWNMIX

DOWNMIX_CHANNELS

public static final int DOWNMIX_CHANNELS
Flag to indicate output is mono.
Field Value:
3

LEFT

public static final OutputChannels LEFT

LEFT_CHANNEL

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

RIGHT

public static final OutputChannels RIGHT

RIGHT_CHANNEL

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

Method Details

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.

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