jellyfin-api/org.jellyfin.sdk.api.operations/PlayStateApi

PlayStateApi

class PlayStateApi(api: ApiClient) : Api

Constructors

Link copied to clipboard
constructor(api: ApiClient)

Functions

Link copied to clipboard
suspend fun markPlayedItem(itemId: <Error class: unknown class>, userId: <Error class: unknown class>? = null, datePlayed: <Error class: unknown class>? = null): Response<<Error class: unknown class>>

Marks an item as played for user.

Link copied to clipboard
suspend fun markUnplayedItem(itemId: <Error class: unknown class>, userId: <Error class: unknown class>? = null): Response<<Error class: unknown class>>

Marks an item as unplayed for user.

Link copied to clipboard
suspend fun onPlaybackProgress(request: <Error class: unknown class>): Response<Unit>
suspend fun onPlaybackProgress(itemId: <Error class: unknown class>, mediaSourceId: String? = null, positionTicks: Long? = null, audioStreamIndex: Int? = null, subtitleStreamIndex: Int? = null, volumeLevel: Int? = null, playMethod: <Error class: unknown class>? = null, liveStreamId: String? = null, playSessionId: String? = null, repeatMode: <Error class: unknown class>? = null, isPaused: Boolean? = false, isMuted: Boolean? = false): Response<Unit>

Reports a session's playback progress.

Link copied to clipboard
suspend fun onPlaybackStart(request: <Error class: unknown class>): Response<Unit>
suspend fun onPlaybackStart(itemId: <Error class: unknown class>, mediaSourceId: String? = null, audioStreamIndex: Int? = null, subtitleStreamIndex: Int? = null, playMethod: <Error class: unknown class>? = null, liveStreamId: String? = null, playSessionId: String? = null, canSeek: Boolean? = false): Response<Unit>

Reports that a session has begun playing an item.

Link copied to clipboard
suspend fun onPlaybackStopped(request: <Error class: unknown class>): Response<Unit>
suspend fun onPlaybackStopped(itemId: <Error class: unknown class>, mediaSourceId: String? = null, nextMediaType: String? = null, positionTicks: Long? = null, liveStreamId: String? = null, playSessionId: String? = null): Response<Unit>

Reports that a session has stopped playing an item.

Link copied to clipboard
suspend fun pingPlaybackSession(playSessionId: String): Response<Unit>

Pings a playback session.

Link copied to clipboard
suspend fun reportPlaybackProgress(data: <Error class: unknown class>? = null): Response<Unit>

Reports playback progress within a session.

Link copied to clipboard
suspend fun reportPlaybackStart(data: <Error class: unknown class>? = null): Response<Unit>

Reports playback has started within a session.

Link copied to clipboard
suspend fun reportPlaybackStopped(data: <Error class: unknown class>? = null): Response<Unit>

Reports playback has stopped within a session.