Package com.tagtraum.audiokern.key

Enum PitchProfileKey2.KeyProfileChooser

java.lang.Object

java.lang.Enum<PitchProfileKey2.KeyProfileChooser>

com.tagtraum.audiokern.key.PitchProfileKey2.KeyProfileChooser

All Implemented Interfaces:

Serializable, Comparable<PitchProfileKey2.KeyProfileChooser>

Enclosing class:

PitchProfileKey2

public static enum PitchProfileKey2.KeyProfileChooser
extends Enum<PitchProfileKey2.KeyProfileChooser>

Allows for choosing an appropriate KeyProfile for a given AudioSong and chromagram.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTO
EDM
NO_EDM

Method Summary

Modifier and Type	Method	Description
abstract KeyProfile	choose(float[] chromagram, AudioSong song)
static PitchProfileKey2.KeyProfileChooser	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PitchProfileKey2.KeyProfileChooser[]	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

EDM

public static final PitchProfileKey2.KeyProfileChooser EDM

NO_EDM

public static final PitchProfileKey2.KeyProfileChooser NO_EDM

AUTO

public static final PitchProfileKey2.KeyProfileChooser AUTO

Method Detail

values

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

Returns:

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

valueOf

public static PitchProfileKey2.KeyProfileChooser 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

choose

public abstract KeyProfile choose(float[] chromagram,
                                  AudioSong song)