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

LibraryApi

class LibraryApi(api: ApiClient) : Api

Constructors

LibraryApi

constructor(api: ApiClient)

Functions

deleteItem

suspend fun deleteItem(itemId: UUID): Response<Unit>

Deletes an item from the library and filesystem.

deleteItems

suspend fun deleteItems(ids: Collection<UUID>? = emptyList()): Response<Unit>

Deletes items from the library and filesystem.

getAncestors

suspend fun getAncestors(itemId: UUID, userId: UUID? = null): Response<List<BaseItemDto>>

Gets all parents of an item.

getCriticReviews

suspend fun ~~getCriticReviews~~(itemId: String): Response<BaseItemDtoQueryResult>

Gets critic review for an item.

getDownload

suspend fun getDownload(itemId: UUID): Response<ByteArray>

Downloads item media.

getDownloadUrl

fun getDownloadUrl(itemId: UUID): String

Downloads item media.

getFile

suspend fun getFile(itemId: UUID): Response<ByteArray>

Get the original file of an item.

getFileUrl

fun getFileUrl(itemId: UUID): String

Get the original file of an item.

getItemCounts

suspend fun getItemCounts(userId: UUID? = null, isFavorite: Boolean? = null): Response<ItemCounts>

Get item counts.

getLibraryOptionsInfo

suspend fun getLibraryOptionsInfo(libraryContentType: CollectionType? = null, isNewLibrary: Boolean? = false): Response<LibraryOptionsResultDto>

Gets the library options info.

getMediaFolders

suspend fun getMediaFolders(isHidden: Boolean? = null): Response<BaseItemDtoQueryResult>

Gets all user media folders.

getPhysicalPaths

suspend fun getPhysicalPaths(): Response<List<String>>

Gets a list of physical paths from virtual folders.

getSimilarAlbums

suspend fun getSimilarAlbums(request: GetSimilarAlbumsRequest): Response<BaseItemDtoQueryResult>

suspend fun getSimilarAlbums(itemId: UUID, excludeArtistIds: Collection<UUID>? = emptyList(), userId: UUID? = null, limit: Int? = null, fields: Collection<ItemFields>? = emptyList()): Response<BaseItemDtoQueryResult>

Gets similar items.

getSimilarArtists

suspend fun getSimilarArtists(request: GetSimilarArtistsRequest): Response<BaseItemDtoQueryResult>

suspend fun getSimilarArtists(itemId: UUID, excludeArtistIds: Collection<UUID>? = emptyList(), userId: UUID? = null, limit: Int? = null, fields: Collection<ItemFields>? = emptyList()): Response<BaseItemDtoQueryResult>

Gets similar items.

suspend fun getSimilarItems(itemId: UUID, excludeArtistIds: Collection<UUID>? = emptyList(), userId: UUID? = null, limit: Int? = null, fields: Collection<ItemFields>? = emptyList()): Response<BaseItemDtoQueryResult>

Gets similar items.

getSimilarMovies

suspend fun getSimilarMovies(request: GetSimilarMoviesRequest): Response<BaseItemDtoQueryResult>

suspend fun getSimilarMovies(itemId: UUID, excludeArtistIds: Collection<UUID>? = emptyList(), userId: UUID? = null, limit: Int? = null, fields: Collection<ItemFields>? = emptyList()): Response<BaseItemDtoQueryResult>

Gets similar items.

suspend fun getSimilarShows(itemId: UUID, excludeArtistIds: Collection<UUID>? = emptyList(), userId: UUID? = null, limit: Int? = null, fields: Collection<ItemFields>? = emptyList()): Response<BaseItemDtoQueryResult>

Gets similar items.

getSimilarTrailers

suspend fun getSimilarTrailers(request: GetSimilarTrailersRequest): Response<BaseItemDtoQueryResult>

suspend fun getSimilarTrailers(itemId: UUID, excludeArtistIds: Collection<UUID>? = emptyList(), userId: UUID? = null, limit: Int? = null, fields: Collection<ItemFields>? = emptyList()): Response<BaseItemDtoQueryResult>

Gets similar items.

getThemeMedia

suspend fun getThemeMedia(request: GetThemeMediaRequest): Response<AllThemeMediaResult>

suspend fun getThemeMedia(itemId: UUID, userId: UUID? = null, inheritFromParent: Boolean? = false, sortBy: Collection<ItemSortBy>? = emptyList(), sortOrder: Collection<SortOrder>? = emptyList()): Response<AllThemeMediaResult>

Get theme songs and videos for an item.

getThemeSongs

suspend fun getThemeSongs(request: GetThemeSongsRequest): Response<ThemeMediaResult>

suspend fun getThemeSongs(itemId: UUID, userId: UUID? = null, inheritFromParent: Boolean? = false, sortBy: Collection<ItemSortBy>? = emptyList(), sortOrder: Collection<SortOrder>? = emptyList()): Response<ThemeMediaResult>

Get theme songs for an item.

getThemeVideos

suspend fun getThemeVideos(request: GetThemeVideosRequest): Response<ThemeMediaResult>

suspend fun getThemeVideos(itemId: UUID, userId: UUID? = null, inheritFromParent: Boolean? = false, sortBy: Collection<ItemSortBy>? = emptyList(), sortOrder: Collection<SortOrder>? = emptyList()): Response<ThemeMediaResult>

Get theme videos for an item.

postAddedMovies

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

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

postAddedSeries

suspend fun postAddedSeries(tvdbId: String? = null): Response<Unit>

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

postUpdatedMedia

suspend fun postUpdatedMedia(data: MediaUpdateInfoDto): Response<Unit>

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

postUpdatedMovies

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

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

postUpdatedSeries

suspend fun postUpdatedSeries(tvdbId: String? = null): Response<Unit>

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

refreshLibrary

suspend fun refreshLibrary(): Response<Unit>

Starts a library scan.