Microsoft.Xna.Framework.Audio

Enum SoundState

java.lang.Object

java.lang.Enum<SoundState>

Microsoft.Xna.Framework.Audio.SoundState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SoundState>

public enum SoundState
extends java.lang.Enum<SoundState>

Current state (playing, paused, or stopped) of a SoundEffectInstance.

Author:

Halofreak1990

Enum Constant Summary

Enum Constants

Enum Constant and Description
Paused The SoundEffectInstance is paused.
Playing The SoundEffectInstance is playing.
Stopped The SoundEffectInstance is stopped.

Method Summary

Methods

Modifier and Type	Method and Description
static SoundState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SoundState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Playing

public static final SoundState Playing

The SoundEffectInstance is playing.

Paused

public static final SoundState Paused

The SoundEffectInstance is paused.

Stopped

public static final SoundState Stopped

The SoundEffectInstance is stopped.

Method Detail

values

public static SoundState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SoundState c : SoundState.values())
    System.out.println(c);

Returns:

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

valueOf

public static SoundState valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null