com.jme3.audio

Enum AudioSource.Status

java.lang.Object

java.lang.Enum<AudioSource.Status>

com.jme3.audio.AudioSource.Status

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AudioSource.Status>

Enclosing interface:

AudioSource

public static enum AudioSource.Status
extends java.lang.Enum<AudioSource.Status>

Status indicates the current status of the audio source.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Paused The audio source is currently paused.
Playing The audio source is currently playing.
Stopped The audio source is currently stopped.

Method Summary

Modifier and Type	Method and Description
static AudioSource.Status	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AudioSource.Status[]	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 AudioSource.Status Playing

The audio source is currently playing. This will be set if AudioNode.play() is called.

Paused

public static final AudioSource.Status Paused

The audio source is currently paused.

Stopped

public static final AudioSource.Status Stopped

The audio source is currently stopped. This will be set if AudioNode.stop() is called or the audio has reached the end of the file.

Method Detail

values

public static AudioSource.Status[] 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 (AudioSource.Status c : AudioSource.Status.values())
    System.out.println(c);

Returns:

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

valueOf

public static AudioSource.Status 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