org.jouvieje.fmodex.enumerations
Class FMOD_SPEAKER

java.lang.Object
  org.jouvieje.fmodex.enumerations.FMOD_SPEAKER

All Implemented Interfaces:

java.lang.Comparable, org.jouvieje.fmodex.enumerations.Enumeration

public class FMOD_SPEAKER

extends java.lang.Object

implements org.jouvieje.fmodex.enumerations.Enumeration, java.lang.Comparable

These are speaker types defined for use with the Channel::setSpeakerLevels command.
It can also be used for speaker placement in the System::set3DSpeakerPosition command.

Remarks

If you are using FMOD_SPEAKERMODE_RAW and speaker assignments are meaningless, just cast a raw integer value to this type.
For example (FMOD_SPEAKER)7 would use the 7th speaker (also the same as FMOD_SPEAKER_SIDE_RIGHT).
Values higher than this can be used if an output system has more than 8 speaker types / output channels. 15 is the current maximum.
NOTE: On Playstation 3 in 7.1, the extra 2 speakers are not side left/side right, they are 'surround back left'/'surround back right' which
locate the speakers behind the listener instead of to the sides like on PC. FMOD_SPEAKER_SBL/FMOD_SPEAKER_SBR are provided to make it
clearer what speaker is being addressed on that platform.

Platforms Supported

Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation 2, PlayStation Portable, PlayStation 3, Wii, Solaris, iPhone

See Also

FMOD_SPEAKERMODE
Channel::setSpeakerLevels
Channel::getSpeakerLevels
System::set3DSpeakerPosition
System::get3DSpeakerPosition

Field Summary

static FMOD_SPEAKER	FMOD_SPEAKER_BACK_LEFT
static FMOD_SPEAKER	FMOD_SPEAKER_BACK_RIGHT
static FMOD_SPEAKER	FMOD_SPEAKER_FORCEINT
static FMOD_SPEAKER	FMOD_SPEAKER_FRONT_CENTER
static FMOD_SPEAKER	FMOD_SPEAKER_FRONT_LEFT
static FMOD_SPEAKER	FMOD_SPEAKER_FRONT_RIGHT
static FMOD_SPEAKER	FMOD_SPEAKER_LOW_FREQUENCY
static FMOD_SPEAKER	FMOD_SPEAKER_MAX
static FMOD_SPEAKER	FMOD_SPEAKER_MONO
static FMOD_SPEAKER	FMOD_SPEAKER_NULL
static FMOD_SPEAKER	FMOD_SPEAKER_SBL
static FMOD_SPEAKER	FMOD_SPEAKER_SBR
static FMOD_SPEAKER	FMOD_SPEAKER_SIDE_LEFT
static FMOD_SPEAKER	FMOD_SPEAKER_SIDE_RIGHT

Method Summary

static FMOD_SPEAKER	allocate(int speakerID) Retrieve a FMOD_SPEAKER enum field with a speaker ID.
int	asInt()
int	compareTo(java.lang.Object object)
boolean	equals(java.lang.Object object)
static FMOD_SPEAKER	get(int nativeValue) Retrieve a FMOD_SPEAKER enum field with his integer value
static FMOD_SPEAKER	get(Pointer pointer) Retrieve a FMOD_SPEAKER enum field from a Pointer
static java.util.Iterator	iterator()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

FMOD_SPEAKER_FRONT_LEFT

public static final FMOD_SPEAKER FMOD_SPEAKER_FRONT_LEFT

FMOD_SPEAKER_FRONT_RIGHT

public static final FMOD_SPEAKER FMOD_SPEAKER_FRONT_RIGHT

FMOD_SPEAKER_FRONT_CENTER

public static final FMOD_SPEAKER FMOD_SPEAKER_FRONT_CENTER

FMOD_SPEAKER_LOW_FREQUENCY

public static final FMOD_SPEAKER FMOD_SPEAKER_LOW_FREQUENCY

FMOD_SPEAKER_BACK_LEFT

public static final FMOD_SPEAKER FMOD_SPEAKER_BACK_LEFT

FMOD_SPEAKER_BACK_RIGHT

public static final FMOD_SPEAKER FMOD_SPEAKER_BACK_RIGHT

FMOD_SPEAKER_SIDE_LEFT

public static final FMOD_SPEAKER FMOD_SPEAKER_SIDE_LEFT

FMOD_SPEAKER_SIDE_RIGHT

public static final FMOD_SPEAKER FMOD_SPEAKER_SIDE_RIGHT

FMOD_SPEAKER_MAX

public static final FMOD_SPEAKER FMOD_SPEAKER_MAX

FMOD_SPEAKER_MONO

public static final FMOD_SPEAKER FMOD_SPEAKER_MONO

FMOD_SPEAKER_NULL

public static final FMOD_SPEAKER FMOD_SPEAKER_NULL

FMOD_SPEAKER_SBL

public static final FMOD_SPEAKER FMOD_SPEAKER_SBL

FMOD_SPEAKER_SBR

public static final FMOD_SPEAKER FMOD_SPEAKER_SBR

FMOD_SPEAKER_FORCEINT

public static final FMOD_SPEAKER FMOD_SPEAKER_FORCEINT

Method Detail

asInt

public int asInt()

Specified by:

asInt in interface org.jouvieje.fmodex.enumerations.Enumeration

Returns:

the integer value of the enumeration constant.

toString

public java.lang.String toString()

equals

public boolean equals(java.lang.Object object)

compareTo

public int compareTo(java.lang.Object object)

Specified by:

compareTo in interface java.lang.Comparable

get

public static FMOD_SPEAKER get(int nativeValue)

Retrieve a FMOD_SPEAKER enum field with his integer value

Parameters:

nativeValue - the integer value of the field to retrieve

Returns:

the FMOD_SPEAKER enum field that correspond to the integer value

get

public static FMOD_SPEAKER get(Pointer pointer)

Retrieve a FMOD_SPEAKER enum field from a Pointer

Parameters:

pointer - a pointer holding an FMOD_SPEAKER enum field

Returns:

the FMOD_SPEAKER enum field that correspond to the enum field in the pointer

iterator

public static java.util.Iterator iterator()

Returns:

an Iterator over the elements in this enumeration.
Can be cast to Iterator in Java 1.5.

allocate

public static FMOD_SPEAKER allocate(int speakerID)

Retrieve a FMOD_SPEAKER enum field with a speaker ID.

Parameters:

speakerID - ID of a speaker.

Returns:

the FMOD_SPEAKER enum field that correspond to the speaker ID.