docs(api): note that shuffle_context before play starts on a random track#314
Merged
devgianlu merged 1 commit intoJun 5, 2026
Merged
Conversation
…rack The HTTP API did not document how to start a context shuffled (on a random first track). Document it on /player/play and /player/shuffle_context: enabling shuffle_context before /player/play starts playback on a random track, while enabling it after play only reshuffles the upcoming queue and keeps the current (first) track. Verified at runtime: three consecutive shuffle_context-then-play calls each started on a different track. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
The HTTP API spec does not describe how to start a context shuffled (i.e. on a random first track). This adds that note to
/player/playand/player/shuffle_context.Observed behaviour
POST /player/play {uri}alone starts on the context's first track.POST /player/shuffle_context {shuffle_context: true}after play only randomizes the upcoming queue; the current track stays the first one.POST /player/shuffle_context {shuffle_context: true}beforePOST /player/play {uri}starts playback on a random track of the context.Verified at runtime (armv7l): three consecutive
shuffle_context-then-playcalls each started on a different track.Change
Docs only: extends the
descriptionof/player/playand/player/shuffle_contextinapi-spec.yml. No code changes.