org.jouvieje.fmodex.enumerations
Class FMOD_SOUNDGROUP_BEHAVIOR

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

All Implemented Interfaces:

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

public class FMOD_SOUNDGROUP_BEHAVIOR

extends java.lang.Object

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

These flags are used with SoundGroup::setMaxAudibleBehavior to determine what happens when more sounds
are played than are specified with SoundGroup::setMaxAudible.

Remarks

When using FMOD_SOUNDGROUP_BEHAVIOR_MUTE, SoundGroup::setMuteFadeSpeed can be used to stop a sudden transition.
Instead, the time specified will be used to cross fade between the sounds that go silent and the ones that become audible.

Platforms Supported

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

See Also

SoundGroup::setMaxAudibleBehavior
SoundGroup::getMaxAudibleBehavior
SoundGroup::setMaxAudible
SoundGroup::getMaxAudible
SoundGroup::setMuteFadeSpeed
SoundGroup::getMuteFadeSpeed

Field Summary

static FMOD_SOUNDGROUP_BEHAVIOR	FMOD_SOUNDGROUP_BEHAVIOR_FAIL
static FMOD_SOUNDGROUP_BEHAVIOR	FMOD_SOUNDGROUP_BEHAVIOR_FORCEINT
static FMOD_SOUNDGROUP_BEHAVIOR	FMOD_SOUNDGROUP_BEHAVIOR_MAX
static FMOD_SOUNDGROUP_BEHAVIOR	FMOD_SOUNDGROUP_BEHAVIOR_MUTE
static FMOD_SOUNDGROUP_BEHAVIOR	FMOD_SOUNDGROUP_BEHAVIOR_STEALLOWEST

Method Summary

int	asInt()
int	compareTo(java.lang.Object object)
boolean	equals(java.lang.Object object)
static FMOD_SOUNDGROUP_BEHAVIOR	get(int nativeValue) Retrieve a FMOD_SOUNDGROUP_BEHAVIOR enum field with his integer value
static FMOD_SOUNDGROUP_BEHAVIOR	get(Pointer pointer) Retrieve a FMOD_SOUNDGROUP_BEHAVIOR 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_SOUNDGROUP_BEHAVIOR_FAIL

public static final FMOD_SOUNDGROUP_BEHAVIOR FMOD_SOUNDGROUP_BEHAVIOR_FAIL

FMOD_SOUNDGROUP_BEHAVIOR_MUTE

public static final FMOD_SOUNDGROUP_BEHAVIOR FMOD_SOUNDGROUP_BEHAVIOR_MUTE

FMOD_SOUNDGROUP_BEHAVIOR_STEALLOWEST

public static final FMOD_SOUNDGROUP_BEHAVIOR FMOD_SOUNDGROUP_BEHAVIOR_STEALLOWEST

FMOD_SOUNDGROUP_BEHAVIOR_MAX

public static final FMOD_SOUNDGROUP_BEHAVIOR FMOD_SOUNDGROUP_BEHAVIOR_MAX

FMOD_SOUNDGROUP_BEHAVIOR_FORCEINT

public static final FMOD_SOUNDGROUP_BEHAVIOR FMOD_SOUNDGROUP_BEHAVIOR_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_SOUNDGROUP_BEHAVIOR get(int nativeValue)

Retrieve a FMOD_SOUNDGROUP_BEHAVIOR enum field with his integer value

Parameters:

nativeValue - the integer value of the field to retrieve

Returns:

the FMOD_SOUNDGROUP_BEHAVIOR enum field that correspond to the integer value

get

public static FMOD_SOUNDGROUP_BEHAVIOR get(Pointer pointer)

Retrieve a FMOD_SOUNDGROUP_BEHAVIOR enum field from a Pointer

Parameters:

pointer - a pointer holding an FMOD_SOUNDGROUP_BEHAVIOR enum field

Returns:

the FMOD_SOUNDGROUP_BEHAVIOR 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.