v1

latestOpenAPI 3.1.02026-07-246652306.5 KB
playback

getPlaybackStatus

Use the getPlaybackStatus command in the playback namespace get the current playback status (transport state) for the group, such as PLAYBACK_STATE_IDLE, PLAYBACK_STATE_BUFFERING, or PLAYBACK_STATE_PLAYING. See the playbackStatus object for details.

get/groups/{groupId}/playback

Response

See the x-muse-error-codes extension for a list of muse errors that generate this response

playbackState'PLAYBACK_STATE_IDLE' | 'PLAYBACK_STATE_BUFFERING' | 'PLAYBACK_STATE_PAUSED' | 'PLAYBACK_STATE_PLAYING' required

No description available

isDuckingboolean

A snapshot of the player volume ducking state. When the player is ducked, it lowers the volume of one stream so that another can play over it at a louder volume. A value of true means that the player is currently ducked. A value of false means that the player is not ducked. This attribute does not generate new playbackStatus events.

queueVersionstring nullable

The last queue version change identifier. This version will contextually mean different things depending on which type of queue is supporting the current playback. If the active queue doesn't support versioning (and is opaque to users/clients) then this field will be omitted.

If the public/shared queue is currently active, then this is an increasing integer that changes every time an add, edit, or remove track of any kind occurs to that queue's contents.

If a Cloud Queue is currently active, this could have been from:

  • the last GET /itemWindow or GET /version response.
  • a loadCloudQueue or skipToItem response. This is omitted when the value is unknown, for example, if the CQ server did not respond to a query.
itemIdstring nullable

The item identifier of the current track, if the audio source is a cloud queue.

positionMillisinteger nullable

The offset position within the current track in milliseconds.

previousItemIdstring nullable

The ID of the item prior to a playback state change. This indicates what was playing when an action triggered the playbackStatus event.

previousPositionMillisinteger nullable

The last position in the previous item.