v1
latestOpenAPI 3.0.12026-07-134082641.7 MBPlaystate
Reports a user's playback progress.
post/Users/{userId}/PlayingItems/{itemId}/Progress
Path parameters
userIdstring uuid required
User id.
User id.
itemIdstring uuid required
Item id.
Item id.
Query parameters
mediaSourceIdstring nullable
The id of the MediaSource.
The id of the MediaSource.
positionTicksinteger nullable
Optional. The current position, in ticks. 1 tick = 10000 ms.
Optional. The current position, in ticks. 1 tick = 10000 ms.
audioStreamIndexinteger nullable
The audio stream index.
The audio stream index.
subtitleStreamIndexinteger nullable
The subtitle stream index.
The subtitle stream index.
volumeLevelinteger nullable
Scale of 0-100.
Scale of 0-100.
playMethod'Transcode' | 'DirectStream' | 'DirectPlay'
The play method.
liveStreamIdstring nullable
The live stream id.
The live stream id.
playSessionIdstring nullable
The play session id.
The play session id.
repeatMode'RepeatNone' | 'RepeatAll' | 'RepeatOne'
The repeat mode.
isPausedboolean
Indicates if the player is paused.
Indicates if the player is paused.
isMutedboolean
Indicates if the player is muted.
Indicates if the player is muted.
Response
Play progress recorded.