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: ERROR CLASS: Symbol not found for UUID): Response<Unit>

Adds an additional user to a session.

displayContent

suspend fun displayContent(sessionId: String, itemType: ERROR CLASS: Symbol not found for BaseItemKind, itemId: String, itemName: String): Response<Unit>

Instructs a session to browse to an item or view.

getAuthProviders

suspend fun getAuthProviders(): Response<List<ERROR CLASS: Symbol not found for NameIdPair>>

Get all auth providers.

getPasswordResetProviders

suspend fun getPasswordResetProviders(): Response<List<ERROR CLASS: Symbol not found for NameIdPair>>

Get all password reset providers.

getSessions

suspend fun getSessions(controllableByUserId: ERROR CLASS: Symbol not found for UUID?? = null, deviceId: String? = null, activeWithinSeconds: Int? = null): Response<List<ERROR CLASS: Symbol not found for SessionInfoDto>>

Gets a list of sessions.

play

suspend fun play(request: ERROR CLASS: Symbol not found for PlayRequest): Response<Unit>

suspend fun play(sessionId: String, playCommand: ERROR CLASS: Symbol not found for PlayCommand, itemIds: Collection<ERROR CLASS: Symbol not found for 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: ERROR CLASS: Symbol not found for PostCapabilitiesRequest = PostCapabilitiesRequest()): Response<Unit>

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

Updates capabilities for a device.

postFullCapabilities

suspend fun postFullCapabilities(id: String? = null, data: ERROR CLASS: Symbol not found for ClientCapabilitiesDto): Response<Unit>

Updates capabilities for a device.

removeUserFromSession

suspend fun removeUserFromSession(sessionId: String, userId: ERROR CLASS: Symbol not found for UUID): Response<Unit>

Removes an additional user from 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: ERROR CLASS: Symbol not found for GeneralCommand): Response<Unit>

Issues a full general command to a client.

sendGeneralCommand

suspend fun sendGeneralCommand(sessionId: String, command: ERROR CLASS: Symbol not found for GeneralCommandType): Response<Unit>

Issues a general command to a client.

sendMessageCommand

suspend fun sendMessageCommand(sessionId: String, data: ERROR CLASS: Symbol not found for MessageCommand): Response<Unit>

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

sendPlaystateCommand

suspend fun sendPlaystateCommand(sessionId: String, command: ERROR CLASS: Symbol not found for PlaystateCommand, seekPositionTicks: Long? = null, controllingUserId: String? = null): Response<Unit>

Issues a playstate command to a client.

sendSystemCommand

suspend fun sendSystemCommand(sessionId: String, command: ERROR CLASS: Symbol not found for GeneralCommandType): Response<Unit>

Issues a system command to a client.