Package com.csse3200.game.cutscene.models.object

Enum Class AudioBus

java.lang.Object

java.lang.Enum<AudioBus>

com.csse3200.game.cutscene.models.object.AudioBus

All Implemented Interfaces:

Serializable, Comparable<AudioBus>, Constable

public enum AudioBus
extends Enum<AudioBus>

The different audio busses that sound can be played on.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
MUSIC	For long-lasting and (usually) looping soundtracks.
SFX	For (usually) single, quick audio effects.

Method Summary

Modifier and Type	Method	Description
static AudioBus	fromString(String value)	Maps JSON values "sfx"|"music" to their AudioBus counterparts.
static AudioBus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AudioBus[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SFX

public static final AudioBus SFX

For (usually) single, quick audio effects. E.g. explosion, door opening, crash.

MUSIC

public static final AudioBus MUSIC

For long-lasting and (usually) looping soundtracks. E.g. ambiance, or background music.

Method Details

values

public static AudioBus[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static AudioBus valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

fromString

public static AudioBus fromString(String value)

Maps JSON values "sfx"|"music" to their AudioBus counterparts.

Parameters:

value - - String value to be converted

Returns:

AudioBus value corresponding to the input string (sfx by default).