v1

latestOpenAPI 3.1.02026-07-246652306.5 KB

playbackSession

skipToItem

Use the skipToItem command in the playbackSession namespace to skip to the track with the specified itemId in a cloud queue and optionally seek and initiate playback. This command requires your app to have either created a new session or joined an existing session, and also loaded a cloud queue on the group with loadCloudQueue.

Use playOnCompletion to start playing the cloud queue item being loaded, so your app doesn’t have to send an extra play command.

Most of the times your app already has access to the track metadata of the cloud queue item that is being loaded. Use the optional trackMetadata parameter to provide that information so the group can start playing the track immediately after receiving the loadCloudQueue command. This optimization improves the user experience by starting playback before the player fetches tracks from the cloud queue server.

post/playbackSessions/{sessionId}/playbackSession/skipToItem

Request body

itemIdstring required

The identifier for the track. This is required, but does not need to be a value. If it is an empty string, the group will skip to the beginning of the queue.

queueVersionstring nullable

(Optional) An opaque identifier used to indicate the change state of the contents in the cloud queue. For example, if the list of tracks in the cloud queue change, the cloud queue server would change the queueVersion. The player stores this value and can pass it back in the GET /itemWindow request.

positionMillisinteger nullable

(Optional) Position within track in milliseconds. If you omit this parameter and send a different itemId than the one that is currently playing, the player assumes that the positionMillis is zero. If you omit this parameter and send the itemId that is currently playing, the player does not change the position, and continues playing.

playOnCompletionboolean nullable

(Optional) Start playback after loading.

Response

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

Ok required

This object represents an empty (default) success. The platform returns an empty object ({}).