playbackSession > refreshCloudQueue

Use the refreshCloudQueue command in the playbackSession namespace to signal the player to re-fetch tracks from the cloud queue server centered around the current item. See the Cloud Queue API /itemWindow endpoint for details.

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.

Your app should only use this command when it detects a change in the cloud queue content that should immediately be reflected in the group. For example, if a user removes the currently playing track with your app, use this command to remove the track from the group and stop it from playing. This helps provide a good user experience.



Request Parameters

There are no request parameters in the body, all of the request parameters are in the header.

This command requires a sessionId to determine the target of the command. See the Control documentation for details.


Returns an empty body with a success value of true if successful. 

In the event of a failure, returns a sessionError or a globalError.