Message.KnownType (beat-link 0.3.7 API)

java.lang.Object
- java.lang.Enum<Message.KnownType>
- - org.deepsymmetry.beatlink.dbserver.Message.KnownType

All Implemented Interfaces:

Serializable, Comparable<Message.KnownType>

Enclosing class:

Message
```
public static enum Message.KnownType
extends Enum<Message.KnownType>
```
Defines all the message types we know about, with any information we know about their arguments.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ALBUM_ART` This response contains the binary image data of requested album art.
`ALBUM_ART_REQ` Asks for an album artwork image, by artwork ID.
`ARTIST_LIST_REQ` Asks for a list of artists in the specified media slot.
`BEAT_GRID` Returns information about the beat number (within a bar) and millisecond position within the track of each beat in a track.
`BEAT_GRID_REQ` Asks for the beat grid of a track, by rekordbox id.
`CD_METADATA_REQ` Asks for metadata about a CD track, by track number.
`CUE_LIST` Returns information about any cue points set in the track.
`CUE_LIST_REQ` Asks for the cue points of a track, by rekordbox ID.
`INVALID_DATA` A response indicating that a request could not be fulfilled for some reason.
`MENU_AVAILABLE` This response indicates that a query has been accepted, and reports how many results are available.
`MENU_FOOTER` When `RENDER_MENU_REQ` is used to retrieve a set of results, this message will be sent as the final response, following any `MENU_ITEM` messages that were requested.
`MENU_HEADER` When `RENDER_MENU_REQ` is used to retrieve a set of results, this message will be sent as the first response, followed by as many `MENU_ITEM` messages as were requested.
`MENU_ITEM` A series of messages of this type are the payload returned in response to `RENDER_MENU_REQ`.
`METADATA_REQ` Asks for the metadata associated with a particular track, by rekordbox ID.
`PLAYLIST_REQ` Asks for a playlist or folder by ID.
`RENDER_MENU_REQ` Once a specific type of request has been made and acknowledged, this allows the results to be retrieved, possibly in paginated chunks starting at offset, returning up to limit results.
`ROOT_MENU_REQ` Asks for the top-level menu of the player.
`SETUP_REQ` The special initial request that is sent as the second action after opening a new connection, to enable further database queries.
`TRACK_LIST_REQ` Asks for a list of all the tracks in the specified media slot.
`UNAVAILABLE` Indicates that the item that was just requested cannot be found.
`WAVE_DETAIL` Returns the bytes of the detailed waveform which is scrolled through while the track is playing.
`WAVE_DETAIL_REQ` Asks for the detailed waveform data for a track, by rekordbox ID.
`WAVE_PREVIEW` Returns the bytes of the small waveform preview to be displayed at the bottom of the player display, or in rekordbox track lists.
`WAVE_PREVIEW_REQ` Asks for the preview (summary) waveform data for a track, by rekordbox ID.

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`description` The descriptive name of the message type.
`long`	`protocolValue` The numeric value that identifies this message type, by its presence in a 4-byte number field immediately following the message start indicator.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`arguments()` Returns the descriptions of all known arguments, in order.
`String`	`describeArgument(int index)` Get the descriptive name of the specified message argument, if one is known.
`static Message.KnownType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Message.KnownType[]`	`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
  - SETUP_REQ
```
public static final Message.KnownType SETUP_REQ
```
    The special initial request that is sent as the second action after opening a new connection, to enable further database queries.
  - INVALID_DATA
```
public static final Message.KnownType INVALID_DATA
```
    A response indicating that a request could not be fulfilled for some reason.
  - ROOT_MENU_REQ
```
public static final Message.KnownType ROOT_MENU_REQ
```
    Asks for the top-level menu of the player.
  - ARTIST_LIST_REQ
```
public static final Message.KnownType ARTIST_LIST_REQ
```
    Asks for a list of artists in the specified media slot.
  - TRACK_LIST_REQ
```
public static final Message.KnownType TRACK_LIST_REQ
```
    Asks for a list of all the tracks in the specified media slot.
  - PLAYLIST_REQ
```
public static final Message.KnownType PLAYLIST_REQ
```
    Asks for a playlist or folder by ID.
  - METADATA_REQ
```
public static final Message.KnownType METADATA_REQ
```
    Asks for the metadata associated with a particular track, by rekordbox ID.
  - ALBUM_ART_REQ
```
public static final Message.KnownType ALBUM_ART_REQ
```
    Asks for an album artwork image, by artwork ID.
  - WAVE_PREVIEW_REQ
```
public static final Message.KnownType WAVE_PREVIEW_REQ
```
    Asks for the preview (summary) waveform data for a track, by rekordbox ID.
  - CUE_LIST_REQ
```
public static final Message.KnownType CUE_LIST_REQ
```
    Asks for the cue points of a track, by rekordbox ID.
  - CD_METADATA_REQ
```
public static final Message.KnownType CD_METADATA_REQ
```
    Asks for metadata about a CD track, by track number.
  - BEAT_GRID_REQ
```
public static final Message.KnownType BEAT_GRID_REQ
```
    Asks for the beat grid of a track, by rekordbox id.
  - WAVE_DETAIL_REQ
```
public static final Message.KnownType WAVE_DETAIL_REQ
```
    Asks for the detailed waveform data for a track, by rekordbox ID.
  - RENDER_MENU_REQ
```
public static final Message.KnownType RENDER_MENU_REQ
```
    Once a specific type of request has been made and acknowledged, this allows the results to be retrieved, possibly in paginated chunks starting at offset, returning up to limit results.
  - MENU_AVAILABLE
```
public static final Message.KnownType MENU_AVAILABLE
```
    This response indicates that a query has been accepted, and reports how many results are available. They are now ready to be retrieved using RENDER_MENU_REQ.
  - MENU_HEADER
```
public static final Message.KnownType MENU_HEADER
```
    When RENDER_MENU_REQ is used to retrieve a set of results, this message will be sent as the first response, followed by as many MENU_ITEM messages as were requested.
  - ALBUM_ART
```
public static final Message.KnownType ALBUM_ART
```
    This response contains the binary image data of requested album art.
  - UNAVAILABLE
```
public static final Message.KnownType UNAVAILABLE
```
    Indicates that the item that was just requested cannot be found.
  - MENU_ITEM
```
public static final Message.KnownType MENU_ITEM
```
    A series of messages of this type are the payload returned in response to RENDER_MENU_REQ. The number requested will be delivered, in between a MENU_HEADER and a MENU_FOOTER message. Each message will be of a particular subtype, which is identified by the value of the 7th argument; see Message.MenuItemType for known values.
  - MENU_FOOTER
```
public static final Message.KnownType MENU_FOOTER
```
    When RENDER_MENU_REQ is used to retrieve a set of results, this message will be sent as the final response, following any MENU_ITEM messages that were requested.
  - WAVE_PREVIEW
```
public static final Message.KnownType WAVE_PREVIEW
```
    Returns the bytes of the small waveform preview to be displayed at the bottom of the player display, or in rekordbox track lists.
  - BEAT_GRID
```
public static final Message.KnownType BEAT_GRID
```
    Returns information about the beat number (within a bar) and millisecond position within the track of each beat in a track.
  - CUE_LIST
```
public static final Message.KnownType CUE_LIST
```
    Returns information about any cue points set in the track.
  - WAVE_DETAIL
```
public static final Message.KnownType WAVE_DETAIL
```
    Returns the bytes of the detailed waveform which is scrolled through while the track is playing.
- Field Detail
  - protocolValue
```
public final long protocolValue
```
    The numeric value that identifies this message type, by its presence in a 4-byte number field immediately following the message start indicator.
  - description
```
public final String description
```
    The descriptive name of the message type.
- Method Detail
  - values
```
public static Message.KnownType[] 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.KnownType c : Message.KnownType.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.KnownType 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
  - describeArgument
```
public String describeArgument(int index)
```
    Get the descriptive name of the specified message argument, if one is known.
    
    Parameters:
    
    index - the zero-based index identifying the argument whose description is desired.
    
    Returns:
    
    either the description found, or "unknown" if none was found.
  - arguments
```
public List<String> arguments()
```
    Returns the descriptions of all known arguments, in order.
    
    Returns:
    
    a list of the descriptions of the arguments that are expected for this message type.

Enum Message.KnownType

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

SETUP_REQ

INVALID_DATA

ROOT_MENU_REQ

ARTIST_LIST_REQ

TRACK_LIST_REQ

PLAYLIST_REQ

METADATA_REQ

ALBUM_ART_REQ

WAVE_PREVIEW_REQ

CUE_LIST_REQ

CD_METADATA_REQ

BEAT_GRID_REQ

WAVE_DETAIL_REQ

RENDER_MENU_REQ

MENU_AVAILABLE

MENU_HEADER

ALBUM_ART

UNAVAILABLE

MENU_ITEM

MENU_FOOTER

WAVE_PREVIEW

BEAT_GRID

CUE_LIST

WAVE_DETAIL

Field Detail

protocolValue

description

Method Detail

values

valueOf

describeArgument

arguments