Enum OscillatorType

java.lang.Object

java.lang.Enum<OscillatorType>

com.codename1.media.audio.OscillatorType

All Implemented Interfaces:

Comparable<OscillatorType>

public enum OscillatorType
extends Enum<OscillatorType>

The waveform an OscillatorNode generates.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CUSTOM	A waveform defined by a PeriodicWave, set with OscillatorNode.setPeriodicWave(PeriodicWave).
SAWTOOTH	A band-limited sawtooth wave.
SINE	A sine wave.
SQUARE	A band-limited square wave.
TRIANGLE	A band-limited triangle wave.

Method Summary

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

Methods inherited from class Enum

clone, compareTo, equals, getDeclaringClass, getEnumValues, hashCode, name, ordinal, setEnumValues, toString, valueOf

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SINE

public static final OscillatorType SINE

A sine wave.

SQUARE

public static final OscillatorType SQUARE

A band-limited square wave.

SAWTOOTH

public static final OscillatorType SAWTOOTH

A band-limited sawtooth wave.

TRIANGLE

public static final OscillatorType TRIANGLE

A band-limited triangle wave.

CUSTOM

public static final OscillatorType CUSTOM

A waveform defined by a PeriodicWave, set with OscillatorNode.setPeriodicWave(PeriodicWave).

Method Details

values

public static OscillatorType[] values()

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

Returns:

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

valueOf

public static OscillatorType 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