PlayStateApi

class PlayStateApi(api: ApiClient) : Api

Constructors

Link copied to clipboard
constructor(api: ApiClient)

Functions

Link copied to clipboard
suspend fun markPlayedItem(itemId: UUID, userId: UUID? = null, datePlayed: DateTime? = null): Response<UserItemDataDto>

Marks an item as played for user.

Link copied to clipboard
suspend fun markUnplayedItem(itemId: UUID, userId: UUID? = null): Response<UserItemDataDto>

Marks an item as unplayed for user.

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

Reports a session's playback progress.

Link copied to clipboard
suspend fun onPlaybackStart(itemId: UUID, mediaSourceId: String? = null, audioStreamIndex: Int? = null, subtitleStreamIndex: Int? = null, playMethod: PlayMethod? = 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(itemId: UUID, 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

Reports playback progress within a session.

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

Reports playback has started within a session.

Link copied to clipboard

Reports playback has stopped within a session.