Skip to content

Commit 40ffa1f

Browse files
JRpersonalclaude
authored andcommitted
docs(api): note that shuffle_context before play starts on a random track
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>
1 parent d628f73 commit 40ffa1f

1 file changed

Lines changed: 10 additions & 2 deletions

File tree

api-spec.yml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,12 @@ paths:
127127
description: Successful response
128128
/player/play:
129129
post:
130-
description: Starts playing new content
130+
description: >-
131+
Starts playing new content. To start a context shuffled (on a random
132+
track), enable shuffle first via /player/shuffle_context and then call
133+
this. Calling /player/shuffle_context after play only shuffles the
134+
upcoming queue and keeps the current (first) track, so play alone (or
135+
shuffle after play) always begins on the context's first track.
131136
requestBody:
132137
$ref: '#/components/schemas/play'
133138
responses:
@@ -268,7 +273,10 @@ paths:
268273
description: Successful response
269274
/player/shuffle_context:
270275
post:
271-
description: Toggle shuffling context
276+
description: >-
277+
Toggle shuffling the context. Enabling it BEFORE /player/play makes
278+
playback start on a random track; enabling it after play only reshuffles
279+
the upcoming queue and keeps the current (first) track.
272280
requestBody:
273281
content:
274282
application/json:

0 commit comments

Comments
 (0)