org.deepsymmetry.beatlink.dbserver

Enum Message.MenuItemType

java.lang.Object

java.lang.Enum<Message.MenuItemType>

org.deepsymmetry.beatlink.dbserver.Message.MenuItemType

All Implemented Interfaces:

Serializable, Comparable<Message.MenuItemType>

Enclosing class:

Message

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALBUM_TITLE The string identifying the name of an album, part of the track metadata response.
ARTIST The string identifying the name of the artist for a track, part of the track metadata response, as well as track lists and play lists.
COLOR_AQUA A label assigned a track by the DJ, marked with an aqua dot, part of the track metadata response.
COLOR_BLUE A label assigned a track by the DJ, marked with a blue dot, part of the track metadata response.
COLOR_GREEN A label assigned a track by the DJ, marked with a green dot, part of the track metadata response.
COLOR_NONE Indicates the DJ has not assigned a color label to a track, part of the track metadata response.
COLOR_ORANGE A label assigned a track by the DJ, marked with an orange dot, part of the track metadata response.
COLOR_PINK A label assigned a track by the DJ, marked with a pink dot, part of the track metadata response.
COLOR_PURPLE A label assigned a track by the DJ, marked with a purple dot, part of the track metadata response.
COLOR_RED A label assigned a track by the DJ, marked with a red dot, part of the track metadata response.
COLOR_YELLOW A label assigned a track by the DJ, marked with a yellow dot, part of the track metadata response.
COMMENT An arbitrary text string assigned to a track by the DJ.
DATE_ADDED A string reporting when the track was added to the collection, in the form "YYYY-MM-DD", part of the track metadata response.
DISC I don’t yet know where this appears or what it means.
DURATION The duration, in seconds, of a track, part of the track metadata response.
FOLDER A potentially-nested grouping of other objects, such as a group of playlists in the playlists menu.
GENRE The string identifying the musical genre of a track, part of the track metadata response.
KEY A string containing the musical key of a track, part of the track metadata response.
LABEL A string containing the label that issued a track, part of the track metadata response.
ORIGINAL_ARTIST The artist who originally recorded a track.
PLAYLIST When listing playlists, reports the name and ID of an actual playlist, as opposed to a sub-folder.
RATING The rating assigned a track by the DJ, part of the track metadata response.
REMIXER The producer who remixed a track.
TEMPO The tempo of a track, BPM times 100, part of the track metadata response.
TRACK_LIST_ENTRY_BY_COLOR Reports the title and color of a track, return when listing playlists or all tracks sorted by color, or in their default sort order when the DJ has set this as the default second column for track lists.
TRACK_TITLE The string identifying the name of a track, part of the track metadata response, as well as track lists and play lists.
TRACK_TITLE_AND_ALBUM Reports the title and album of a track, returned when listing playlists or all tracks sorted by album, or in their default sort order when the DJ has set this as the default second column for track lists.
TRACK_TITLE_AND_ARTIST Reports the title and artist of a track, returned when listing playlists or all tracks sorted by artist, or in their default sort order when the DJ has set this as the default second column for track lists.
TRACK_TITLE_AND_BPM Reports the title and BPM of a track, returned when listing playlists or all tracks sorted by BPM, or in their default sort order when the DJ has set this as the default second column for track lists.
TRACK_TITLE_AND_COMMENT Reports the title and comment of a track, returned when listing playlists or all tracks sorted by comment, or in their default sort order when the DJ has set this as the default second column for track lists.
TRACK_TITLE_AND_DATE_ADDED Reports the title and date added of a track, returned when listing playlists or all tracks sorted by date added, or in their default sort order when the DJ has set this as the default second column for track lists.
TRACK_TITLE_AND_DJ_PLAY_COUNT Reports the title and play count of a track, returned when listing playlists or all tracks sorted by how many times the DJ has played the track, or in their default sort order when the DJ has set this as the default second column for track lists.
TRACK_TITLE_AND_GENRE Reports the title and genre of a track, returned when listing playlists or all tracks sorted by genre, or in their default sort order when the DJ has set this as the default second column for track lists.
TRACK_TITLE_AND_LABEL Reports the title and label of a track, returned when listing playlists or all tracks sorted by label, or in their default sort order when the DJ has set this as the default second column for track lists.
TRACK_TITLE_AND_ORIGINAL_ARTIST Reports the title and original artist of a track, returned when listing playlists sorted by original artist, or in their default sort order when listing all tracks and the DJ has set the original artist as the second column for track lists.
TRACK_TITLE_AND_RATE Reports the title and bit rate of a track, return when listing playlists or all tracks sorted by bit rate, or in their default sort order when the DJ has set this as the default second column for track lists.
TRACK_TITLE_AND_RATING Reports the title and rating of a track, returned when listing playlists or all tracks sorted by rating, or in their default sort order when the DJ has set this as the default second column for track lists.
TRACK_TITLE_AND_REMIXER Reports the title and remixer of a track, returned when listing playlists sorted by remixer, or in their default sort order when listing all tracks and the DJ has set this as the second column for track lists.
TRACK_TITLE_AND_TIME Reports the title and duration of a track, returned when listing playlists or all tracks sorted by time, or in their default sort order when the DJ has set this as the default second column for track lists.
UNKNOWN We received a value that we don't recognize, so we don't know what it contains.

Field Summary

Fields

Modifier and Type	Field and Description
long	protocolValue The value which identifies this type of menu item by appearing in the seventh argument of a Message.KnownType.MENU_ITEM response.

Method Summary

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

FOLDER

public static final Message.MenuItemType FOLDER

A potentially-nested grouping of other objects, such as a group of playlists in the playlists menu.

ALBUM_TITLE

public static final Message.MenuItemType ALBUM_TITLE

The string identifying the name of an album, part of the track metadata response. Also contains the album ID for listing by album.

DISC

public static final Message.MenuItemType DISC

I don’t yet know where this appears or what it means.

TRACK_TITLE

public static final Message.MenuItemType TRACK_TITLE

The string identifying the name of a track, part of the track metadata response, as well as track lists and play lists.

GENRE

public static final Message.MenuItemType GENRE

The string identifying the musical genre of a track, part of the track metadata response. Also contains the genre ID for listing by genre.

ARTIST

public static final Message.MenuItemType ARTIST

The string identifying the name of the artist for a track, part of the track metadata response, as well as track lists and play lists. Also contains the artist ID for listing by artist.

PLAYLIST

public static final Message.MenuItemType PLAYLIST

When listing playlists, reports the name and ID of an actual playlist, as opposed to a sub-folder.

RATING

public static final Message.MenuItemType RATING

The rating assigned a track by the DJ, part of the track metadata response.

DURATION

public static final Message.MenuItemType DURATION

The duration, in seconds, of a track, part of the track metadata response.

TEMPO

public static final Message.MenuItemType TEMPO

The tempo of a track, BPM times 100, part of the track metadata response.

LABEL

public static final Message.MenuItemType LABEL

A string containing the label that issued a track, part of the track metadata response. Also contains the label ID for listing by label.

KEY

public static final Message.MenuItemType KEY

A string containing the musical key of a track, part of the track metadata response. Also contains the key ID for listing by key.

COLOR_NONE

public static final Message.MenuItemType COLOR_NONE

Indicates the DJ has not assigned a color label to a track, part of the track metadata response.

COLOR_PINK

public static final Message.MenuItemType COLOR_PINK

A label assigned a track by the DJ, marked with a pink dot, part of the track metadata response.

COLOR_RED

public static final Message.MenuItemType COLOR_RED

A label assigned a track by the DJ, marked with a red dot, part of the track metadata response.

COLOR_ORANGE

public static final Message.MenuItemType COLOR_ORANGE

A label assigned a track by the DJ, marked with an orange dot, part of the track metadata response.

COLOR_YELLOW

public static final Message.MenuItemType COLOR_YELLOW

A label assigned a track by the DJ, marked with a yellow dot, part of the track metadata response.

COLOR_GREEN

public static final Message.MenuItemType COLOR_GREEN

A label assigned a track by the DJ, marked with a green dot, part of the track metadata response.

COLOR_AQUA

public static final Message.MenuItemType COLOR_AQUA

A label assigned a track by the DJ, marked with an aqua dot, part of the track metadata response.

COLOR_BLUE

public static final Message.MenuItemType COLOR_BLUE

A label assigned a track by the DJ, marked with a blue dot, part of the track metadata response.

COLOR_PURPLE

public static final Message.MenuItemType COLOR_PURPLE

A label assigned a track by the DJ, marked with a purple dot, part of the track metadata response.

COMMENT

public static final Message.MenuItemType COMMENT

An arbitrary text string assigned to a track by the DJ. Also contains a comment ID, for listing by comment.

ORIGINAL_ARTIST

public static final Message.MenuItemType ORIGINAL_ARTIST

The artist who originally recorded a track. Also contains an original artist ID, for listing by original artist.

REMIXER

public static final Message.MenuItemType REMIXER

The producer who remixed a track. Also contains a remixer ID, for listing by remixer.

DATE_ADDED

public static final Message.MenuItemType DATE_ADDED

A string reporting when the track was added to the collection, in the form "YYYY-MM-DD", part of the track metadata response. This seems to propagate from iTunes. Also contains a date added ID, for listing by date added.

TRACK_TITLE_AND_ALBUM

public static final Message.MenuItemType TRACK_TITLE_AND_ALBUM

Reports the title and album of a track, returned when listing playlists or all tracks sorted by album, or in their default sort order when the DJ has set this as the default second column for track lists.

TRACK_TITLE_AND_GENRE

public static final Message.MenuItemType TRACK_TITLE_AND_GENRE

Reports the title and genre of a track, returned when listing playlists or all tracks sorted by genre, or in their default sort order when the DJ has set this as the default second column for track lists.

TRACK_TITLE_AND_ARTIST

public static final Message.MenuItemType TRACK_TITLE_AND_ARTIST

Reports the title and artist of a track, returned when listing playlists or all tracks sorted by artist, or in their default sort order when the DJ has set this as the default second column for track lists.

TRACK_TITLE_AND_TIME

public static final Message.MenuItemType TRACK_TITLE_AND_TIME

Reports the title and duration of a track, returned when listing playlists or all tracks sorted by time, or in their default sort order when the DJ has set this as the default second column for track lists.

TRACK_TITLE_AND_RATING

public static final Message.MenuItemType TRACK_TITLE_AND_RATING

Reports the title and rating of a track, returned when listing playlists or all tracks sorted by rating, or in their default sort order when the DJ has set this as the default second column for track lists.

TRACK_TITLE_AND_BPM

public static final Message.MenuItemType TRACK_TITLE_AND_BPM

Reports the title and BPM of a track, returned when listing playlists or all tracks sorted by BPM, or in their default sort order when the DJ has set this as the default second column for track lists.

TRACK_TITLE_AND_LABEL

public static final Message.MenuItemType TRACK_TITLE_AND_LABEL

Reports the title and label of a track, returned when listing playlists or all tracks sorted by label, or in their default sort order when the DJ has set this as the default second column for track lists.

TRACK_TITLE_AND_RATE

public static final Message.MenuItemType TRACK_TITLE_AND_RATE

Reports the title and bit rate of a track, return when listing playlists or all tracks sorted by bit rate, or in their default sort order when the DJ has set this as the default second column for track lists.

TRACK_LIST_ENTRY_BY_COLOR

public static final Message.MenuItemType TRACK_LIST_ENTRY_BY_COLOR

Reports the title and color of a track, return when listing playlists or all tracks sorted by color, or in their default sort order when the DJ has set this as the default second column for track lists.

TRACK_TITLE_AND_COMMENT

public static final Message.MenuItemType TRACK_TITLE_AND_COMMENT

Reports the title and comment of a track, returned when listing playlists or all tracks sorted by comment, or in their default sort order when the DJ has set this as the default second column for track lists.

TRACK_TITLE_AND_ORIGINAL_ARTIST

public static final Message.MenuItemType TRACK_TITLE_AND_ORIGINAL_ARTIST

Reports the title and original artist of a track, returned when listing playlists sorted by original artist, or in their default sort order when listing all tracks and the DJ has set the original artist as the second column for track lists.

TRACK_TITLE_AND_REMIXER

public static final Message.MenuItemType TRACK_TITLE_AND_REMIXER

Reports the title and remixer of a track, returned when listing playlists sorted by remixer, or in their default sort order when listing all tracks and the DJ has set this as the second column for track lists.

TRACK_TITLE_AND_DJ_PLAY_COUNT

public static final Message.MenuItemType TRACK_TITLE_AND_DJ_PLAY_COUNT

Reports the title and play count of a track, returned when listing playlists or all tracks sorted by how many times the DJ has played the track, or in their default sort order when the DJ has set this as the default second column for track lists.

TRACK_TITLE_AND_DATE_ADDED

public static final Message.MenuItemType TRACK_TITLE_AND_DATE_ADDED

Reports the title and date added of a track, returned when listing playlists or all tracks sorted by date added, or in their default sort order when the DJ has set this as the default second column for track lists.

UNKNOWN

public static final Message.MenuItemType UNKNOWN

We received a value that we don't recognize, so we don't know what it contains.

Field Detail

protocolValue

public final long protocolValue

The value which identifies this type of menu item by appearing in the seventh argument of a Message.KnownType.MENU_ITEM response.

Method Detail

values

public static Message.MenuItemType[] 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.MenuItemType c : Message.MenuItemType.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.MenuItemType 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