org.deepsymmetry.beatlink.dbserver

Enum Message.MenuIdentifier

java.lang.Object

java.lang.Enum<Message.MenuIdentifier>

org.deepsymmetry.beatlink.dbserver.Message.MenuIdentifier

All Implemented Interfaces:

Serializable, Comparable<Message.MenuIdentifier>

Enclosing class:

Message

public static enum Message.MenuIdentifier
extends Enum<Message.MenuIdentifier>

For many types of query messages, the first argument of the message is a 4-byte integer which we currently refer to as r:m:s:t, because the first byte is the player number of the player making the request, the second byte identifies the menu or destination for which information is being loaded, the third byte identifies the media slot (USB or SD) being asked about (as described in CdjStatus.TrackSourceSlot), and the fourth byte identifies the type of track being worked with (for most requests this is 1, meaning rekordbox). This enumeration lists the known values for the second, menu, byte.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DATA Values which do not display in a menu, such as track waveforms, beat grids, album art, etc.
MAIN_MENU The primary menu which appears on the left half of the player display.
SORT_MENU Types of sorting available? I am not entirely sure when this is used.
SUB_MENU The secondary menu which sometimes appears down the right half of the player display.
TRACK_INFO The pseudo-menu of track metadata.

Field Summary

Fields

Modifier and Type	Field and Description
byte	protocolValue The value which identifies this menu or destination by appearing in the second byte of the first argument of many request messages.

Method Summary

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

MAIN_MENU

public static final Message.MenuIdentifier MAIN_MENU

The primary menu which appears on the left half of the player display.

SUB_MENU

public static final Message.MenuIdentifier SUB_MENU

The secondary menu which sometimes appears down the right half of the player display.

TRACK_INFO

public static final Message.MenuIdentifier TRACK_INFO

The pseudo-menu of track metadata.

SORT_MENU

public static final Message.MenuIdentifier SORT_MENU

Types of sorting available? I am not entirely sure when this is used.

DATA

public static final Message.MenuIdentifier DATA

Values which do not display in a menu, such as track waveforms, beat grids, album art, etc. are loaded “into” this menu/destination.

Field Detail

protocolValue

public final byte protocolValue

The value which identifies this menu or destination by appearing in the second byte of the first argument of many request messages.

Method Detail

values

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

Returns:

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

valueOf

public static Message.MenuIdentifier 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