Package 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 Detail

      • BOTH_CHANNELS

        public static final int BOTH_CHANNELS
        Flag to indicate output should include both channels.
        See Also:
        Constant Field Values

      • LEFT_CHANNEL

        public static final int LEFT_CHANNEL
        Flag to indicate output should include the left channel only.
        See Also:
        Constant Field Values

      • RIGHT_CHANNEL

        public static final int RIGHT_CHANNEL
        Flag to indicate output should include the right channel only.
        See Also:
        Constant Field Values

      • DOWNMIX_CHANNELS

        public static final int DOWNMIX_CHANNELS
        Flag to indicate output is mono.
        See Also:
        Constant Field Values

    • Method Detail

      • 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:
        java.lang.IllegalArgumentException - if code is not a valid channel code.

      • 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.

      • 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.

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object