Skip to content

Queue Tools

Eight tools manage the playback queue.

fb2k_queue_get

Gets every item in the playback queue.

  • Parameters: none
  • Bridge method: queue.get

Example result:

json
{
  "items": [
    {
      "queueIndex": 0,
      "path": "file://D:\\\\Music\\\\track.flac",
      "absolutePath": "D:\\\\Music\\\\track.flac",
      "subsong": 0,
      "fileSize": 28456789,
      "title": "Redo",
      "artist": "164",
      "album": "Millennium Mother",
      "albumArtist": "164",
      "genre": "Vocaloid",
      "date": "2011",
      "trackNumber": 1,
      "discNumber": 1,
      "duration": 263.5,
      "bitrate": 876,
      "sampleRate": 44100,
      "channels": 2,
      "codec": "FLAC",
      "playlist": 0,
      "playlistItem": 5
    }
  ],
  "count": 1
}
FieldTypeDescription
queueIndexintegerPosition in the queue
playlistintegerSource playlist index
playlistItemintegerSource item index
Track fieldsSame track-data family as playback.getCurrentTrack

fb2k_queue_add

Adds one or more playlist items to the queue.

  • Bridge method: queue.add
ParameterTypeRequiredDescription
playlistintegerNoSource playlist; the Bridge defaults to the active playlist
tracksinteger[]ConditionalTrack indices for batch addition
trackintegerConditionalOne track index as an alternative to tracks

Conditional input

Supply either tracks or track. The MCP schema leaves both optional because the exclusivity rule is enforced by the Bridge handler.

fb2k_queue_add_paths

Adds file paths or URLs to the queue.

  • Bridge method: queue.addPaths
ParameterTypeRequiredDescription
pathsstring[]YesFile paths or URLs, optionally using `path
useQueuePlaylistbooleanNoUse the dedicated queue playlist; default true
playlistintegerNoTarget playlist, used when useQueuePlaylist is false

fb2k_queue_remove

Removes one or more queue positions.

  • Bridge method: queue.remove
ParameterTypeRequiredConstraints
indexintegerConditionalOne queue index; minimum 0
indicesinteger[]ConditionalQueue indices as an alternative to index

fb2k_queue_clear

Clears the playback queue.

  • Parameters: none
  • Bridge method: queue.clear

fb2k_queue_get_count

Gets the queue item count.

  • Parameters: none
  • Bridge method: queue.getCount

Example result:

json
{ "count": 3, "hasItems": true }
FieldTypeDescription
countintegerQueue item count
hasItemsbooleanWhether the queue is non-empty

fb2k_queue_move_to_top

Moves a queue item to the top so it plays next.

  • Bridge method: queue.moveToTop
ParameterTypeRequiredConstraints
indexintegerYesQueue index; minimum 0

fb2k_queue_flush

Flushes the playback queue. The mapped Bridge method is an alias of queue.clear.

  • Parameters: none
  • Bridge method: queue.flush