io.github.amyassist.amy.core.audio.sound

Enum SoundPlayer.StopReason

java.lang.Object

java.lang.Enum<SoundPlayer.StopReason>

io.github.amyassist.amy.core.audio.sound.SoundPlayer.StopReason

All Implemented Interfaces:

Serializable, Comparable<SoundPlayer.StopReason>

Enclosing interface:

SoundPlayer

public static enum SoundPlayer.StopReason
extends Enum<SoundPlayer.StopReason>

All possible reasons for the SoundPlayer to stop.

Author:

Tim Neumann

Enum Constant Summary

Enum Constants

Enum Constant and Description
END_OF_AUDIO When the audio that should be played, was played completely
OTHER Any other reason.
PLAYER_STOPPED When the sound player was stopped via SoundPlayer.stop().
STREAM_CLOSED When the audio stream, the audio is played on was closed.

Method Summary

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

END_OF_AUDIO

public static final SoundPlayer.StopReason END_OF_AUDIO

When the audio that should be played, was played completely

STREAM_CLOSED

public static final SoundPlayer.StopReason STREAM_CLOSED

When the audio stream, the audio is played on was closed.

PLAYER_STOPPED

public static final SoundPlayer.StopReason PLAYER_STOPPED

When the sound player was stopped via SoundPlayer.stop().

OTHER

public static final SoundPlayer.StopReason OTHER

Any other reason.

Method Detail

values

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

Returns:

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

valueOf

public static SoundPlayer.StopReason valueOf(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:

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

NullPointerException - if the argument is null