Skip to main content

Jukebox

Jukebox and SoundMachine furniture: playlist management and now-playing state.

C→S 1325 - JukeBoxRequestPlayList​

Nitro: GET_NOW_PLAYING

Source: JukeBoxRequestPlayListEvent, GetNowPlayingMessageComposer

Requests the current jukebox playlist for the room.

Body: (empty)

C→S 753 - JukeBoxAddSoundTrack​

Nitro: ADD_JUKEBOX_DISK

Source: 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_DISK

Source: JukeBoxRemoveSoundTrackEvent, RemoveJukeboxDiskComposer

Removes a track from the jukebox playlist by index.

Body: (empty)

C→S 3082 - JukeBoxRequestTrackData​

Nitro: GET_SONG_INFO

Source: JukeBoxRequestTrackDataEvent, GetSongInfoMessageComposer

Requests metadata for one or more jukebox tracks by ID.

Body:
count: int

C→S 3189 - JukeBoxRequestTrackCode​

Nitro: GET_OFFICIAL_SONG_ID

Source: JukeBoxRequestTrackCodeEvent, GetOfficialSongIdMessageComposer

Requests the official song ID string for a given song name.

Body: (empty)

C→S 1435 - JukeBoxTwo​

Nitro: GET_JUKEBOX_PLAYLIST

Source: JukeBoxEventTwo, GetJukeboxPlayListMessageComposer

Requests the current jukebox playlist contents.

Body: (empty)

C→S 2304 - JukeBoxOne​

Nitro: GET_USER_SONG_DISKS

Source: JukeBoxEventOne, GetUserSongDisksMessageComposer

Body:
(empty)

Requests the user's personal song disk inventory.

S→C 34 - JukeboxSongDisks​

Nitro: JUKEBOX_SONG_DISKS Source: JukeBoxPlayListComposer, JukeboxSongDisksMessageEvent

FieldTypeNotes
maxLengthintMaximum number of disks allowed in jukebox
countintNumber of disk entries
[count × songId]intSong ID
[count × diskCount]intNumber 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: PLAYLIST Source: JukeBoxPlayListUpdatedComposer, PlayListMessageEvent

FieldTypeNotes
syncCountintSynchronisation counter
countintNumber of playlist entries
[count × songId]intSong ID
[count × length]intSong length in milliseconds
[count × name]stringSong name
[count × creator]stringSong creator name

Delivers the current jukebox playlist (song IDs queued for playback).

S→C 1140 - PlaylistSongAdded​

Nitro: PLAYLIST_SONG_ADDED Source: JukeBoxPlayListAddSongComposer, PlayListSongAddedMessageEvent

FieldTypeNotes
songIdintSong ID added to the playlist
lengthintSong length in milliseconds
namestringSong name
creatorstringSong creator name

Notifies clients that a song was added to the jukebox playlist.

S→C 105 - JukeboxPlaylistFull​

Nitro: JUKEBOX_PLAYLIST_FULL Source: 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_PLAYING Source: JukeBoxNowPlayingMessageComposer, NowPlayingMessageEvent

FieldTypeNotes
currentSongIdintSong ID currently playing (-1 = none)
currentPositionintPlayback position in milliseconds
nextSongIdintSong ID queued next (-1 = none)
nextPositionintStart position for next song
syncCountintSync counter for client/server alignment

Notifies clients of the currently playing song in the jukebox.

S→C 3365 - TraxSongInfo​

Nitro: TRAX_SONG_INFO Source: JukeBoxTrackDataComposer, TraxSongInfoMessageEvent

FieldTypeNotes
countintNumber of song info entries
[count × songId]intSong ID
[count × _unknown]stringUnknown string
[count × name]stringSong name
[count × data]stringSong data string
[count × length]intSong length in milliseconds
[count × creator]stringSong creator name

Delivers metadata (title, artist, ID) for a trax music track.

S→C 1381 - OfficialSongId​

Nitro: OFFICIAL_SONG_ID Source: JukeBoxTrackCodeComposer, OfficialSongIdMessageEvent

FieldTypeNotes
officialSongIdstringOfficial song identifier string
songIdintJukebox song ID

Delivers the official song identifier string mapped to a jukebox song ID, used to resolve track metadata.