Enum Class PlaybackSession.Context

java.lang.Object

java.lang.Enum<PlaybackSession.Context>

org.jjazz.musiccontrol.api.playbacksession.PlaybackSession.Context

All Implemented Interfaces:

Serializable, Comparable<PlaybackSession.Context>, Constable

Enclosing interface:

PlaybackSession

public static enum PlaybackSession.Context
extends Enum<PlaybackSession.Context>

Provide the context in which the PlaybackSession is used. Used by e.g. PlaybackListeners which want to be active only in a given context.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ARRANGER	Used when playing in arranger mode.
AUDITIONING	Used e.g. when hearing test notes.
OTHER	For other cases
RHYTHM_PREVIEW	Used when "preview hearing" a rhythm.
RP_VALUE_PREVIEW	Used when "preview hearing"
SONG	Used when playing a song (or part of).

Method Summary

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

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SONG

public static final PlaybackSession.Context SONG

Used when playing a song (or part of). This is the standard case.

ARRANGER

public static final PlaybackSession.Context ARRANGER

Used when playing in arranger mode.

AUDITIONING

public static final PlaybackSession.Context AUDITIONING

Used e.g. when hearing test notes.

RHYTHM_PREVIEW

public static final PlaybackSession.Context RHYTHM_PREVIEW

Used when "preview hearing" a rhythm.

RP_VALUE_PREVIEW

public static final PlaybackSession.Context RP_VALUE_PREVIEW

Used when "preview hearing"

OTHER

public static final PlaybackSession.Context OTHER

For other cases

Method Details

values

public static PlaybackSession.Context[] values()

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

Returns:

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

valueOf

public static PlaybackSession.Context valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null