Jukebox
Jukebox and SoundMachine furniture: playlist management and now-playing state.
C→S 1325 - JukeBoxRequestPlayList
Nitro:
GET_NOW_PLAYINGSource:
JukeBoxRequestPlayListEvent,GetNowPlayingMessageComposer
Requests the current jukebox playlist for the room.
Body: (empty)
C→S 753 - JukeBoxAddSoundTrack
Nitro:
ADD_JUKEBOX_DISKSource:
JukeBoxAddSoundTrackEvent,AddJukeboxDiskComposer
Adds a song disk from inventory to the room's jukebox at the specified playlist slot.
Body:
itemId: int
C→S 3050 - JukeBoxRemoveSoundTrack
Nitro:
REMOVE_JUKEBOX_DISKSource:
JukeBoxRemoveSoundTrackEvent,RemoveJukeboxDiskComposer
Removes a track from the jukebox playlist by index.
Body: (empty)
C→S 3082 - JukeBoxRequestTrackData
Nitro:
GET_SONG_INFOSource:
JukeBoxRequestTrackDataEvent,GetSongInfoMessageComposer
Requests metadata for one or more jukebox tracks by ID.
Body:
count: int
C→S 3189 - JukeBoxRequestTrackCode
Nitro:
GET_OFFICIAL_SONG_IDSource:
JukeBoxRequestTrackCodeEvent,GetOfficialSongIdMessageComposer
Requests the official song ID string for a given song name.
Body: (empty)
C→S 1435 - JukeBoxTwo
Nitro:
GET_JUKEBOX_PLAYLISTSource:
JukeBoxEventTwo,GetJukeboxPlayListMessageComposer
Requests the current jukebox playlist contents.
Body: (empty)
C→S 2304 - JukeBoxOne
Nitro:
GET_USER_SONG_DISKSSource:
JukeBoxEventOne,GetUserSongDisksMessageComposer
Body:
(empty)
Requests the user's personal song disk inventory.
S→C 34 - JukeboxSongDisks
Nitro:
JUKEBOX_SONG_DISKSSource:JukeBoxPlayListComposer,JukeboxSongDisksMessageEvent
| Field | Type | Notes |
|---|---|---|
| maxLength | int | Maximum number of disks allowed in jukebox |
| count | int | Number of disk entries |
| [count × songId] | int | Song ID |
| [count × diskCount] | int | Number of disks of that song ID |
Delivers the list of music disc items in the room's jukebox/sound machine.
S→C 1748 - Playlist
Nitro:
PLAYLISTSource:JukeBoxPlayListUpdatedComposer,PlayListMessageEvent
| Field | Type | Notes |
|---|---|---|
| syncCount | int | Synchronisation counter |
| count | int | Number of playlist entries |
| [count × songId] | int | Song ID |
| [count × length] | int | Song length in milliseconds |
| [count × name] | string | Song name |
| [count × creator] | string | Song creator name |
Delivers the current jukebox playlist (song IDs queued for playback).
S→C 1140 - PlaylistSongAdded
Nitro:
PLAYLIST_SONG_ADDEDSource:JukeBoxPlayListAddSongComposer,PlayListSongAddedMessageEvent
| Field | Type | Notes |
|---|---|---|
| songId | int | Song ID added to the playlist |
| length | int | Song length in milliseconds |
| name | string | Song name |
| creator | string | Song creator name |
Notifies clients that a song was added to the jukebox playlist.
S→C 105 - JukeboxPlaylistFull
Nitro:
JUKEBOX_PLAYLIST_FULLSource:JukeBoxPlaylistFullComposer,JukeboxPlayListFullMessageEvent
(no Arcturus composer)
Sent when the jukebox playlist is full and cannot accept more tracks.
Notifies the client that the jukebox playlist is full and no more tracks can be added.
Body: (empty)
S→C 469 - NowPlaying
Nitro:
NOW_PLAYINGSource:JukeBoxNowPlayingMessageComposer,NowPlayingMessageEvent
| Field | Type | Notes |
|---|---|---|
| currentSongId | int | Song ID currently playing (-1 = none) |
| currentPosition | int | Playback position in milliseconds |
| nextSongId | int | Song ID queued next (-1 = none) |
| nextPosition | int | Start position for next song |
| syncCount | int | Sync counter for client/server alignment |
Notifies clients of the currently playing song in the jukebox.
S→C 3365 - TraxSongInfo
Nitro:
TRAX_SONG_INFOSource:JukeBoxTrackDataComposer,TraxSongInfoMessageEvent
| Field | Type | Notes |
|---|---|---|
| count | int | Number of song info entries |
| [count × songId] | int | Song ID |
| [count × _unknown] | string | Unknown string |
| [count × name] | string | Song name |
| [count × data] | string | Song data string |
| [count × length] | int | Song length in milliseconds |
| [count × creator] | string | Song creator name |
Delivers metadata (title, artist, ID) for a trax music track.
S→C 1381 - OfficialSongId
Nitro:
OFFICIAL_SONG_IDSource:JukeBoxTrackCodeComposer,OfficialSongIdMessageEvent
| Field | Type | Notes |
|---|---|---|
| officialSongId | string | Official song identifier string |
| songId | int | Jukebox song ID |
Delivers the official song identifier string mapped to a jukebox song ID, used to resolve track metadata.