org.openimaj.audio

Enum AudioPlayer.Mode

java.lang.Object

java.lang.Enum<AudioPlayer.Mode>

org.openimaj.audio.AudioPlayer.Mode

All Implemented Interfaces:

Serializable, Comparable<AudioPlayer.Mode>

Enclosing class:

AudioPlayer

public static enum AudioPlayer.Mode
extends Enum<AudioPlayer.Mode>

Enumerator for the current state of the audio player.

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

Created:

29 Nov 2011

Enum Constant Summary

Enum Constants

Enum Constant and Description
PAUSE The audio player is paused
PLAY The audio player is playing
STOP The audio player is stopped

Method Summary

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

PLAY

public static final AudioPlayer.Mode PLAY

The audio player is playing

PAUSE

public static final AudioPlayer.Mode PAUSE

The audio player is paused

STOP

public static final AudioPlayer.Mode STOP

The audio player is stopped

Method Detail

values

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

Returns:

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

valueOf

public static AudioPlayer.Mode 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