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

SessionApi

class SessionApi(api: ApiClient) : Api

Constructors

SessionApi

constructor(api: ApiClient)

Functions

addUserToSession

suspend fun addUserToSession(sessionId: String, userId: UUID): Response<Unit>

Adds an additional user to a session.

displayContent

suspend fun displayContent(sessionId: String, itemType: BaseItemKind, itemId: String, itemName: String): Response<Unit>

Instructs a session to browse to an item or view.

getSessions

suspend fun getSessions(controllableByUserId: UUID? = null, deviceId: String? = null, activeWithinSeconds: Int? = null): Response<List<SessionInfoDto>>

Gets a list of sessions.

pingPlaybackSession

suspend fun pingPlaybackSession(playSessionId: String): Response<Unit>

Pings a playback session.

play

suspend fun play(request: PlayRequest): Response<Unit>

suspend fun play(sessionId: String, playCommand: PlayCommand, itemIds: Collection<UUID> = emptyList(), startPositionTicks: Long? = null, mediaSourceId: String? = null, audioStreamIndex: Int? = null, subtitleStreamIndex: Int? = null, startIndex: Int? = null): Response<Unit>

Instructs a session to play an item.

postCapabilities

suspend fun postCapabilities(request: PostCapabilitiesRequest = PostCapabilitiesRequest()): Response<Unit>

suspend fun postCapabilities(id: String? = null, playableMediaTypes: Collection<MediaType>? = emptyList(), supportedCommands: Collection<GeneralCommandType>? = emptyList(), supportsMediaControl: Boolean? = false, supportsPersistentIdentifier: Boolean? = true): Response<Unit>

Updates capabilities for a device.

postFullCapabilities

suspend fun postFullCapabilities(id: String? = null, data: ClientCapabilitiesDto): Response<Unit>

Updates capabilities for a device.

removeUserFromSession

suspend fun removeUserFromSession(sessionId: String, userId: UUID): Response<Unit>

Removes an additional user from a session.

reportPlaybackProgress

suspend fun reportPlaybackProgress(data: PlaybackProgressInfo? = null): Response<Unit>

Reports playback progress within a session.

reportPlaybackStart

suspend fun reportPlaybackStart(data: PlaybackStartInfo? = null): Response<Unit>

Reports playback has started within a session.

reportPlaybackStopped

suspend fun reportPlaybackStopped(data: PlaybackStopInfo? = null): Response<Unit>

Reports playback has stopped within a session.

reportSessionEnded

suspend fun reportSessionEnded(): Response<Unit>

Reports that a session has ended.

reportViewing

suspend fun reportViewing(sessionId: String? = null, itemId: String): Response<Unit>

Reports that a session is viewing an item.

sendFullGeneralCommand

suspend fun sendFullGeneralCommand(sessionId: String, data: GeneralCommand): Response<Unit>

Issues a full general command to a client.

sendGeneralCommand

suspend fun sendGeneralCommand(sessionId: String, command: GeneralCommandType): Response<Unit>

Issues a general command to a client.

sendMessageCommand

suspend fun sendMessageCommand(sessionId: String, data: MessageCommand): Response<Unit>

Issues a command to a client to display a message to the user.

sendPlaystateCommand

suspend fun sendPlaystateCommand(sessionId: String, command: PlaystateCommand, seekPositionTicks: Long? = null, controllingUserId: String? = null): Response<Unit>

Issues a playstate command to a client.

sendSystemCommand

suspend fun sendSystemCommand(sessionId: String, command: GeneralCommandType): Response<Unit>

Issues a system command to a client.