postUsersByUseridPlayingitemsByIdProgress
Reports a user's playback progress
Requires authentication as user
postUsersByUseridPlayingitemsByIdProgress
Request
post /Users/{UserId}/PlayingItems/{Id}/Progress
Parameters
| Name | In | Type | Default | Notes |
|---|---|---|---|---|
| *UserId | path | User Id |
||
| *Id | path | Item Id |
||
| *MediaSourceId | query | The id of the MediaSource |
||
| PositionTicks | query | Optional. The current position, in ticks. 1ms = 10000 ticks. |
||
| IsPaused | query | Indicates if the player is paused. |
||
| IsMuted | query | Indicates if the player is muted. |
||
| AudioStreamIndex | query | |||
| SubtitleStreamIndex | query | |||
| VolumeLevel | query | Scale of 0-100 |
||
| PlayMethod | query | |||
| LiveStreamId | query | |||
| PlaySessionId | query | |||
| RepeatMode | query | |||
| SubtitleOffset | query | |||
| PlaybackRate | query | |||
| *body | body | OnPlaybackProgress | OnPlaybackProgress |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 | Operation successful. Empty response. |
||
| 400 | Bad Request. Server cannot process request. |
||
| 401 | Unauthorized. Client needs to authenticate. |
||
| 403 | Forbidden. No permission for the reqested operation. |
||
| 404 | Resource not found or unavailable. |
||
| 500 | Server error. |
Definitions
OnPlaybackProgress
Emby.Server.MediaEncoding.Api.OnPlaybackProgress
| Name | Type | Notes |
|---|---|---|
| PlaylistIndex | integer (int32) | |
| PlaylistLength | integer (int32) | |
| Shuffle | boolean | |
| SleepTimerMode | SleepTimerMode | |
| SleepTimerEndTime | string (date-time) | |
| EventName | ProgressEvent |
SleepTimerMode
Enum Values
- None
- AfterItem
- AtTime
ProgressEvent
Enum Values
- TimeUpdate
- Pause
- Unpause
- VolumeChange
- RepeatModeChange
- AudioTrackChange
- SubtitleTrackChange
- PlaylistItemMove
- PlaylistItemRemove
- PlaylistItemAdd
- QualityChange
- StateChange
- SubtitleOffsetChange
- PlaybackRateChange
- ShuffleChange
- SleepTimerChange