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

LibraryApi

class LibraryApi(api: ApiClient) : Api

Constructors

Link copied to clipboard
constructor(api: ApiClient)

Functions

Link copied to clipboard
suspend fun deleteItem(itemId: ERROR CLASS: Symbol not found for UUID): Response<Unit>

Deletes an item from the library and filesystem.

Link copied to clipboard
suspend fun deleteItems(ids: Collection<ERROR CLASS: Symbol not found for UUID>? = emptyList()): Response<Unit>

Deletes items from the library and filesystem.

Link copied to clipboard
suspend fun getAncestors(itemId: ERROR CLASS: Symbol not found for UUID, userId: ERROR CLASS: Symbol not found for UUID?? = null): Response<List<ERROR CLASS: Symbol not found for BaseItemDto>>

Gets all parents of an item.

Link copied to clipboard
suspend fun getCriticReviews(itemId: String): Response<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>

Gets critic review for an item.

Link copied to clipboard
suspend fun getDownload(itemId: ERROR CLASS: Symbol not found for UUID): Response<ByteArray>

Downloads item media.

Link copied to clipboard
fun getDownloadUrl(itemId: ERROR CLASS: Symbol not found for UUID): String

Downloads item media.

Link copied to clipboard
suspend fun getFile(itemId: ERROR CLASS: Symbol not found for UUID): Response<ByteArray>

Get the original file of an item.

Link copied to clipboard
fun getFileUrl(itemId: ERROR CLASS: Symbol not found for UUID): String

Get the original file of an item.

Link copied to clipboard
suspend fun getItemCounts(userId: ERROR CLASS: Symbol not found for UUID?? = null, isFavorite: Boolean? = null): Response<ERROR CLASS: Symbol not found for ItemCounts>

Get item counts.

Link copied to clipboard
suspend fun getLibraryOptionsInfo(libraryContentType: ERROR CLASS: Symbol not found for CollectionType?? = null, isNewLibrary: Boolean? = false): Response<ERROR CLASS: Symbol not found for LibraryOptionsResultDto>

Gets the library options info.

Link copied to clipboard
suspend fun getMediaFolders(isHidden: Boolean? = null): Response<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>

Gets all user media folders.

Link copied to clipboard
suspend fun getPhysicalPaths(): Response<List<String>>

Gets a list of physical paths from virtual folders.

Link copied to clipboard
suspend fun getSimilarAlbums(request: ERROR CLASS: Symbol not found for GetSimilarAlbumsRequest): Response<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>
suspend fun getSimilarAlbums(itemId: ERROR CLASS: Symbol not found for UUID, excludeArtistIds: Collection<ERROR CLASS: Symbol not found for UUID>? = emptyList(), userId: ERROR CLASS: Symbol not found for UUID?? = null, limit: Int? = null, fields: Collection<ERROR CLASS: Symbol not found for ItemFields>? = emptyList()): Response<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>

Gets similar items.

Link copied to clipboard
suspend fun getSimilarArtists(request: ERROR CLASS: Symbol not found for GetSimilarArtistsRequest): Response<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>
suspend fun getSimilarArtists(itemId: ERROR CLASS: Symbol not found for UUID, excludeArtistIds: Collection<ERROR CLASS: Symbol not found for UUID>? = emptyList(), userId: ERROR CLASS: Symbol not found for UUID?? = null, limit: Int? = null, fields: Collection<ERROR CLASS: Symbol not found for ItemFields>? = emptyList()): Response<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>

Gets similar items.

Link copied to clipboard
suspend fun getSimilarItems(request: ERROR CLASS: Symbol not found for GetSimilarItemsRequest): Response<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>
suspend fun getSimilarItems(itemId: ERROR CLASS: Symbol not found for UUID, excludeArtistIds: Collection<ERROR CLASS: Symbol not found for UUID>? = emptyList(), userId: ERROR CLASS: Symbol not found for UUID?? = null, limit: Int? = null, fields: Collection<ERROR CLASS: Symbol not found for ItemFields>? = emptyList()): Response<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>

Gets similar items.

Link copied to clipboard
suspend fun getSimilarMovies(request: ERROR CLASS: Symbol not found for GetSimilarMoviesRequest): Response<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>
suspend fun getSimilarMovies(itemId: ERROR CLASS: Symbol not found for UUID, excludeArtistIds: Collection<ERROR CLASS: Symbol not found for UUID>? = emptyList(), userId: ERROR CLASS: Symbol not found for UUID?? = null, limit: Int? = null, fields: Collection<ERROR CLASS: Symbol not found for ItemFields>? = emptyList()): Response<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>

Gets similar items.

Link copied to clipboard
suspend fun getSimilarShows(request: ERROR CLASS: Symbol not found for GetSimilarShowsRequest): Response<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>
suspend fun getSimilarShows(itemId: ERROR CLASS: Symbol not found for UUID, excludeArtistIds: Collection<ERROR CLASS: Symbol not found for UUID>? = emptyList(), userId: ERROR CLASS: Symbol not found for UUID?? = null, limit: Int? = null, fields: Collection<ERROR CLASS: Symbol not found for ItemFields>? = emptyList()): Response<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>

Gets similar items.

Link copied to clipboard
suspend fun getSimilarTrailers(request: ERROR CLASS: Symbol not found for GetSimilarTrailersRequest): Response<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>
suspend fun getSimilarTrailers(itemId: ERROR CLASS: Symbol not found for UUID, excludeArtistIds: Collection<ERROR CLASS: Symbol not found for UUID>? = emptyList(), userId: ERROR CLASS: Symbol not found for UUID?? = null, limit: Int? = null, fields: Collection<ERROR CLASS: Symbol not found for ItemFields>? = emptyList()): Response<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>

Gets similar items.

Link copied to clipboard
suspend fun getThemeMedia(request: ERROR CLASS: Symbol not found for GetThemeMediaRequest): Response<ERROR CLASS: Symbol not found for AllThemeMediaResult>
suspend fun getThemeMedia(itemId: ERROR CLASS: Symbol not found for UUID, userId: ERROR CLASS: Symbol not found for UUID?? = null, inheritFromParent: Boolean? = false, sortBy: Collection<ERROR CLASS: Symbol not found for ItemSortBy>? = emptyList(), sortOrder: Collection<ERROR CLASS: Symbol not found for SortOrder>? = emptyList()): Response<ERROR CLASS: Symbol not found for AllThemeMediaResult>

Get theme songs and videos for an item.

Link copied to clipboard
suspend fun getThemeSongs(request: ERROR CLASS: Symbol not found for GetThemeSongsRequest): Response<ERROR CLASS: Symbol not found for ThemeMediaResult>
suspend fun getThemeSongs(itemId: ERROR CLASS: Symbol not found for UUID, userId: ERROR CLASS: Symbol not found for UUID?? = null, inheritFromParent: Boolean? = false, sortBy: Collection<ERROR CLASS: Symbol not found for ItemSortBy>? = emptyList(), sortOrder: Collection<ERROR CLASS: Symbol not found for SortOrder>? = emptyList()): Response<ERROR CLASS: Symbol not found for ThemeMediaResult>

Get theme songs for an item.

Link copied to clipboard
suspend fun getThemeVideos(request: ERROR CLASS: Symbol not found for GetThemeVideosRequest): Response<ERROR CLASS: Symbol not found for ThemeMediaResult>
suspend fun getThemeVideos(itemId: ERROR CLASS: Symbol not found for UUID, userId: ERROR CLASS: Symbol not found for UUID?? = null, inheritFromParent: Boolean? = false, sortBy: Collection<ERROR CLASS: Symbol not found for ItemSortBy>? = emptyList(), sortOrder: Collection<ERROR CLASS: Symbol not found for SortOrder>? = emptyList()): Response<ERROR CLASS: Symbol not found for ThemeMediaResult>

Get theme videos for an item.

Link copied to clipboard
suspend fun postAddedMovies(tmdbId: String? = null, imdbId: String? = null): Response<Unit>

Reports that new movies have been added by an external source.

Link copied to clipboard
suspend fun postAddedSeries(tvdbId: String? = null): Response<Unit>

Reports that new episodes of a series have been added by an external source.

Link copied to clipboard
suspend fun postUpdatedMedia(data: ERROR CLASS: Symbol not found for MediaUpdateInfoDto): Response<Unit>

Reports that new movies have been added by an external source.

Link copied to clipboard
suspend fun postUpdatedMovies(tmdbId: String? = null, imdbId: String? = null): Response<Unit>

Reports that new movies have been added by an external source.

Link copied to clipboard
suspend fun postUpdatedSeries(tvdbId: String? = null): Response<Unit>

Reports that new episodes of a series have been added by an external source.

Link copied to clipboard
suspend fun refreshLibrary(): Response<Unit>

Starts a library scan.

Generated by Dokka
© 2026 Copyright